Duration

Ƭ Duration: Format["P(n)Y(n)M(n)DT(n)H(n)M(n)S"] & string

A Iso.Duration represents a duration of time which can be used in date/time arithmetic.

Iso.Duration can be constructed directly or returned from durationFns.from(). It can also be obtained from the since() function of any other Iso type that supports arithmetic, and is used in those types' add() and subtract() functions.

An Iso.Duration is a string according to the ISO 8601 notation for durations. The examples in this page use this notation extensively.

Briefly, the ISO 8601 notation consists of a P character, followed by years, months, weeks, and days, followed by a T character, followed by hours, minutes, and seconds with a decimal part, each with a single-letter suffix that indicates the unit. Any zero components may be omitted. For more detailed information, see the ISO 8601 standard or the Wikipedia page.

ISO 8601	Meaning
P1Y1M1DT1H1M1.1S	One year, one month, one day, one hour, one minute, one second, and 100 milliseconds
P40D	Forty days
P1Y1D	A year and a day
P3DT4H59M	Three days, four hours and 59 minutes
PT2H30M	Two and a half hours
P1M	One month
PT1M	One minute
PT0.021S	21 milliseconds
PT0S	Zero
P0D	Zero

note

According to the ISO 8601-1 standard, weeks are not allowed to appear together with any other units, and durations can only be positive. As extensions to the standard, ISO 8601-2 allows a sign character at the start of the string, and allows combining weeks with other units. If you intend to use a string such as P3W1D, +P1M, or -P1M for interoperability, note that other programs may not accept it.

Defined in

iso-types.ts:141

fromNumbers

▸ fromNumbers(years?, months?, weeks?, days?, hours?, minute?, seconds?, milliseconds?): Duration

Parameters

Name	Type
years?	number
months?	number
weeks?	number
days?	number
hours?	number
minute?	number
seconds?	number
milliseconds?	number

Returns

Duration

Defined in

types/IDurationFns.ts:5

---

isValid

▸ isValid(duration): duration is Duration

Parameters

Name	Type
duration	unknown

Returns

duration is Duration

Defined in

types/IDurationFns.ts:15

---

assertIsValid

▸ assertIsValid(duration): asserts duration is Duration

Parameters

Name	Type
duration	unknown

Returns

asserts duration is Duration

Defined in

types/IDurationFns.ts:16

---

getYears

▸ getYears(duration): number

Parameters

Name	Type
duration	Duration

Returns

number

Defined in

types/IDurationFns.ts:17

---

getMonths

▸ getMonths(duration): number

Parameters

Name	Type
duration	Duration

Returns

number

Defined in

types/IDurationFns.ts:18

---

getWeeks

▸ getWeeks(duration): number

Parameters

Name	Type
duration	Duration

Returns

number

Defined in

types/IDurationFns.ts:19

---

getDays

▸ getDays(duration): number

Parameters

Name	Type
duration	Duration

Returns

number

Defined in

types/IDurationFns.ts:20

---

getHours

▸ getHours(duration): number

Parameters

Name	Type
duration	Duration

Returns

number

Defined in

types/IDurationFns.ts:21

---

getMinutes

▸ getMinutes(duration): number

Parameters

Name	Type
duration	Duration

Returns

number

Defined in

types/IDurationFns.ts:22

---

getSeconds

▸ getSeconds(duration): number

Parameters

Name	Type
duration	Duration

Returns

number

Defined in

types/IDurationFns.ts:23

---

getMilliseconds

▸ getMilliseconds(duration): number

Parameters

Name	Type
duration	Duration

Returns

number

Defined in

types/IDurationFns.ts:24

---

getSign

▸ getSign(duration): number

Parameters

Name	Type
duration	Duration

Returns

number

Defined in

types/IDurationFns.ts:25

---

isBlank

▸ isBlank(duration): boolean

Parameters

Name	Type
duration	Duration

Returns

boolean

Defined in

types/IDurationFns.ts:26

---

with

▸ with(duration, durationLike): Duration

Parameters

Name	Type
duration	Duration
durationLike	Object
durationLike.years?	number
durationLike.months?	number
durationLike.weeks?	number
durationLike.days?	number
durationLike.hours?	number
durationLike.minutes?	number
durationLike.seconds?	number
durationLike.milliseconds?	number

Returns

Duration

Defined in

types/IDurationFns.ts:27

---

negated

▸ negated(duration): Duration

Parameters

Name	Type
duration	Duration

Returns

Duration

Defined in

types/IDurationFns.ts:40

---

abs

▸ abs(duration): Duration

Parameters

Name	Type
duration	Duration

Returns

Duration

Defined in

types/IDurationFns.ts:41

---

add

▸ add(duration, other, options?): Duration

Parameters

Name	Type
duration	Duration
other	Duration | { years?: number ; months?: number ; weeks?: number ; days?: number ; hours?: number ; minutes?: number ; seconds?: number ; milliseconds?: number }
options?	Object
options.relativeTo	DateTime | ZonedDateTime

Returns

Duration

Defined in

types/IDurationFns.ts:42

---

subtract

▸ subtract(duration, other, options?): Duration

Parameters

Name	Type
duration	Duration
other	Duration | { years?: number ; months?: number ; weeks?: number ; days?: number ; hours?: number ; minutes?: number ; seconds?: number ; milliseconds?: number }
options?	Object
options.relativeTo	Date | DateTime | ZonedDateTime

Returns

Duration

Defined in

types/IDurationFns.ts:58

---

round

▸ round(duration, options): Duration

Parameters

Name	Type
duration	Duration
options	Object
options.largestUnit?	TemporalSingularUnit | TemporalPluralUnit | "auto"
options.smallestUnit?	TemporalSingularUnit | TemporalPluralUnit
options.roundingIncrement?	number
options.roundingMode?	TemporalRoundingMode
options.relativeTo?	Date | DateTime | ZonedDateTime

Returns

Duration

Defined in

types/IDurationFns.ts:74

---

total

▸ total(duration, options): number

Parameters

Name	Type
duration	Duration
options	Object
options.unit	TemporalSingularUnit | TemporalPluralUnit
options.relativeTo?	Date | DateTime | ZonedDateTime

Returns

number

Defined in

types/IDurationFns.ts:84

---

getFields

▸ getFields(duration): DurationSlots

Parameters

Name	Type
duration	Duration

Returns

DurationSlots

Defined in

types/IDurationFns.ts:91

---

from

▸ from(item): Duration

Parameters

Name	Type
item	any

Returns

Duration

Defined in

types/IDurationFns.ts:92

---

compare

▸ compare(one, two, options?): number

Parameters

Name	Type
one	Duration
two	Duration
options?	Object
options.relativeTo	Date | DateTime | ZonedDateTime

Returns

number

Defined in

types/IDurationFns.ts:93

---

chain

▸ chain(duration): IDurationChain

Parameters

Name	Type
duration	Duration

Returns

IDurationChain

Defined in

types/IDurationFns.ts:98