Skip to main content

Class: Duration

@sapphire/duration.Duration

Converts duration strings into ms and future dates

Constructors

constructor

new Duration(pattern)

Create a new Duration instance

Parameters

NameTypeDescription
patternstringThe string to parse

Defined in

lib/Duration.ts:133

Properties

days

days: number = 0

The amount of days extracted from the text.

Defined in

lib/Duration.ts:112


hours

hours: number = 0

The amount of hours extracted from the text.

Defined in

lib/Duration.ts:107


microseconds

microseconds: number = 0

The amount of microseconds extracted from the text.

Defined in

lib/Duration.ts:87


milliseconds

milliseconds: number = 0

The amount of milliseconds extracted from the text.

Defined in

lib/Duration.ts:92


minutes

minutes: number = 0

The amount of minutes extracted from the text.

Defined in

lib/Duration.ts:102


months

months: number = 0

The amount of months extracted from the text.

Defined in

lib/Duration.ts:122


nanoseconds

nanoseconds: number = 0

The amount of nanoseconds extracted from the text.

Defined in

lib/Duration.ts:82


offset

offset: number

The offset

Defined in

lib/Duration.ts:77


seconds

seconds: number = 0

The amount of seconds extracted from the text.

Defined in

lib/Duration.ts:97


weeks

weeks: number = 0

The amount of weeks extracted from the text.

Defined in

lib/Duration.ts:117


years

years: number = 0

The amount of years extracted from the text.

Defined in

lib/Duration.ts:127


aAndAnRegex

Private Static Readonly aAndAnRegex: RegExp

The RegExp used for replacing a/an with 1

Defined in

lib/Duration.ts:186


commaRegex

Private Static Readonly commaRegex: RegExp

The RegExp used for removing commas

Defined in

lib/Duration.ts:181


patternRegex

Private Static Readonly patternRegex: RegExp

The RegExp used for the pattern parsing

Defined in

lib/Duration.ts:176

Accessors

fromNow

get fromNow(): Date

Get the date from now

Returns

Date

Defined in

lib/Duration.ts:161

Methods

dateFrom

dateFrom(date): Date

Get the date from

Parameters

NameTypeDescription
dateDateThe Date instance to get the date from

Returns

Date

Defined in

lib/Duration.ts:169