Class DateTime

Defines a date and time

Index

Constructors

Methods

compareTo equalsTo format formateDefaultTimeZone formatSat formatTimeZone modify toJSON create now

Constructors

constructor

new DateTime(
value?: string | number | DateTime<boolean>,
defaultTimeZone?: string,
): DateTime
DateTime constructor.

If value is an integer is used as a timestamp, if is a string is evaluated as an argument for DateTimeImmutable and if it is DateTimeImmutable is used as is.
Parameters
- Optionalvalue: string | number | DateTime<boolean>
- OptionaldefaultTimeZone: string
Returns DateTime
Throws
Error if unable to create a DateTime
- Defined in src/shared/date_time.ts:18

Methods

compareTo

compareTo(otherDate: DateTime): number
Parameters
- otherDate: DateTime
Returns number
- Defined in src/shared/date_time.ts:95

equalsTo

equalsTo(expectedExpires: DateTime): boolean
Parameters
- expectedExpires: DateTime
Returns boolean
- Defined in src/shared/date_time.ts:99

format

format(format: string, timezone?: string): string
Parameters
- format: string
- timezone: string = ''
Returns string
- Defined in src/shared/date_time.ts:66

formateDefaultTimeZone

formateDefaultTimeZone(): string
Returns string
- Defined in src/shared/date_time.ts:77

formatSat

formatSat(): string
Returns string
- Defined in src/shared/date_time.ts:62

formatTimeZone

formatTimeZone(timezone: string): string
Parameters
- timezone: string
Returns string
- Defined in src/shared/date_time.ts:81

modify

modify(time: DurationLike): DateTime
add or sub in given DurationLike
Parameters
- time: DurationLike
Returns DateTime
- Defined in src/shared/date_time.ts:89

toJSON

toJSON(): number
Returns number
- Defined in src/shared/date_time.ts:103

`Static`create

create(
value?: string | number | DateTime<boolean>,
defaultTimeZone?: string,
): DateTime
Create a DateTime instance

If value is an integer is used as a timestamp, if is a string is evaluated as an argument for DateTimeImmutable and if it is DateTimeImmutable is used as is.
Parameters
- Optionalvalue: string | number | DateTime<boolean>
- OptionaldefaultTimeZone: string
Returns DateTime
- Defined in src/shared/date_time.ts:51

`Static`now

now(): DateTime
Returns DateTime
- Defined in src/shared/date_time.ts:58