/** * A string that describes the format to use when turning a `Date` instance into a string. * * Available tokens: * * * `yyyy` - 4-digit year, e.g. 1970, 2023 * * `mm` - 2-digit month of year, e.g. 01, 12 * * `dd` - 2-digit day of month, e.g. 01, 31 * * `HH` - 2-digit hour of day (24h format), e.g. 00, 23 * * `hh` - 2-digit hour of day (12h format), e.g. 00, 11 * * `ii` - 2-digit minute of hour, e.g. 00, 59 * * `ss` - 2-digit second of minute, e.g. 00, 59 * * `MMM` - 3-letter-abbreviated month of year, e.g. "Jan", "Dec" * * `a` - Meridiem, e.g. "AM", "PM" * * `tz` - Timezone offset, e.g. "+01:00", "-07:00" * * @example * 'yyyy-mm-dd|hh-ii-ss' * 'MMM dd|hh:ii:ss' */ export type DateTimeFormat = string; export type DateTimeFormatOptions = { /** * A string that describes the format to use when turning a `Date` instance into a string. * * Available tokens: * * * `yyyy` - 4-digit year, e.g. 1970, 2023 * * `mm` - 2-digit month of year, e.g. 01, 12 * * `dd` - 2-digit day of month, e.g. 01, 31 * * `HH` - 2-digit hour of day (24h format), e.g. 00, 23 * * `hh` - 2-digit hour of day (12h format), e.g. 00, 11 * * `ii` - 2-digit minute of hour, e.g. 00, 59 * * `ss` - 2-digit second of minute, e.g. 00, 59 * * `MMM` - 3-letter-abbreviated month of year, e.g. "Jan", "Dec" * * `a` - Meridiem, e.g. "AM", "PM" * * `tz` - Timezone offset, e.g. "+01:00", "-07:00" * * @example * 'yyyy-mm-dd|hh-ii-ss' * 'MMM dd|hh:ii:ss' */ dateTimeFormat: DateTimeFormat; }; /** * Available tokens: * * * `yyyy` - 4-digit year, e.g. 1970, 2023 * * `mm` - 2-digit month of year, e.g. 01, 12 * * `dd` - 2-digit day of month, e.g. 01, 31 * * `HH` - 2-digit hour of day (24h format), e.g. 00, 23 * * `hh` - 2-digit hour of day (12h format), e.g. 00, 11 * * `ii` - 2-digit minute of hour, e.g. 00, 59 * * `ss` - 2-digit second of minute, e.g. 00, 59 * * `MMM` - 3-letter-abbreviated month of year, e.g. "Jan", "Dec" * * `a` - Meridiem, e.g. "AM", "PM" * * `tz` - Timezone offset, e.g. "+01:00", "-07:00" * * @example * 'yyyy-mm-ddThh:ii:ss' // E.g. 1970-01-01T23:59:59 (I.e. ISO 8601) * 'MMM dd hh:ii:ss' // E.g. Jan 01 23:59:59 */ export declare const formatDate: (date: Date, format: DateTimeFormat) => string;