Appearance
Interface: GetTimestampProps
Defined in: src/utils/getTimestamp.ts:179
Options for generating a timestamp string.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
date? | Date | The date to format. Defaults to the current date. | src/utils/getTimestamp.ts:181 |
separator? | string | The character used to separate date parts. Defaults to '-'. | src/utils/getTimestamp.ts:183 |
includeYear? | boolean | Include the year. Defaults to true. | src/utils/getTimestamp.ts:185 |
includeMonth? | boolean | Include the month. Defaults to true. | src/utils/getTimestamp.ts:187 |
includeDay? | boolean | Include the day. Defaults to true. | src/utils/getTimestamp.ts:189 |
includeHours? | boolean | Include the hours. Defaults to true. | src/utils/getTimestamp.ts:191 |
includeMinutes? | boolean | Include the minutes. Defaults to true. | src/utils/getTimestamp.ts:193 |
includeSeconds? | boolean | Include the seconds. Defaults to true. | src/utils/getTimestamp.ts:195 |
useLocalTimezone? | boolean | Use the system's local timezone instead of UTC. Defaults to false. | src/utils/getTimestamp.ts:197 |
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. | src/utils/getTimestamp.ts:203 |