Function fluentToResource

  • fluentToResource(
        locales: undefined | string | string[],
        source: string | FluentMessageResourceData | Resource,
        options?: MessageFormatOptions<never, never> & {
            detectNumberSelection?: boolean;
        },
    ): FluentMessageResource

    Compile a Fluent resource (i.e. an FTL file) into a Map of MessageFormat instances.

    Uses DraftFunctions.currency, DraftFunctions.unit, as well as a custom fluent:message function provided by getMessageFunction.

    Parameters

    • locales: undefined | string | string[]

      The locale code or codes to use for all of the resource's messages.

    • source: string | FluentMessageResourceData | Resource

      A Fluent resource, as the string contents of an FTL file, as a Fluent.Resource, or in the shape output by fluentToResourceData as data.

    • Optionaloptions: MessageFormatOptions<never, never> & { detectNumberSelection?: boolean }

      The MessageFormat constructor options to use for all of the resource's messages.

      • OptionalbidiIsolation?: "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.

      • Optionaldir?: "ltr" | "rtl" | "auto"

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

      • Optionalfunctions?: Record<string, MessageFunction<T, P>>

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

      • OptionallocaleMatcher?: "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

      • OptionaldetectNumberSelection?: boolean

        Set false to disable number selector detection based on keys.

    Returns FluentMessageResource

Settings

Member Visibility