Class Duration

Hierarchy

Duration

Index

Constructors

Properties

Accessors

days hours minutes months seconds years

Methods

add isAfter isBefore isSame subtract toISOString toJSON toLocaleString toString fromDays fromHours fromMinutes fromMonths fromNow fromSeconds fromString fromYears

Constructors

constructor

new Duration(ms: number): Duration
Parameters
- ms: number
Returns Duration
- Defined in src/time-utilities/index.ts:6

Properties

date

date: Date

`Protected` ms

ms: number

Accessors

days

get days(): number
Days left in the duration

Returns
The days

Returns number
- Defined in src/time-utilities/index.ts:127

hours

get hours(): number
Hours left in the duration

Returns
The hours

Returns number
- Defined in src/time-utilities/index.ts:119

minutes

get minutes(): number
Minutes left in the duration

Returns
The minutes

Returns number
- Defined in src/time-utilities/index.ts:111

months

get months(): number
Months left in the duration

Returns
The months

Returns number
- Defined in src/time-utilities/index.ts:135

seconds

get seconds(): number
Seconds left in the duration

Returns
The seconds

Returns number
- Defined in src/time-utilities/index.ts:103

years

get years(): number
Years left in the duration

Returns
The years

Returns number
- Defined in src/time-utilities/index.ts:142

Methods

add

add(duration: Duration): Duration
Add a duration to the current duration

Returns
The duration
Parameters
- duration: Duration
  
  The duration to add
Returns Duration
- Defined in src/time-utilities/index.ts:84

isAfter

isAfter(date: Date): boolean
Check if the provided date is after the current date

Returns
If the date is before
Parameters
- date: Date
  
  The date
Returns boolean
- Defined in src/time-utilities/index.ts:57

isBefore

isBefore(date: Date): boolean
Check if the provided date is before the current date

Returns
If the date is before
Parameters
- date: Date
  
  The date
Returns boolean
- Defined in src/time-utilities/index.ts:66

isSame

isSame(date: Date): boolean
Check if the provided date is same as the current date

Returns
If the date is same
Parameters
- date: Date
  
  The date
Returns boolean
- Defined in src/time-utilities/index.ts:75

subtract

subtract(duration: Duration): Duration
Subtract a duration from the current duration

Returns
The duration
Parameters
- duration: Duration
  
  The duration to subtract
Returns Duration
- Defined in src/time-utilities/index.ts:94

toISOString

toISOString(): string
Get the duration to a ISO string

Returns
The ISO string

Returns string
- Defined in src/time-utilities/index.ts:40

toJSON

toJSON(): ParsedMs
Get the duration to a JSON object

Returns
The JSON object

Returns ParsedMs
- Defined in src/time-utilities/index.ts:48

toLocaleString

toLocaleString(locale: string): string
Converts the duration to a locale string

Returns
The string

See
toString
Parameters
- locale: string
Returns string
- Defined in src/time-utilities/index.ts:23

toString

toString(): string
Converts the duration to a string

Returns
The string

Returns string
- Defined in src/time-utilities/index.ts:14

`Static` fromDays

fromDays(days: number): Duration
Create the class constructor from days

Returns
The duration
Parameters
- days: number
  
  The days
Returns Duration
- Defined in src/time-utilities/index.ts:178

`Static` fromHours

fromHours(hours: number): Duration
Create the class constructor from hours

Returns
The duration
Parameters
- hours: number
  
  The hours
Returns Duration
- Defined in src/time-utilities/index.ts:169

`Static` fromMinutes

fromMinutes(minutes: number): Duration
Create the class constructor from minutes

Returns
The duration
Parameters
- minutes: number
  
  The minutes
Returns Duration
- Defined in src/time-utilities/index.ts:160

`Static` fromMonths

fromMonths(months: number): Duration
Create the class constructor from months

Returns
The duration
Parameters
- months: number
  
  The months
Returns Duration
- Defined in src/time-utilities/index.ts:186

`Static` fromNow

fromNow(duration: string): Duration
Create the class constructor from the current time

Returns
The duration
Parameters
- duration: string
  
  The duration string
Returns Duration
- Defined in src/time-utilities/index.ts:32

`Static` fromSeconds

fromSeconds(seconds: number): Duration
Create the class constructor from seconds

Returns
The duration
Parameters
- seconds: number
  
  The seconds
Returns Duration
- Defined in src/time-utilities/index.ts:151

`Static` fromString

fromString(duration: string): Duration
Create the class constructor from a string

Returns
The duration
Parameters
- duration: string
  
  The duration string
Returns Duration
- Defined in src/time-utilities/index.ts:204

`Static` fromYears

fromYears(years: number): Duration
Create the class constructor from years rather than milliseconds

Returns
The duration
Parameters
- years: number
  
  The years
Returns Duration
- Defined in src/time-utilities/index.ts:195

Generated using TypeDoc