Class TimeSpan

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

Hierarchy

TimeQuantity
- TimeSpan

Implements

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new TimeSpan(value: number, units?: TimeUnit): TimeSpan

Overwrites TimeQuantity.constructor
- Defined in source/System/Time/TimeSpan.ts:29
Parameters
- value: number
- Default value units: TimeUnit = TimeUnit.Milliseconds
Returns TimeSpan

Properties

Protected _quantity

_quantity: number

Private _time

_time: ClockTime

Protected _total

_total: ITimeMeasurement

days

days: number

hours

hours: number

milliseconds

milliseconds: number

minutes

minutes: number

seconds

seconds: number

ticks

ticks: number

Accessors

direction

get direction(): number

Inherited from TimeQuantity.direction
- Defined in source/System/Time/TimeQuantity.ts:35
+1, 0, or -1 depending on the time direction.

Returns number

time

get time(): ClockTime

- Defined in source/System/Time/TimeSpan.ts:57
Returns ClockTime

total

get total(): TimeSpan

Overwrites TimeQuantity.total
- Defined in source/System/Time/TimeSpan.ts:50
Provides an standard interface for acquiring the total time.

Returns TimeSpan

Static zero

get zero(): TimeSpan

- Defined in source/System/Time/TimeSpan.ts:117
Returns TimeSpan

Methods

add

add(other: ITimeQuantity): TimeSpan

- Defined in source/System/Time/TimeSpan.ts:64
Parameters
- other: ITimeQuantity
Returns TimeSpan

addUnit

addUnit(value: number, units?: TimeUnit): TimeSpan

- Defined in source/System/Time/TimeSpan.ts:75
Parameters
- value: number
- Default value units: TimeUnit = TimeUnit.Milliseconds
Returns TimeSpan

compareTo

compareTo(other: ITimeQuantity): number

Inherited from TimeQuantity.compareTo
- Defined in source/System/Time/TimeQuantity.ts:55
Compares this instance against any other time quantity instance.

Parameters
- other: ITimeQuantity
Returns number

equals

equals(other: ITimeQuantity): boolean

Inherited from TimeQuantity.equals
- Defined in source/System/Time/TimeQuantity.ts:45
Compares this instance against any other time quantity instance and return true if the amount of time is the same.

Parameters
- other: ITimeQuantity
Returns boolean

getTotal

getTotal(units: TimeUnit): number

Inherited from TimeQuantity.getTotal
- Defined in source/System/Time/TimeQuantity.ts:92
Returns the total amount of time measured in the requested TimeUnit.

Parameters
- units: TimeUnit
Returns number

getTotalMilliseconds

getTotalMilliseconds(): number

Implementation of ITimeQuantity.getTotalMilliseconds

Inherited from TimeQuantity.getTotalMilliseconds
- Defined in source/System/Time/TimeQuantity.ts:26
Returns number

Static from

from(value: number, units: TimeUnit): TimeSpan

- Defined in source/System/Time/TimeSpan.ts:81
Parameters
- value: number
- units: TimeUnit
Returns TimeSpan

Static fromDays

fromDays(value: number): TimeSpan

- Defined in source/System/Time/TimeSpan.ts:86
Parameters
- value: number
Returns TimeSpan

Static fromHours

fromHours(value: number): TimeSpan

- Defined in source/System/Time/TimeSpan.ts:91
Parameters
- value: number
Returns TimeSpan

Static fromMilliseconds

fromMilliseconds(value: number): TimeSpan

- Defined in source/System/Time/TimeSpan.ts:106
Parameters
- value: number
Returns TimeSpan

Static fromMinutes

fromMinutes(value: number): TimeSpan

- Defined in source/System/Time/TimeSpan.ts:96
Parameters
- value: number
Returns TimeSpan

Static fromSeconds

fromSeconds(value: number): TimeSpan

- Defined in source/System/Time/TimeSpan.ts:101
Parameters
- value: number
Returns TimeSpan

Static fromTicks

fromTicks(value: number): TimeSpan

- Defined in source/System/Time/TimeSpan.ts:111
Parameters
- value: number
Returns TimeSpan

Generated using TypeDoc