Class TimeSpan

The TimeSpan class is used for representing time interval. TimeSpan class cannot be negative, if you pass negative number it will be converted to 0.

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:218

addDays

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

addHours

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

addMilliseconds

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

addMinutes

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

addSeconds

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

addTimeSpan

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

divide

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

equals

equals(value: ITimeSpan): boolean
Checks if this value equals the given value. Implementation defines what "equal" means for this type.
Parameters
- value: ITimeSpan
  The value to compare against
Returns boolean
True if values are equal, false otherwise
Implementation of IComparable.equals
- Defined in src/time-span/implementations/time-span.ts:71

gt

gt(value: ITimeSpan): boolean
Checks if this value is greater than the given value.
Parameters
- value: ITimeSpan
  The value to compare against
Returns boolean
True if this > value, false otherwise
Implementation of IComparable.gt
- Defined in src/time-span/implementations/time-span.ts:75

gte

gte(value: ITimeSpan): boolean
Checks if this value is greater than or equal to the given value.
Parameters
- value: ITimeSpan
  The value to compare against
Returns boolean
True if this >= value, false otherwise
Implementation of IComparable.gte
- Defined in src/time-span/implementations/time-span.ts:79

lt

lt(value: ITimeSpan): boolean
Checks if this value is less than the given value.
Parameters
- value: ITimeSpan
  The value to compare against
Returns boolean
True if this < value, false otherwise
Implementation of IComparable.lt
- Defined in src/time-span/implementations/time-span.ts:83

lte

lte(value: ITimeSpan): boolean
Checks if this value is less than or equal to the given value.
Parameters
- value: ITimeSpan
  The value to compare against
Returns boolean
True if this <= value, false otherwise
Implementation of IComparable.lte
- Defined in src/time-span/implementations/time-span.ts:87

multiply

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

serialize

serialize(): SerializedTimeSpan
Serializes this instance to a versioned format. Instance method that converts the current state to a storable/transportable form. Must include a version field for deserialization to know how to reconstruct.

Returns SerializedTimeSpan
Serialized representation with version field
Implementation of ISerializable.serialize
- Defined in src/time-span/implementations/time-span.ts:91

subtractDays

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

subtractHours

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

subtractMilliseconds

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

subtractMinutes

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

subtractSeconds

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

subtractTimeSpan

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

toDays

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

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:250

toHours

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

toMilliseconds

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

toMinutes

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

toSeconds

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

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:262

toString

toString(): string
Converts it to readable string

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

`Static`deserialize

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

`Static`fromDateRange

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

`Static`fromDays

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

`Static`fromHours

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

`Static`fromMilliseconds

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

`Static`fromMinutes

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

`Static`fromSeconds

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

`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:148

`Static`fromTimeSpan

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

Class TimeSpan

Implements

Index

Methods

Methods

[TO_MILLISECONDS]

Returns number

addDays

Parameters

Returns TimeSpan

addHours

Parameters

Returns TimeSpan

addMilliseconds

Parameters

Returns TimeSpan

addMinutes

Parameters

Returns TimeSpan

addSeconds

Parameters

Returns TimeSpan

addTimeSpan

Parameters

Returns TimeSpan

divide

Parameters

Returns TimeSpan

equals

Parameters

Returns boolean

gt

Parameters

Returns boolean

gte

Parameters

Returns boolean

lt

Parameters

Returns boolean

lte

Parameters

Returns boolean

multiply

Parameters

Returns TimeSpan

serialize

Returns SerializedTimeSpan

subtractDays

Parameters

Returns TimeSpan

subtractHours

Parameters

Returns TimeSpan

subtractMilliseconds

Parameters

Returns TimeSpan

subtractMinutes

Parameters

Returns TimeSpan

subtractSeconds

Parameters

Returns TimeSpan

subtractTimeSpan

Parameters

Returns TimeSpan

toDays

Returns number

toEndDate

Parameters

Returns Date

Default

toHours

Returns number

toMilliseconds

Returns number

toMinutes

Returns number

toSeconds

Returns number

`Static`deserialize

`Static`fromDateRange

`Static`fromDays

`Static`fromHours

`Static`fromMilliseconds

`Static`fromMinutes

`Static`fromSeconds

`Static`fromStr

`Static`fromTimeSpan