Class: Timestamp

@sapphire/timestamp.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.

Parameters

Name	Type	Description
pattern	string	The pattern to parse

Since

1.0.0

Defined in

lib/Timestamp.ts:142

Properties

pattern

• pattern: string

The raw pattern

Since

1.0.0

Defined in

lib/Timestamp.ts:130

---

template

• Private template: TimestampTemplateEntry[]

Since

1.0.0

Defined in

lib/Timestamp.ts:135

Methods

display

▸ display(time?): string

Display the current date with the current pattern.

Parameters

Name	Type	Description
time	TimeResolvable	The time to display

Returns

string

Since

1.0.0

Defined in

lib/Timestamp.ts:152

---

displayUTC

▸ displayUTC(time?): string

Display the current date utc with the current pattern.

Parameters

Name	Type	Description
time?	TimeResolvable	The time to display in utc

Returns

string

Since

1.0.0

Defined in

lib/Timestamp.ts:161

---

edit

▸ edit(pattern): Timestamp

Edits the current pattern.

Parameters

Name	Type	Description
pattern	string	The new pattern for this instance

Returns

Timestamp

Since

1.0.0

Chainable

Defined in

lib/Timestamp.ts:171

---

toString

▸ toString(): string

Defines the toString behavior of Timestamp.

Returns

string

Defined in

lib/Timestamp.ts:180

---

display

▸ Private Static display(template, time): string

Display the current date with the current pattern.

Parameters

Name	Type	Description
template	TimestampTemplateEntry[]	The pattern to parse
time	string | number | Date	The time to display

Returns

string

Since

1.0.0

Defined in

lib/Timestamp.ts:220

---

displayArbitrary

▸ Static displayArbitrary(pattern, time?): string

Display the current date with the current pattern.

Parameters

Name	Type	Description
pattern	string	The pattern to parse
time	TimeResolvable	The time to display

Returns

string

Since

1.0.0

Defined in

lib/Timestamp.ts:190

---

displayUTCArbitrary

▸ Static displayUTCArbitrary(pattern, time?): string

Display the current date utc with the current pattern.

Parameters

Name	Type	Description
pattern	string	The pattern to parse
time	TimeResolvable	The time to display

Returns

string

Since

1.0.0

Defined in

lib/Timestamp.ts:200

---

parse

▸ Private Static parse(pattern): TimestampTemplateEntry[]

Parses the pattern.

Parameters

Name	Type	Description
pattern	string	The pattern to parse

Returns

TimestampTemplateEntry[]

Since

1.0.0

Defined in

lib/Timestamp.ts:232

---

resolveDate

▸ Private Static resolveDate(time): Date

Resolves a date.

Parameters

Name	Type	Description
time	TimeResolvable	The time to parse

Returns

Date

Since

1.0.0

Defined in

lib/Timestamp.ts:261

---

utc

▸ Static utc(time?): Date

Creates a UTC Date object to work with.

Parameters

Name	Type	Description
time	string | number | Date	The date to convert to utc

Returns

Date

Since

1.0.0

Defined in

lib/Timestamp.ts:209