duration filter

Converting a Duration Number/String to a Moment.js duration object

You can convert a duration number/string to a Moment.js duration object using the duration method of the Moment.js library. For example: 

3 | duration("minutes") returns a Moment.js duration object.

When rendered in a {{...}} block, a Moment.js duration object is output as a string representing the specified duration in milliseconds.

{{ 3 | duration("minutes") }} outputs 180000

{{ "2:30:00" | duration }} outputs 9000000{days:2,hours:12} | duration

Converting a Moment.js duration object to a humanized string

You can convert a Moment.js duration object to a string representing a duration using the duration("humanize") filter. For example: 

{{ 3 | duration("minutes") | duration("humanize") }} returns the current date/time as an ISO 8601-compliant string such as 2018-02-14T00:00:00Z.

To format a Moment.js date object to a more human-readable string, use the date(format) form of the filter.

Duration calculations

You might want to manipulate a duration before setting it to a field. For example, you might want to set the Original estimate to the difference of the Created and Due date. Below are some methods to help with these manipulations.

add

Description:

Adds time to a Momentjs duration.

Syntax:

{{ durationObject | duration('add' , amount [, unit ] ) }}

Parameters:

Examples:

777600000

subtract

Description:

Subtracts time from a Momentjs duration.

Syntax:

{{ durationObject | duration('subtract' , amount [, unit ] ) }}

Parameters:

Examples:

-259200000

get

Description:

Returns a part of the Moment.js duration (milliseconds, seconds, minutes, ...)

Syntax:

{{ durationObject | duration([unit]) }}

Parameters:

Examples:

as

Description:

Converts a Moment.js duration into a number of milliseconds, or seconds, or minutes, ...

Syntax:

{{ durationObject | duration([unit]) }}

Parameters:

Examples:

Duration formatting

You might want to display a duration in a specific format after or before manipulating it. Momentjs provides some methods to display a duration in different formats. 

humanize

Description:

Formats a Moment.js duration object into a user-friendly string. To format it in a specific locale (language), use theduration("locale") filter first. It applies to aMoment.js durationobject, as returned by theduration([unit]) filter.

Syntax:

{{ durationObject | duration("humanize" [,relative]) }}

Parameters:

Examples:

List of tokens:

If you would like to add strings in format strings, you need to wrap the characters in square brackets. For example: {{ now | date ('[The issue was resolved on] Do MMMM YYYY dddd') }} will display, The issue was resolved on 14th October 2016 Friday.

tz

Description:

You can parse and display dates in any timezone. By default this method will print the date in the timezone of the current user (the user running the transition). See here for all the available functions.

The list of possible time zones is available here.

Syntax:

{{ DATE | date('tz') }}

Examples:

2017-07-21T06:26:46+02:00

2017 June 05

fromNow

Description:

fromNow() method can be used to display the time from now.

Syntax:

{{ DATE | date('fromNow') }}

Examples: If Due date is 24/Nov/16 and Created is 13/10/16

You can remove the suffix 'ago' by passing true to the method. For example: {{ issue.fields.duedate | date('fromNow' , true) }} will display: a month

The string displayed for each length of time is listed below: 

from x

Description:

from() method can be used to display the time from x (time other than now).

Syntax:

{{ DATE | date('from' , 'x') }}

Examples:

If you want to find the time from the Due date to the Created date:

{% set due = issue.fields.duedate %}
{% set cre = issue.fields.created %}
{{ due | date('from' , cre) }}

You can remove the suffix 'month' by passing true to the method: {{ due | date('from' , cre , true) }} will display: a month.

toNow

Description:

toNow() method can be used to display the time to now.

Syntax:

{{ DATE | date('toNow') }}

Examples:

If the Due date is 24/Nov/16, {{ issue.fields.duedate | date('fromNow') }} will display: a month ago

If the issue created date is 13/10/16, {{ issue.fields.created | date('fromNow') }} will display: in a day

The string displayed for each length of time is listed below: 

to x

Description:

to() method can be used to display the time to x (time other than now).

Syntax:

{{ DATE | date('to' , 'x') }}

Examples:

{% set due = issue.fields.duedate %}
{% set cre = issue.fields.created %}
{{ cre | date('to' , due) }}

The string displayed for each length of time is listed below: 

You can remove the suffix 'in' by passing true to the method: {{ cre | date('to' , due) }} will display: a month.