12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364 |
- import { lightFormatters } from "./_lib/format/lightFormatters.js";
- import type { DateArg } from "./types.js";
- export { lightFormatters };
- /**
- * @name lightFormat
- * @category Common Helpers
- * @summary Format the date.
- *
- * @description
- * Return the formatted date string in the given format. Unlike `format`,
- * `lightFormat` doesn't use locales and outputs date using the most popular tokens.
- *
- * > ⚠️ Please note that the `lightFormat` tokens differ from Moment.js and other libraries.
- * > See: https://github.com/date-fns/date-fns/blob/master/docs/unicodeTokens.md
- *
- * The characters wrapped between two single quotes characters (') are escaped.
- * Two single quotes in a row, whether inside or outside a quoted sequence, represent a 'real' single quote.
- *
- * Format of the string is based on Unicode Technical Standard #35:
- * https://www.unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table
- *
- * Accepted patterns:
- * | Unit | Pattern | Result examples |
- * |---------------------------------|---------|-----------------------------------|
- * | AM, PM | a..aaa | AM, PM |
- * | | aaaa | a.m., p.m. |
- * | | aaaaa | a, p |
- * | Calendar year | y | 44, 1, 1900, 2017 |
- * | | yy | 44, 01, 00, 17 |
- * | | yyy | 044, 001, 000, 017 |
- * | | yyyy | 0044, 0001, 1900, 2017 |
- * | Month (formatting) | M | 1, 2, ..., 12 |
- * | | MM | 01, 02, ..., 12 |
- * | Day of month | d | 1, 2, ..., 31 |
- * | | dd | 01, 02, ..., 31 |
- * | Hour [1-12] | h | 1, 2, ..., 11, 12 |
- * | | hh | 01, 02, ..., 11, 12 |
- * | Hour [0-23] | H | 0, 1, 2, ..., 23 |
- * | | HH | 00, 01, 02, ..., 23 |
- * | Minute | m | 0, 1, ..., 59 |
- * | | mm | 00, 01, ..., 59 |
- * | Second | s | 0, 1, ..., 59 |
- * | | ss | 00, 01, ..., 59 |
- * | Fraction of second | S | 0, 1, ..., 9 |
- * | | SS | 00, 01, ..., 99 |
- * | | SSS | 000, 001, ..., 999 |
- * | | SSSS | ... |
- *
- * @param date - The original date
- * @param format - The string of tokens
- *
- * @returns The formatted date string
- *
- * @throws `Invalid time value` if the date is invalid
- * @throws format string contains an unescaped latin alphabet character
- *
- * @example
- * const result = lightFormat(new Date(2014, 1, 11), 'yyyy-MM-dd')
- * //=> '2014-02-11'
- */
- export declare function lightFormat(
- date: DateArg<Date> & {},
- formatStr: string,
- ): string;
|