47 lines
1.7 KiB
TypeScript
47 lines
1.7 KiB
TypeScript
import type { ISOFormatOptions } from "./types.js";
|
|
/**
|
|
* The {@link formatISO9075} function options.
|
|
*/
|
|
export interface FormatISO9075Options extends ISOFormatOptions {}
|
|
/**
|
|
* @name formatISO9075
|
|
* @category Common Helpers
|
|
* @summary Format the date according to the ISO 9075 standard (https://dev.mysql.com/doc/refman/5.7/en/date-and-time-functions.html#function_get-format).
|
|
*
|
|
* @description
|
|
* Return the formatted date string in ISO 9075 format. Options may be passed to control the parts and notations of the date.
|
|
*
|
|
* @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
|
|
*
|
|
* @param date - The original date
|
|
* @param options - An object with options.
|
|
*
|
|
* @returns The formatted date string
|
|
*
|
|
* @throws `date` must not be Invalid Date
|
|
*
|
|
* @example
|
|
* // Represent 18 September 2019 in ISO 9075 format:
|
|
* const result = formatISO9075(new Date(2019, 8, 18, 19, 0, 52))
|
|
* //=> '2019-09-18 19:00:52'
|
|
*
|
|
* @example
|
|
* // Represent 18 September 2019 in ISO 9075, short format:
|
|
* const result = formatISO9075(new Date(2019, 8, 18, 19, 0, 52), { format: 'basic' })
|
|
* //=> '20190918 190052'
|
|
*
|
|
* @example
|
|
* // Represent 18 September 2019 in ISO 9075 format, date only:
|
|
* const result = formatISO9075(new Date(2019, 8, 18, 19, 0, 52), { representation: 'date' })
|
|
* //=> '2019-09-18'
|
|
*
|
|
* @example
|
|
* // Represent 18 September 2019 in ISO 9075 format, time only:
|
|
* const result = formatISO9075(new Date(2019, 8, 18, 19, 0, 52), { representation: 'time' })
|
|
* //=> '19:00:52'
|
|
*/
|
|
export declare function formatISO9075<DateType extends Date>(
|
|
date: DateType | number | string,
|
|
options?: FormatISO9075Options,
|
|
): string;
|