Unicode MessageFormat for JavaScript
    Preparing search index...

    Interface MessageFormatOptions<T, P>

    interface MessageFormatOptions<T extends string = never, P extends string = T> {
        bidiIsolation?: "default" | "none";
        dir?: "ltr" | "rtl" | "auto";
        functions?: Record<string, MessageFunction<T, P>>;
        localeMatcher?: "best fit" | "lookup";
    }

    Type Parameters

    • T extends string = never

      The type used by custom message functions, if any. These extend the default functions.

    • P extends string = T

      The formatted-parts type used by any custom message values.

    Index

    Properties

    bidiIsolation? dir? functions? localeMatcher?

    Properties

    bidiIsolation?: "default" | "none"

    The bidi isolation strategy for message formatting, i.e. how expression placeholders with different or unknown directionalities are isolated from the rest of the formatted message.

    The default 'default' strategy isolates all expression placeholders, except when both the message and the placeholder are known to be left-to-right.

    The 'none' strategy applies no isolation at all.

    dir?: "ltr" | "rtl" | "auto"

    Explicitly set the message's base direction. If not set, the direction is detected from the primary locale.

    functions?: Record<string, MessageFunction<T, P>>

    A set of custom functions to make available during message resolution. Extends the default functions.

    localeMatcher?: "best fit" | "lookup"

    If given multiple locales, determines which algorithm to use when selecting between them; the default for Intl formatters is 'best fit'.

    The locale is resolved separately by each message function handler call.

    See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locale_negotiation

    Settings

    Member Visibility

    On This Page

    Properties