xtr.duration¶

The duration module leverages the ISO-8601 duration format.

of¶

of(parts: Object[Number]): String

Returns the ISO-8601 duration of the given parts, an Object of the form:

{
    years: Number, months: Number, days: Number,
    hours: Number, minutes: Number, seconds: Number
}

where all elements are optional.

Example

local parts = {
    years: 20, months: 3, days: 1,
    hours: 12, minutes: 30, seconds: 45
};

xtr.duration.of(parts)

Result

'P20Y3M1DT12H30M45S'

toParts(duration: String): Object[Number]

Returns the constituent parts of the given duration, as an Object of the form:

{
    years: Number, months: Number, days: Number,
    hours: Number, minutes: Number, seconds: Number
}

Example

xtr.duration.toParts('P20Y3M1DT12H30M45S')

Result

{
    years: 20, months: 3, days: 1,
    hours: 12, minutes: 30, seconds: 45
}