A parser & formatter for ICU DateFormat skeleton strings

Package: @messageformat/date-skeleton

Created by: messageformat

Last modified: Sat, 16 Jul 2022 18:41:44 GMT

Version: 1.0.1

License: MIT

Downloads: 1,444,306

Repository: https://github.com/messageformat/messageformat

Install

npm install @messageformat/date-skeleton

yarn add @messageformat/date-skeleton

@messageformat/date-skeleton

Tools for working with ICU DateFormat skeletons.

 import {
  DateFormatError,
  DateToken, // TS only
  getDateFormatter,
  getDateFormatterSource,
  parseDateTokens
} from '@messageformat/date-skeleton';

The package is released as an ES module only. If using from a CommonJS context, you may need to import() it, or use a module loader like esm.

Uses Intl.DateTimeFormat internally. Position-dependent ICU DateFormat patterns are not supported, as they cannot be represented with Intl.DateTimeFormat options.

Classes

Class	Description
DateFormatError	Parent class for errors.

Functions

Function	Description
getDateFormatter(locales, tokens, onError)	Returns a date formatter function for the given locales and date skeleton
getDateFormatterSource(locales, tokens, onError)	Returns a string of JavaScript source that evaluates to a date formatter function with the same `(date: Date \| number) => string` signature as the function returned by getDateFormatter().
parseDateTokens(src)	Parse an ICU DateFormat skeleton string into a DateToken array.