Duration functions

These functions can be used when converting between numeric and duration data.

duration::days

The duration::days function counts how many days fit into a duration.

API DEFINITION
duration::days(duration) -> number

The following example shows this function, and its output, when used in a RETURN statement:

RETURN duration::days(3w);

21

duration::hours

The duration::hours function counts how many hours fit into a duration.

API DEFINITION
duration::hours(duration) -> number

The following example shows this function, and its output, when used in a RETURN statement:

RETURN duration::hours(3w);

504

duration::micros

The duration::micros function counts how many microseconds fit into a duration.

API DEFINITION
duration::micros(duration) -> number

The following example shows this function, and its output, when used in a RETURN statement:

RETURN duration::micros(3w);

1814400000000

duration::millis

The duration::millis function counts how many milliseconds fit into a duration.

API DEFINITION
duration::millis(duration) -> number

The following example shows this function, and its output, when used in a RETURN statement:

RETURN duration::millis(3w);

1814400000

duration::mins

The duration::mins function counts how many minutes fit into a duration.

API DEFINITION
duration::mins(duration) -> number

The following example shows this function, and its output, when used in a RETURN statement:

RETURN duration::mins(3w);

30240

duration::nanos

The duration::nanos function counts how many nanoseconds fit into a duration.

API DEFINITION
duration::nanos(duration) -> number

The following example shows this function, and its output, when used in a RETURN statement:

RETURN duration::nanos(3w);

1814400000000000

duration::secs

The duration::secs function counts how many seconds fit into a duration.

API DEFINITION
duration::secs(duration) -> number

The following example shows this function, and its output, when used in a RETURN statement:

RETURN duration::secs(3w);

1814400

duration::weeks

The duration::weeks function counts how many weeks fit into a duration.

API DEFINITION
duration::weeks(duration) -> number

The following example shows this function, and its output, when used in a RETURN statement:

RETURN duration::weeks(3w);

3

duration::years

The duration::years function counts how many years fit into a duration.

API DEFINITION
duration::years(duration) -> number

The following example shows this function, and its output, when used in a RETURN statement:

RETURN duration::years(300w);

5

duration::from::days

The duration::from::days function counts how many years fit into a duration.

API DEFINITION
duration::from::days(number) -> duration

The following example shows this function, and its output, when used in a RETURN statement:

RETURN duration::from::days(3);

3d

duration::from::hours

The duration::from::hours function converts a numeric amount of hours into a duration that represents hours.

API DEFINITION
duration::from::hours(number) -> duration

The following example shows this function, and its output, when used in a RETURN statement:

RETURN duration::from::hours(3);

3h

duration::from::micros

The duration::from::micros function converts a numeric amount of microseconds into a duration that represents microseconds.

API DEFINITION
duration::from::micros(number) -> duration

The following example shows this function, and its output, when used in a RETURN statement:

RETURN duration::from::micros(3);

3μs

duration::from::millis

The duration::from::millis function converts a numeric amount of milliseconds into a duration that represents milliseconds.

API DEFINITION
duration::from::millis(number) -> duration

The following example shows this function, and its output, when used in a RETURN statement:

RETURN duration::from::millis(3);

3ms

duration::from::mins

The duration::from::mins function converts a numeric amount of minutes into a duration that represents minutes.

API DEFINITION
duration::from::mins(number) -> duration

The following example shows this function, and its output, when used in a RETURN statement:

RETURN duration::from::mins(3);

3m

duration::from::nanos

The duration::from::nanos function converts a numeric amount of nanoseconds into a duration that represents nanoseconds.

API DEFINITION
duration::from::nanos(number) -> duration

The following example shows this function, and its output, when used in a RETURN statement:

RETURN duration::from::nanos(3);

3ns

duration::from::secs

The duration::from::secs function converts a numeric amount of seconds into a duration that represents seconds.

API DEFINITION
duration::from::secs(number) -> duration

The following example shows this function, and its output, when used in a RETURN statement:

RETURN duration::from::secs(3);

3s

duration::from::weeks

The duration::from::weeks function converts a numeric amount of weeks into a duration that represents weeks.

API DEFINITION
duration::from::weeks(number) -> duration

The following example shows this function, and its output, when used in a RETURN statement:

RETURN duration::from::weeks(3);

3w

Method chaining

Available since: v2.0.0

Method chaining allows functions to be called using the . dot operator on a value of a certain type instead of the full path of the function followed by the value.

-- Traditional syntax
duration::mins(2d6h);

-- Method chaining syntax
2d6h.mins();

Response
3240

This is particularly useful for readability when a function is called multiple times.

-- Traditional syntax
duration::mins(duration::from::millis(98734234));

-- Method chaining syntax
duration::from::millis(98734234).mins();

Response
1645