12345678910111213141516171819202122232425262728293031323334353637383940414243444546 |
- import type { ContextOptions, DateArg, ISOFormatOptions } from "./types.js";
- /**
- * The {@link formatISO} function options.
- */
- export interface FormatISOOptions
- extends ISOFormatOptions,
- ContextOptions<Date> {}
- /**
- * @name formatISO
- * @category Common Helpers
- * @summary Format the date according to the ISO 8601 standard (https://support.sas.com/documentation/cdl/en/lrdict/64316/HTML/default/viewer.htm#a003169814.htm).
- *
- * @description
- * Return the formatted date string in ISO 8601 format. Options may be passed to control the parts and notations of the date.
- *
- * @param date - The original date
- * @param options - An object with options.
- *
- * @returns The formatted date string (in local time zone)
- *
- * @throws `date` must not be Invalid Date
- *
- * @example
- * // Represent 18 September 2019 in ISO 8601 format (local time zone is UTC):
- * const result = formatISO(new Date(2019, 8, 18, 19, 0, 52))
- * //=> '2019-09-18T19:00:52Z'
- *
- * @example
- * // Represent 18 September 2019 in ISO 8601, short format (local time zone is UTC):
- * const result = formatISO(new Date(2019, 8, 18, 19, 0, 52), { format: 'basic' })
- * //=> '20190918T190052'
- *
- * @example
- * // Represent 18 September 2019 in ISO 8601 format, date only:
- * const result = formatISO(new Date(2019, 8, 18, 19, 0, 52), { representation: 'date' })
- * //=> '2019-09-18'
- *
- * @example
- * // Represent 18 September 2019 in ISO 8601 format, time only (local time zone is UTC):
- * const result = formatISO(new Date(2019, 8, 18, 19, 0, 52), { representation: 'time' })
- * //=> '19:00:52Z'
- */
- export declare function formatISO(
- date: DateArg<Date> & {},
- options?: FormatISOOptions,
- ): string;
|