Class TimeSpan

The TimeSpan class is used for representing time interval. TimeSpan cannot be negative.

IMPORT_PATH: "@daiso-tech/core/time-span"

Implements

Methods

[TO_MILLISECONDS]

"[TO_MILLISECONDS]"(): number
Returns number
Implementation of ITimeSpan.[TO_MILLISECONDS]
- Defined in src/time-span/implementations/time-span.ts:220

addDays

addDays(days: number): TimeSpan
Parameters
- days: number
Returns TimeSpan
- Defined in src/time-span/implementations/time-span.ts:176

addHours

addHours(hours: number): TimeSpan
Parameters
- hours: number
Returns TimeSpan
- Defined in src/time-span/implementations/time-span.ts:172

addMilliseconds

addMilliseconds(milliseconds: number): TimeSpan
Parameters
- milliseconds: number
Returns TimeSpan
- Defined in src/time-span/implementations/time-span.ts:160

addMinutes

addMinutes(minutes: number): TimeSpan
Parameters
- minutes: number
Returns TimeSpan
- Defined in src/time-span/implementations/time-span.ts:168

addSeconds

addSeconds(seconds: number): TimeSpan
Parameters
- seconds: number
Returns TimeSpan
- Defined in src/time-span/implementations/time-span.ts:164

addTimeSpan

addTimeSpan(timeSpan: ITimeSpan): TimeSpan
Parameters
- timeSpan: ITimeSpan
Returns TimeSpan
- Defined in src/time-span/implementations/time-span.ts:180

divide

divide(value: number): TimeSpan
Parameters
- value: number
Returns TimeSpan
- Defined in src/time-span/implementations/time-span.ts:216

equals

equals(value: ITimeSpan): boolean
Parameters
- value: ITimeSpan
Returns boolean
Implementation of IComparable.equals
- Defined in src/time-span/implementations/time-span.ts:73

gt

gt(value: ITimeSpan): boolean
Parameters
- value: ITimeSpan
Returns boolean
Implementation of IComparable.gt
- Defined in src/time-span/implementations/time-span.ts:77

gte

gte(value: ITimeSpan): boolean
Parameters
- value: ITimeSpan
Returns boolean
Implementation of IComparable.gte
- Defined in src/time-span/implementations/time-span.ts:81

lt

lt(value: ITimeSpan): boolean
Parameters
- value: ITimeSpan
Returns boolean
Implementation of IComparable.lt
- Defined in src/time-span/implementations/time-span.ts:85

lte

lte(value: ITimeSpan): boolean
Parameters
- value: ITimeSpan
Returns boolean
Implementation of IComparable.lte
- Defined in src/time-span/implementations/time-span.ts:89

multiply

multiply(value: number): TimeSpan
Parameters
- value: number
Returns TimeSpan
- Defined in src/time-span/implementations/time-span.ts:212

serialize

serialize(): SerializedTimeSpan
Returns SerializedTimeSpan
Implementation of ISerializable.serialize
- Defined in src/time-span/implementations/time-span.ts:93

subtractDays

subtractDays(days: number): TimeSpan
Parameters
- days: number
Returns TimeSpan
- Defined in src/time-span/implementations/time-span.ts:204

subtractHours

subtractHours(hours: number): TimeSpan
Parameters
- hours: number
Returns TimeSpan
- Defined in src/time-span/implementations/time-span.ts:200

subtractMilliseconds

subtractMilliseconds(milliseconds: number): TimeSpan
Parameters
- milliseconds: number
Returns TimeSpan
- Defined in src/time-span/implementations/time-span.ts:184

subtractMinutes

subtractMinutes(minutes: number): TimeSpan
Parameters
- minutes: number
Returns TimeSpan
- Defined in src/time-span/implementations/time-span.ts:194

subtractSeconds

subtractSeconds(seconds: number): TimeSpan
Parameters
- seconds: number
Returns TimeSpan
- Defined in src/time-span/implementations/time-span.ts:188

subtractTimeSpan

subtractTimeSpan(timeSpan: ITimeSpan): TimeSpan
Parameters
- timeSpan: ITimeSpan
Returns TimeSpan
- Defined in src/time-span/implementations/time-span.ts:208

toDays

toDays(): number
Returns number
- Defined in src/time-span/implementations/time-span.ts:240

toEndDate

toEndDate(startDate?: Date): Date
Will return endDate relative to a given startDate argument.
Parameters
- startDate: Date = ...
Returns Date
Default
```
new Date()
```
- Defined in src/time-span/implementations/time-span.ts:252

toHours

toHours(): number
Returns number
- Defined in src/time-span/implementations/time-span.ts:236

toMilliseconds

toMilliseconds(): number
Returns number
- Defined in src/time-span/implementations/time-span.ts:224

toMinutes

toMinutes(): number
Returns number
- Defined in src/time-span/implementations/time-span.ts:232

toSeconds

toSeconds(): number
Returns number
- Defined in src/time-span/implementations/time-span.ts:228

toStartDate

toStartDate(endDate?: Date): Date
Will return startDate relative to a given endDate argument.
Parameters
- endDate: Date = ...
Returns Date
Default
```
new Date()
```
- Defined in src/time-span/implementations/time-span.ts:264

toString

toString(): string
Converts it to readable string

Returns string
- Defined in src/time-span/implementations/time-span.ts:103

`Static`deserialize

deserialize(serializedValue: SerializedTimeSpan): TimeSpan
Parameters
- serializedValue: SerializedTimeSpan
Returns TimeSpan
- Defined in src/time-span/implementations/time-span.ts:65

`Static`fromDateRange

fromDateRange(__namedParameters: TimeSpanFromDateRangeSettings): TimeSpan
Parameters
- __namedParameters: TimeSpanFromDateRangeSettings
Returns TimeSpan
- Defined in src/time-span/implementations/time-span.ts:131

`Static`fromDays

fromDays(days: number): TimeSpan
Parameters
- days: number
Returns TimeSpan
- Defined in src/time-span/implementations/time-span.ts:123

`Static`fromHours

fromHours(hours: number): TimeSpan
Parameters
- hours: number
Returns TimeSpan
- Defined in src/time-span/implementations/time-span.ts:119

`Static`fromMilliseconds

fromMilliseconds(milliseconds: number): TimeSpan
Parameters
- milliseconds: number
Returns TimeSpan
- Defined in src/time-span/implementations/time-span.ts:107

`Static`fromMinutes

fromMinutes(minutes: number): TimeSpan
Parameters
- minutes: number
Returns TimeSpan
- Defined in src/time-span/implementations/time-span.ts:115

`Static`fromSeconds

fromSeconds(seconds: number): TimeSpan
Parameters
- seconds: number
Returns TimeSpan
- Defined in src/time-span/implementations/time-span.ts:111

`Static`fromStr

fromStr(timeAsStr: string): TimeSpan
Create a TimeSpan from string
Parameters
- timeAsStr: string
Returns TimeSpan
Example
```
// Will be 5000 milliseconds.
TimeSpan.fromStr("5s").toMilliseconds()
```
Under the hood, this method leverages @lukeed/ms package to convert various time formats into milliseconds. Refer to its documentation for a complete list of supported time formats and units.
- Defined in src/time-span/implementations/time-span.ts:150

`Static`fromTimeSpan

fromTimeSpan(timeSpan: ITimeSpan): TimeSpan
Parameters
- timeSpan: ITimeSpan
Returns TimeSpan
- Defined in src/time-span/implementations/time-span.ts:127