Class TimeSpan

TimeSpan expands on TimeQuantity to provide an class that is similar to .NET's TimeSpan including many useful static methods.

Hierarchy (View Summary)

TimeQuantity
- TimeSpan

Implements

TimeMeasurement

Index

Constructors

`Protected`constructor

new TimeSpan(value: number, units?: UnitType): TimeSpan
Parameters
- value: number
- units: UnitType = TimeUnit.UnitType.Milliseconds
Returns TimeSpan
Overrides TimeQuantity.constructor
- Defined in TimeSpan.ts:53

Properties

`Protected`_quantity

_quantity: number = 0

`Protected`_total

_total: ResettableLazy<Readonly<TimeMeasurement>>

`Readonly`days

days: number

The total number of ticks that days this amount of time.

`Readonly`hours

hours: number

The total number of ticks that hours this amount of time.

`Readonly`milliseconds

milliseconds: number

The total number of ticks that milliseconds this amount of time.

`Readonly`minutes

minutes: number

The total number of ticks that minutes this amount of time.

`Readonly`seconds

seconds: number

The total number of ticks that seconds this amount of time.

`Readonly`ticks

ticks: number

The total number of ticks that represent this amount of time.

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

time

get time(): ClockTime
The value of this TimeSpan reduced to the clock and calendar.

Returns ClockTime
- Defined in TimeSpan.ts:93

total

get total(): TimeSpan
Provides an standard interface for acquiring the total time.

Returns TimeSpan
Overrides TimeQuantity.total
- Defined in TimeSpan.ts:80

`Static`zero

get zero(): TimeSpan
Returns TimeSpan
- Defined in TimeSpan.ts:71

Methods

add

add(other: TimeQuantity | Partial<TimeMeasurement> | TimeSpan): TimeSpan
Sum the value of this TimeSpan with another time quantity.
Parameters
- other: TimeQuantity | Partial<TimeMeasurement> | TimeSpan
Returns TimeSpan
- Defined in TimeSpan.ts:149

addUnit

addUnit(value: number, units?: UnitType): TimeSpan
Sum the value of this TimeSpan with another unit value.
Parameters
- value: number
- units: UnitType = TimeUnit.UnitType.Milliseconds
Returns TimeSpan
- Defined in TimeSpan.ts:170

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

`Static`from

from(values: Partial<TimeMeasurement>): TimeSpan
Parameters
- values: Partial<TimeMeasurement>
Returns TimeSpan
- Defined in TimeSpan.ts:98
from(value: number, units: UnitType): TimeSpan
Parameters
- value: number
- units: UnitType
Returns TimeSpan
- Defined in TimeSpan.ts:100

`Static`fromDays

fromDays(value: number): TimeSpan
Parameters
- value: number
Returns TimeSpan
- Defined in TimeSpan.ts:114

`Static`fromHours

fromHours(value: number): TimeSpan
Parameters
- value: number
Returns TimeSpan
- Defined in TimeSpan.ts:119

`Static`fromMilliseconds

fromMilliseconds(value: number): TimeSpan
Parameters
- value: number
Returns TimeSpan
- Defined in TimeSpan.ts:134

`Static`fromMinutes

fromMinutes(value: number): TimeSpan
Parameters
- value: number
Returns TimeSpan
- Defined in TimeSpan.ts:124

`Static`fromSeconds

fromSeconds(value: number): TimeSpan
Parameters
- value: number
Returns TimeSpan
- Defined in TimeSpan.ts:129

`Static`fromTicks

fromTicks(value: number): TimeSpan
Parameters
- value: number
Returns TimeSpan
- Defined in TimeSpan.ts:139

`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

Class TimeSpan

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Protectedconstructor

Parameters

Returns TimeSpan

Properties

Protected_quantity

Protected_total

Readonlydays

Readonlyhours

Readonlymilliseconds

Readonlyminutes

Readonlyseconds

Readonlyticks

Accessors

direction

Returns number

time

Returns ClockTime

total

Returns TimeSpan

Staticzero

Returns TimeSpan

Methods

add

Parameters

Returns TimeSpan

addUnit

Parameters

Returns TimeSpan

compareTo

Parameters

Returns number

equals

Parameters

Returns boolean

getTotal

Parameters

Returns number

getTotalMilliseconds

Returns number

Staticfrom

Parameters

Returns TimeSpan

Parameters

Returns TimeSpan

StaticfromDays

Parameters

Returns TimeSpan

StaticfromHours

Parameters

Returns TimeSpan

StaticfromMilliseconds

Parameters

Returns TimeSpan

StaticfromMinutes

Parameters

Returns TimeSpan

StaticfromSeconds

Parameters

Returns TimeSpan

StaticfromTicks

Parameters

Returns TimeSpan

StaticgetTotalMillisecondsFrom

Parameters

Returns number

Settings

On This Page

`Protected`constructor

`Protected`_quantity

`Protected`_total

`Readonly`days

`Readonly`hours

`Readonly`milliseconds

`Readonly`minutes

`Readonly`seconds

`Readonly`ticks

`Static`zero

`Static`from

`Static`fromDays

`Static`fromHours

`Static`fromMilliseconds

`Static`fromMinutes

`Static`fromSeconds

`Static`fromTicks

`Static`getTotalMillisecondsFrom