TimeSpan
Defined in: src/TimeSpan.ts:22
An immutable time interval, stored in milliseconds. Modeled on .NET’s TimeSpan.
Example
Section titled “Example”controller.abortAfter(TimeSpan.fromSeconds(30));TimeSpan.fromMinutes(1).add(TimeSpan.fromSeconds(30)).totalSeconds; // 90Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new TimeSpan(
milliseconds):TimeSpan
Defined in: src/TimeSpan.ts:36
Parameters
Section titled “Parameters”milliseconds
Section titled “milliseconds”number
Returns
Section titled “Returns”TimeSpan
Throws
Section titled “Throws”RangeError if milliseconds is not a finite number.
Properties
Section titled “Properties”milliseconds
Section titled “milliseconds”
readonlymilliseconds:number
Defined in: src/TimeSpan.ts:33
The interval in milliseconds.
infinite
Section titled “infinite”
readonlystaticinfinite:TimeSpan
Defined in: src/TimeSpan.ts:30
-1 ms, .NET’s Timeout.InfiniteTimeSpan: abortAfter(TimeSpan.infinite) cancels a scheduled abort.
maxValue
Section titled “maxValue”
readonlystaticmaxValue:TimeSpan
Defined in: src/TimeSpan.ts:26
The largest interval (Number.MAX_SAFE_INTEGER ms, about 285,616 years).
minValue
Section titled “minValue”
readonlystaticminValue:TimeSpan
Defined in: src/TimeSpan.ts:28
The smallest interval (-Number.MAX_SAFE_INTEGER ms).
readonlystaticzero:TimeSpan
Defined in: src/TimeSpan.ts:24
A zero-length interval.
Accessors
Section titled “Accessors”totalDays
Section titled “totalDays”Get Signature
Section titled “Get Signature”get totalDays():
number
Defined in: src/TimeSpan.ts:56
The interval in whole and fractional days.
Returns
Section titled “Returns”number
totalHours
Section titled “totalHours”Get Signature
Section titled “Get Signature”get totalHours():
number
Defined in: src/TimeSpan.ts:51
The interval in whole and fractional hours.
Returns
Section titled “Returns”number
totalMinutes
Section titled “totalMinutes”Get Signature
Section titled “Get Signature”get totalMinutes():
number
Defined in: src/TimeSpan.ts:46
The interval in whole and fractional minutes.
Returns
Section titled “Returns”number
totalSeconds
Section titled “totalSeconds”Get Signature
Section titled “Get Signature”get totalSeconds():
number
Defined in: src/TimeSpan.ts:41
The interval in whole and fractional seconds.
Returns
Section titled “Returns”number
Methods
Section titled “Methods”add(
other):TimeSpan
Defined in: src/TimeSpan.ts:61
A new interval: this one plus other.
Parameters
Section titled “Parameters”TimeSpan
Returns
Section titled “Returns”TimeSpan
compareTo()
Section titled “compareTo()”compareTo(
other):number
Defined in: src/TimeSpan.ts:76
Negative if this interval is shorter than other, 0 if equal, positive if longer.
Parameters
Section titled “Parameters”TimeSpan
Returns
Section titled “Returns”number
equals()
Section titled “equals()”equals(
other):boolean
Defined in: src/TimeSpan.ts:71
True if both intervals have the same length.
Parameters
Section titled “Parameters”TimeSpan
Returns
Section titled “Returns”boolean
subtract()
Section titled “subtract()”subtract(
other):TimeSpan
Defined in: src/TimeSpan.ts:66
A new interval: this one minus other.
Parameters
Section titled “Parameters”TimeSpan
Returns
Section titled “Returns”TimeSpan
toString()
Section titled “toString()”toString():
string
Defined in: src/TimeSpan.ts:86
E.g. "1500ms".
Returns
Section titled “Returns”string
valueOf()
Section titled “valueOf()”valueOf():
number
Defined in: src/TimeSpan.ts:81
The interval in milliseconds, so +span and comparisons work.
Returns
Section titled “Returns”number
fromDays()
Section titled “fromDays()”
staticfromDays(days):TimeSpan
Defined in: src/TimeSpan.ts:106
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”TimeSpan
fromHours()
Section titled “fromHours()”
staticfromHours(hours):TimeSpan
Defined in: src/TimeSpan.ts:102
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”TimeSpan
fromMilliseconds()
Section titled “fromMilliseconds()”
staticfromMilliseconds(milliseconds):TimeSpan
Defined in: src/TimeSpan.ts:90
Parameters
Section titled “Parameters”milliseconds
Section titled “milliseconds”number
Returns
Section titled “Returns”TimeSpan
fromMinutes()
Section titled “fromMinutes()”
staticfromMinutes(minutes):TimeSpan
Defined in: src/TimeSpan.ts:98
Parameters
Section titled “Parameters”minutes
Section titled “minutes”number
Returns
Section titled “Returns”TimeSpan
fromSeconds()
Section titled “fromSeconds()”
staticfromSeconds(seconds):TimeSpan
Defined in: src/TimeSpan.ts:94
Parameters
Section titled “Parameters”seconds
Section titled “seconds”number
Returns
Section titled “Returns”TimeSpan