Constructor
(package) new DateFormatter(ms)
Constructs a DateFormatter instance with a given timestamp in milliseconds.
Parameters:
| Name | Type | Description |
|---|---|---|
ms |
number | The timestamp in milliseconds since the UNIX epoch. |
- Since:
- 2.0.0
- Source:
Throws:
-
If given
msis not a valid number. - Type
- InvalidTypeError
Methods
micros() → {number}
An alias method for DateFormatter#toMicroseconds
- Since:
- 2.0.0
- Source:
Returns:
- Type
- number
millis() → {number}
An alias method for DateFormatter#toMilliseconds
- Since:
- 2.0.0
- Source:
Returns:
- Type
- number
toDateObject() → {Date}
Get the Date object from this instance.
- Since:
- 2.0.0
- Source:
Returns:
- Type
- Date
toISO() → {string}
An alias method for DateFormatter#toISOString
- Since:
- 2.0.0
- Source:
Returns:
- Type
- string
toISOString() → {string}
Get the ISO-8601 formatted date string.
- Since:
- 2.0.0
- Source:
Returns:
- Type
- string
toLocaleString(localeopt, optionsopt) → {string}
Get the date formatted to a specified locale.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
locale |
string |
<optional> |
The locale string. Will default to system locale if not provided. |
options |
Object |
<optional> |
Formatting options for date time format. |
- Since:
- 2.0.0
- Source:
Returns:
- Type
- string
toMicroseconds() → {number}
Get the timestamp in microseconds.
- Since:
- 2.0.0
- Source:
Returns:
- Type
- number
toMilliseconds() → {number}
Get the timestamp in milliseconds.
- Since:
- 2.0.0
- Source:
Returns:
- Type
- number
toString() → {string}
Get the human-readable date string.
- Since:
- 2.0.0
- Source:
Returns:
- Type
- string
(static) fromMicroseconds(microsecs) → {DateFormatter}
Parse a timestamp in microseconds and return a DateFormatter
Parameters:
| Name | Type | Description |
|---|---|---|
microsecs |
number | Timestamp in microseconds. |
- Since:
- 2.0.0
- Source:
Throws:
-
If the given timestamp is not a number.
- Type
- InvalidTypeError
Returns:
- Type
- DateFormatter