Class Duration

Hierarchy

Duration

Index

Constructors

Methods

isDuration of parse in as asValues asTotals greaterThan lessThan

Constructors

constructor

new Duration(params): Duration
Construct a new duration from a parameter object representing the duration unit values.
Parameters
- params: Partial<DurationValues>
  See DurationValues type for valid fields. All fields optional.
Returns Duration
- Defined in duration.ts:21

Methods

`Static` isDuration

isDuration(ob): ob is Duration
Parameters
- ob: any
Returns ob is Duration
- Defined in duration.ts:28

`Static` of

of(count, unit): Duration
Return a Duration constructed from the provided count and DurationUnit
Parameters
- count: number
  The number of units the duration should represent
- unit: keyof DurationValues
  The time unit to create this duration from e.g. 'days' | 'hours' | 'minutes' | 'seconds' | 'milliseconds'
Returns Duration
A new Duration
- Defined in duration.ts:44

`Static` parse

parse(parseable): Duration
Return a Duration parsed from a space separated string in the format "{{count}} {{unit}}" e.g. 30 seconds, 5 minutes, 2 days
Parameters
- parseable: string
  The string to parse
Returns Duration
A new Duration
- Defined in duration.ts:66

in

in(unit): number
Return the duration value converted to the target unit
Parameters
- unit: keyof DurationValues
  The target duration unit
Returns number
The numerical value of this duration in the specified unit
- Defined in duration.ts:87

as

as(unit): number
Converts this duration to an integer of the target unit. Remainder values will be truncated.
Parameters
- unit: keyof DurationValues
  The target duration unit
Returns number
The truncated integer value of the duration converted to the target unit
- Defined in duration.ts:108

asValues

asValues(): DurationValues
Represents this duration as a values object where the length of the duration is distributed across the various units from largest to smallest

Returns DurationValues
DurationValues
- Defined in duration.ts:116

asTotals

asTotals(): Readonly<DurationValues>
Represents this duration as a values object where each value represents the total integer size of the duration expressed as that unit.

Returns Readonly<DurationValues>
DurationTotals
- Defined in duration.ts:131

greaterThan

greaterThan(other, orEqual?): boolean
Parameters
- other: Duration
  Duration
- Optional orEqual: boolean
  optional
Returns boolean
boolean
- Defined in duration.ts:146

lessThan

lessThan(other, orEqual?): boolean
Parameters
- other: Duration
  Duration
- Optional orEqual: boolean
  optional
Returns boolean
boolean
- Defined in duration.ts:158

Generated using TypeDoc