@technobuddha > library > Time > Time Span

Class: TimeSpan

Defined in: time-span.ts:19

Store and manipulate a duration of time

Constructors

Constructor

new TimeSpan(): TimeSpan;

Defined in: src/time-span.ts:23

Create a new TimeSpan

Returns

TimeSpan

Constructor

new TimeSpan(ticks: number): TimeSpan;

Defined in: src/time-span.ts:28

Create a new TimeSpan from ticks (milliseconds)

Parameters

Parameter	Type	Description
ticks	number	the number of ticks (milliseconds)

Returns

TimeSpan

Constructor

new TimeSpan(
   h: number, 
   m: number, 
   s: number): TimeSpan;

Defined in: src/time-span.ts:35

Create a new TimeSpan from hours, minutes, and seconds

Parameters

Parameter	Type	Description
h	number	Hours
m	number	minutes
s	number	seconds

Returns

TimeSpan

Constructor

new TimeSpan(
   d: number, 
   h: number, 
   m: number, 
   s: number): TimeSpan;

Defined in: src/time-span.ts:43

Create a new TimeSpan from days, hours, minutes, and seconds

Parameters

Parameter	Type	Description
d	number	Days
h	number	Hours
m	number	minutes
s	number	seconds

Returns

TimeSpan

Constructor

new TimeSpan(
   d: number, 
   h: number, 
   m: number, 
   s: number, 
   ms: number): TimeSpan;

Defined in: src/time-span.ts:52

Create a new TimeSpan from days, hours, minutes, seconds, and milliseconds

Parameters

Parameter	Type	Description
d	number	Days
h	number	Hours
m	number	minutes
s	number	seconds
ms	number	milliseconds

Returns

TimeSpan

Constructor

new TimeSpan(text: string): TimeSpan;

Defined in: src/time-span.ts:57

Create a new TimeSpan from a formatted string

Parameters

Parameter	Type	Description
text	string	formatted timespan (dd:hh:mm:ss.fff) leading zero fields can be omitted

Returns

TimeSpan

Accessors

days

Get Signature

get days(): number;

Defined in: src/time-span.ts:150

Get the days portion

Returns

number

---

hours

Get Signature

get hours(): number;

Defined in: src/time-span.ts:157

Get the hours portion

Returns

number

---

milliseconds

Get Signature

get milliseconds(): number;

Defined in: src/time-span.ts:185

Get the milliseconds portion

Returns

number

---

minutes

Get Signature

get minutes(): number;

Defined in: src/time-span.ts:166

Get the minutes portion

Returns

number

---

seconds

Get Signature

get seconds(): number;

Defined in: src/time-span.ts:175

Get the seconds portion

Returns

number

---

ticks

Get Signature

get ticks(): number;

Defined in: src/time-span.ts:192

Get the total number of ticks (milliseconds)

Returns

number

---

totalDays

Get Signature

get totalDays(): number;

Defined in: src/time-span.ts:199

Get the total number of days

Returns

number

---

totalHours

Get Signature

get totalHours(): number;

Defined in: src/time-span.ts:206

Get the total number of hours

Returns

number

---

totalMilliseconds

Get Signature

get totalMilliseconds(): number;

Defined in: src/time-span.ts:227

Get the total number of milliseconds

Returns

number

---

totalMinutes

Get Signature

get totalMinutes(): number;

Defined in: src/time-span.ts:213

Get the total number of minutes

Returns

number

---

totalSeconds

Get Signature

get totalSeconds(): number;

Defined in: src/time-span.ts:220

Get the total number of seconds

Returns

number

Methods

add()

add(other: TimeSpan): TimeSpan;

Defined in: src/time-span.ts:297

Add two timespans

Parameters

Parameter	Type	Description
other	TimeSpan	TimeSpan to add to this

Returns

TimeSpan

a TimeSpan that is the sum of two timespans

---

format()

format(mask?: string): string;

Defined in: src/time-span.ts:237

Format the timespan using a mask

Parameters

Parameter	Type	Description
mask?	string	The mask

Returns

string

the formatted TimeSpan

---

toString()

toString(): string;

Defined in: src/time-span.ts:287

Convert the TimeSpan to a string

Returns

string

formatted string

---

compare()

static compare(t1: TimeSpan, t2: TimeSpan): number;

Defined in: src/time-span.ts:308

Compare two TimeSpans

Parameters

Parameter	Type	Description
t1	TimeSpan	First TimeSpan
t2	TimeSpan	Second TimeSpan

Returns

number

-1 if the first time span is less then the second, 0 if they are equal, 1 if the first is greater