UNPKG

@burglekitt/gmt

Version:

Temporal-based date and time utilities with timezone support and polyfill integration

github.com/burglekitt/gmt

burglekitt/gmt

29 lines (28 loc) • 2.1 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
/** * Return the locale-formatted parts of a PlainDateTime. * * - This is GMT's substitute for a token formatter (Luxon `toFormat`, date-fns * `format`). A token pattern hard-codes field order and ships US ordering to * every locale; `formatToParts` gives the caller full control over presentation * while the *locale* keeps control of order. See Decision 1 in * `context/roadmap/issues/J.md`. * - Each part is `{ type, value }` where `type` can be: * `"era"`, `"year"`, `"month"`, `"day"`, `"weekday"`, `"hour"`, * `"minute"`, `"second"`, `"fractionalSecond"`, `"dayPeriod"`, `"literal"`. * - The caller should iterate the array as returned; reassembling in a fixed * order reintroduces exactly the bug `formatToParts` exists to avoid. * - Returns `[]` for invalid input. * * @param value ISO PlainDateTime string * @param locale optional BCP 47 locale identifier * @param options optional Intl.DateTimeFormatOptions * @returns array of `{ type, value }` parts, or `[]` on invalid input * * @example formatDateTimeToParts("2024-03-15T14:30:00", "en-US") // [{ type: "month", value: "3" }, { type: "literal", value: "/" }, { type: "day", value: "15" }, { type: "literal", value: "/" }, { type: "year", value: "2024" }, { type: "literal", value: "," }, { type: "literal", value: " " }, { type: "hour", value: "2" }, { type: "literal", value: ":" }, { type: "minute", value: "30" }, { type: "literal", value: " " }, { type: "dayPeriod", value: "PM" }] * @example formatDateTimeToParts("2024-03-15T14:30:00", "de-DE") // [{ type: "day", value: "15" }, { type: "literal", value: "." }, { type: "month", value: "3" }, { type: "literal", value: "." }, { type: "year", value: "2024" }, { type: "literal", value: "," }, { type: "literal", value: " " }, { type: "hour", value: "14" }, { type: "literal", value: ":" }, { type: "minute", value: "30" }] * @example formatDateTimeToParts("invalid") // [] */ export declare function formatDateTimeToParts(value: string, locale?: string, options?: Intl.DateTimeFormatOptions): Array<{ type: string; value: string; }>;