Class TimeQuantity

This class provides a simple means for storing and calculating time quantities.

Hierarchy

TimeQuantity

Index

Constructors

Properties

_quantity _total

Accessors

direction total

Methods

compareTo equals getTotal getTotalMilliseconds getTotalMillisecondsFrom

Constructors

constructor

new TimeQuantity(_quantity?: number): TimeQuantity
Parameters
- _quantity: number = 0
Returns TimeQuantity
- Defined in TimeQuantity.ts:19

Properties

`Protected` _quantity

_quantity: number = 0

`Protected` _total

_total: default<Readonly<TimeMeasurement>>

Accessors

direction

get direction(): number
+1, 0, or -1 depending on the time direction.

Returns

Returns number
- Defined in TimeQuantity.ts:55

total

get total(): Readonly<TimeMeasurement>
Returns an object with all units exposed as totals.

Returns

Returns Readonly<TimeMeasurement>
- Defined in TimeQuantity.ts:66

Methods

compareTo

compareTo(other: TimeQuantity): number
Compares this instance against any other time quantity instance.

Returns
Parameters
- other: TimeQuantity
Returns number
- Defined in TimeQuantity.ts:93

equals

equals(other: TimeQuantity): boolean
Compares this instance against any other time quantity instance and return true if the amount of time is the same.

Returns
Parameters
- other: TimeQuantity
Returns boolean
- Defined in TimeQuantity.ts:82

getTotal

getTotal(units: UnitType): number
Returns the total amount of time measured in the requested TimeUnit.

Returns
Parameters
- units: UnitType
Returns number
- Defined in TimeQuantity.ts:105

getTotalMilliseconds

getTotalMilliseconds(): number
Returns number
- Defined in TimeQuantity.ts:72

`Static` getTotalMillisecondsFrom

getTotalMillisecondsFrom(values: Partial<TimeMeasurement>): number
Combine total values by time unit.

Returns
Parameters
- values: Partial<TimeMeasurement>
Returns number
- Defined in TimeQuantity.ts:40

Generated using TypeDoc