Packages > pkl > pkl.base

Duration0.27.0

Properties
Methods

external class Duration extends Any

A quantity of elapsed time, represented as a value (e.g. 30.5) and unit (e.g. min).

Known subtypes:
Known usages:
All versions:

Properties

link
value: Number

The value of this duration.
Returns Int if possible and Float otherwise.

Facts:
```
1.min.value == 1
2.2.h.value == 2.2
```
link
isoString: String(matches(Regex(#"-?PT(\d+H)?(\d+M)?(\d+([.]\d+)?S)?"#)))

An ISO 8601 representation of this duration.
The ISO representation has the format [-]PT{hours}H{minutes}M{seconds}S, where
- negative durations have a leading minus sign,
- {hours} and {minutes} are positive integers,
- {seconds} is a positive integer or a positive decimal with decimal point (.),
- zero-valued components are omitted, and
- durations with length zero are represented as PT0S.
Facts:
```
1.5.h.isoString == "PT1H30M"
-1.5.h.isoString == "-PT1H30M"
1.23.s.isoString == "PT1.23S"
0.ms.isoString == "PT0S"
```
link
unit: DurationUnit

The unit of this duration.
Facts:
```
1.min.unit == "min"
2.2.h.unit == "h"
```
link
isPositive: Boolean

Tells if this duration has a value of zero or greater.
Facts:
```
2.min.isPositive
!(-2.min.isPositive)
```

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)

Returns the class of this.
link

function

Any.toString(): String (pkl.base)

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function
isBetween(start: Duration, inclusiveEnd: Duration): Boolean

Tells if this duration is greater than or equal to start and less than or equal to inclusiveEnd.
Facts:
```
3.min.isBetween(120.s, 4.min)
3.min.isBetween(180.s, 4.min)
3.min.isBetween(120.s, 3.min)
!3.min.isBetween(1.min, 2.min)
```
link

function
toUnit(unit: DurationUnit): Duration

Returns the equivalent duration with the given unit.
Facts:
```
60.min.toUnit("h") == 1.h
1.h.toUnit("min") == 60.min
```