Appearance
Interface: GetTimestampProps
Defined in: packages/shared/lib/time/getTimestamp.d.ts:21
Options for generating a timestamp string.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
date? | Date | The date to format. Defaults to the current date. | packages/shared/lib/time/getTimestamp.d.ts:23 |
includeDay? | boolean | Include the day. Defaults to true. | packages/shared/lib/time/getTimestamp.d.ts:25 |
includeHours? | boolean | Include the hours. Defaults to true. | packages/shared/lib/time/getTimestamp.d.ts:27 |
includeMinutes? | boolean | Include the minutes. Defaults to true. | packages/shared/lib/time/getTimestamp.d.ts:29 |
includeMonth? | boolean | Include the month. Defaults to true. | packages/shared/lib/time/getTimestamp.d.ts:31 |
includeSeconds? | boolean | Include the seconds. Defaults to true. | packages/shared/lib/time/getTimestamp.d.ts:33 |
includeYear? | boolean | Include the year. Defaults to true. | packages/shared/lib/time/getTimestamp.d.ts:35 |
separator? | string | The character used to separate date parts. Defaults to '-'. | packages/shared/lib/time/getTimestamp.d.ts:37 |
timezone? | Timezone | Timezone to format the date in. Accepts an IANA identifier (e.g. 'Asia/Kolkata') or a common abbreviation (e.g. 'IST', 'CET'). Overrides useLocalTimezone when set. | packages/shared/lib/time/getTimestamp.d.ts:43 |
useLocalTimezone? | boolean | Use the system's local timezone instead of UTC. Defaults to false. | packages/shared/lib/time/getTimestamp.d.ts:45 |