messageformat/lib/functions/index.js

Intl.MessageFormat / Unicode MessageFormat 2 parser, runtime and polyfill

/**
 * Implementations for :number, :string, and other default functions,
 * along with some utilities for building custom function handlers.
 *
 * ```js
 * import { MessageFormat } from 'messageformat';
 * import { DraftFunctions } from 'messageformat/functions';
 *
 * const mf = new MessageFormat(locale, msgSrc, { functions: DraftFunctions });
 * ```
 *
 * @module
 */
export { getLocaleDir } from "../dir-utils.js";
export { asBoolean, asPositiveInteger, asString } from "./utils.js";
import { currency } from "./currency.js";
import { date, datetime, time } from "./datetime.js";
import { integer, number } from "./number.js";
import { offset } from "./offset.js";
import { percent } from "./percent.js";
import { string } from "./string.js";
import { unit } from "./unit.js";
/**
 * Functions classified as REQUIRED by the
 * {@link https://www.unicode.org/reports/tr35/tr35-76/tr35-messageFormat.html#contents-of-part-9-messageformat | LDML 48 MessageFormat specification}.
 */
export let DefaultFunctions = {
    /**
     * Supports formatting and selection as defined in LDML 48 for the
     * {@link https://www.unicode.org/reports/tr35/tr35-76/tr35-messageFormat.html#the-integer-function | :integer function}.
     *
     * The `operand` must be a number, BigInt, or string representing a JSON number,
     * or an object wrapping such a value, with a `valueOf()` accessor and an optional `options` object.
     */
    integer,
    /**
     * Supports formatting and selection as defined in LDML 48 for the
     * {@link https://www.unicode.org/reports/tr35/tr35-76/tr35-messageFormat.html#the-number-function | :number function}.
     *
     * The `operand` must be a number, BigInt, or string representing a JSON number,
     * or an object wrapping such a value, with a `valueOf()` accessor and an optional `options` object.
     */
    number,
    /**
     * Supports formatting and selection as defined in LDML 48 for the
     * {@link https://www.unicode.org/reports/tr35/tr35-76/tr35-messageFormat.html#the-offset-function | :offset function}.
     *
     * The `operand` must be a number, BigInt, or string representing a JSON number,
     * or an object wrapping such a value, with a `valueOf()` accessor and an optional `options` object.
     */
    offset,
    /**
     * Supports formatting and selection as defined in LDML 48 for the
     * {@link https://www.unicode.org/reports/tr35/tr35-76/tr35-messageFormat.html#the-string-function | :string function}.
     *
     * The `operand` must be a stringifiable value.
     * An `undefined` value is resolved as an empty string.
     */
    string
};
DefaultFunctions = Object.freeze(Object.assign(Object.create(null), DefaultFunctions));
/**
 * Functions classified as DRAFT by the
 * {@link https://www.unicode.org/reports/tr35/tr35-76/tr35-messageFormat.html#contents-of-part-9-messageformat | LDML 48 MessageFormat specification}.
 *
 * These are liable to change, and are **_not_** covered by any stability guarantee.
 *
 * ```js
 * import { MessageFormat } from 'messageformat';
 * import { DraftFunctions } from 'messageformat/functions';
 *
 * const mf = new MessageFormat(locale, msgsrc, { functions: DraftFunctions });
 * ```
 *
 * @beta
 */
export let DraftFunctions = {
    /**
     * Supports formatting as defined in LDML 48 for the
     * {@link https://www.unicode.org/reports/tr35/tr35-76/tr35-messageFormat.html#the-currency-function | :currency function}.
     *
     * The `operand` must be a number, BigInt, or string representing a JSON number,
     * or an object wrapping such a value, with a `valueOf()` accessor and an optional `options` object.
     *
     * The `currency` option must be provided by either the operand's `options` or the `exprOpt` expression options.
     */
    currency,
    /**
     * Supports formatting as defined in LDML 48 for the
     * {@link https://www.unicode.org/reports/tr35/tr35-76/tr35-messageFormat.html#the-date-function | :date function}.
     *
     * The `operand` must be a Date, number, or string representing a date,
     * or an object wrapping such a value, with a `valueOf()` accessor and an optional `options` object.
     */
    date,
    /**
     * Supports formatting as defined in LDML 48 for the
     * {@link https://www.unicode.org/reports/tr35/tr35-76/tr35-messageFormat.html#the-datetime-function | :datetime function}.
     *
     * The `operand` must be a Date, number, or string representing a date,
     * or an object wrapping such a value, with a `valueOf()` accessor and an optional `options` object.
     */
    datetime,
    /**
     * Supports formatting as defined in LDML 48 for the
     * {@link https://www.unicode.org/reports/tr35/tr35-76/tr35-messageFormat.html#the-percent-function | :percent function}.
     *
     * The `operand` must be a number, BigInt, or string representing a JSON number,
     * or an object wrapping such a value, with a `valueOf()` accessor and an optional `options` object.
     */
    percent,
    /**
     * Supports formatting as defined in LDML 48 for the
     * {@link https://www.unicode.org/reports/tr35/tr35-76/tr35-messageFormat.html#the-time-function | :time function}.
     *
     * The `operand` must be a Date, number, or string representing a date,
     * or an object wrapping such a value, with a `valueOf()` accessor and an optional `options` object.
     */
    time,
    /**
     * Supports formatting as defined in LDML 48 for the
     * {@link https://www.unicode.org/reports/tr35/tr35-76/tr35-messageFormat.html#the-unit-function | :unit function}.
     *
     * The `operand` must be a number, BigInt, or string representing a JSON number,
     * or an object wrapping such a value, with a `valueOf()` accessor and an optional `options` object.
     *
     * The `unit` option must be provided by either the operand's `options` or the `exprOpt` expression options.
     */
    unit
};
DraftFunctions = Object.freeze(Object.assign(Object.create(null), DraftFunctions));