Class ClockTime

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

Hierarchy (View Summary)

TimeQuantity
- ClockTime

Implements

Required<ClockTimeValue>

Index

Constructors

Properties

_quantity _total day hour millisecond minute second tick

Accessors

direction total

Methods

compareTo equals getTotal getTotalMilliseconds toString from getTotalMillisecondsFrom millisecondsFromTime

Constructors

constructor

new ClockTime(milliseconds: number): ClockTime
Parameters
- milliseconds: number
Returns ClockTime
Overrides TimeQuantity.constructor
- Defined in ClockTime.ts:23
new ClockTime(
    hours: number,
    minutes: number,
    seconds?: number,
    milliseconds?: number,
): ClockTime
Parameters
- hours: number
- minutes: number
- Optionalseconds: number
- Optionalmilliseconds: number
Returns ClockTime
Overrides TimeQuantity.constructor
- Defined in ClockTime.ts:24

Properties

`Protected`_quantity

_quantity: number = 0

`Protected`_total

_total: ResettableLazy<Readonly<TimeMeasurement>>

`Readonly`day

day: number

`Readonly`hour

hour: number

`Readonly`millisecond

millisecond: number

`Readonly`minute

minute: number

`Readonly`second

second: number

`Readonly`tick

tick: number

Accessors

direction

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

Returns number
Inherited from TimeQuantity.direction
- Defined in TimeQuantity.ts:54

total

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

Returns Readonly<TimeMeasurement>
Inherited from TimeQuantity.total
- Defined in TimeQuantity.ts:65

Methods

compareTo

compareTo(other: TimeQuantity): number
Compares this instance against any other time quantity instance.
Parameters
- other: TimeQuantity
Returns number
Inherited from TimeQuantity.compareTo
- Defined in TimeQuantity.ts:92

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.
Parameters
- other: TimeQuantity
Returns boolean
Inherited from TimeQuantity.equals
- Defined in TimeQuantity.ts:81

getTotal

getTotal(units: UnitType): number
Returns the total amount of time measured in the requested TimeUnit.
Parameters
- units: UnitType
Returns number
Inherited from TimeQuantity.getTotal
- Defined in TimeQuantity.ts:104

getTotalMilliseconds

getTotalMilliseconds(): number
Returns number
Inherited from TimeQuantity.getTotalMilliseconds
- Defined in TimeQuantity.ts:71

toString

toString(): string
Returns a string representation of an object.

Returns string
- Defined in ClockTime.ts:88

`Static`from

from(
    hours: number,
    minutes: number,
    seconds?: number,
    milliseconds?: number,
): ClockTime
Parameters
- hours: number
- minutes: number
- seconds: number = 0
- milliseconds: number = 0
Returns ClockTime
- Defined in ClockTime.ts:63

`Static`getTotalMillisecondsFrom

getTotalMillisecondsFrom(values: Partial<TimeMeasurement>): number
Combine total values by time unit.
Parameters
- values: Partial<TimeMeasurement>
Returns number
Inherited from TimeQuantity.getTotalMillisecondsFrom
- Defined in TimeQuantity.ts:39

`Static`millisecondsFromTime

millisecondsFromTime(
    hours: number,
    minutes: number,
    seconds?: number,
    milliseconds?: number,
): number
Parameters
- hours: number
- minutes: number
- seconds: number = 0
- milliseconds: number = 0
Returns number
- Defined in ClockTime.ts:72