Skip to main content

Class: Timestamp

@sapphire/time-utilities.Timestamp

Timestamp class, parses the pattern once, displays the desired Date or UNIX timestamp with the selected pattern.

Constructors

constructor

new Timestamp(pattern)

Starts a new Timestamp and parses the pattern.

Since

1.0.0

Parameters

NameTypeDescription
patternstringThe pattern to parse

Defined in

node_modules/@sapphire/timestamp/dist/index.d.ts:40

Properties

pattern

pattern: string

The raw pattern

Since

1.0.0

Defined in

node_modules/@sapphire/timestamp/dist/index.d.ts:30


template

Private template: any

Since

1.0.0

Defined in

node_modules/@sapphire/timestamp/dist/index.d.ts:34


display

Private Static display: any

Display the current date with the current pattern.

Since

1.0.0

Param

The pattern to parse

Param

The time to display

Defined in

node_modules/@sapphire/timestamp/dist/index.d.ts:90


parse

Private Static parse: any

Parses the pattern.

Since

1.0.0

Param

The pattern to parse

Defined in

node_modules/@sapphire/timestamp/dist/index.d.ts:96


resolveDate

Private Static resolveDate: any

Resolves a date.

Since

1.0.0

Param

The time to parse

Defined in

node_modules/@sapphire/timestamp/dist/index.d.ts:102

Methods

display

display(time?): string

Display the current date with the current pattern.

Since

1.0.0

Parameters

NameTypeDescription
time?TimeResolvableThe time to display

Returns

string

Defined in

node_modules/@sapphire/timestamp/dist/index.d.ts:46


displayUTC

displayUTC(time?): string

Display the current date utc with the current pattern.

Since

1.0.0

Parameters

NameTypeDescription
time?TimeResolvableThe time to display in utc

Returns

string

Defined in

node_modules/@sapphire/timestamp/dist/index.d.ts:52


edit

edit(pattern): Timestamp

Edits the current pattern.

Since

1.0.0

Chainable

Parameters

NameTypeDescription
patternstringThe new pattern for this instance

Returns

Timestamp

Defined in

node_modules/@sapphire/timestamp/dist/index.d.ts:59


toString

toString(): string

Defines the toString behavior of Timestamp.

Returns

string

Defined in

node_modules/@sapphire/timestamp/dist/index.d.ts:63


displayArbitrary

Static displayArbitrary(pattern, time?): string

Display the current date with the current pattern.

Since

1.0.0

Parameters

NameTypeDescription
patternstringThe pattern to parse
time?TimeResolvableThe time to display

Returns

string

Defined in

node_modules/@sapphire/timestamp/dist/index.d.ts:70


displayUTCArbitrary

Static displayUTCArbitrary(pattern, time?): string

Display the current date utc with the current pattern.

Since

1.0.0

Parameters

NameTypeDescription
patternstringThe pattern to parse
time?TimeResolvableThe time to display

Returns

string

Defined in

node_modules/@sapphire/timestamp/dist/index.d.ts:77


utc

Static utc(time?): Date

Creates a UTC Date object to work with.

Since

1.0.0

Parameters

NameTypeDescription
time?string | number | DateThe date to convert to utc

Returns

Date

Defined in

node_modules/@sapphire/timestamp/dist/index.d.ts:83