Class Translator

Hierarchy

  • Translator

Constructors

constructor

Properties

formatter translations

Methods

addTranslations formatterTypeHandlers getLocale preprocessParameters setLocale trans

Constructors

constructor

Properties

Protected formatter

formatter: RichMessageFormatter = ...

The underlying ICU MessageFormatter util.

translations

translations: Translations = {}

A map of translation keys to their translated values.

Methods

addTranslations

Protected formatterTypeHandlers

  • An extensible entrypoint for extenders to register type handlers for translations.

    Returns {
        plural: ((value: string, matches: string, locale: string, values: Record<string, any>, format: ((text: string, values: Record<string, any>) => string)) => string);
        select: ((value: string, matches: string, locale: string, values: Record<string, any>, format: ((text: string, values: Record<string, any>) => string)) => string);
    }

    • plural: ((value: string, matches: string, locale: string, values: Record<string, any>, format: ((text: string, values: Record<string, any>) => string)) => string)
        • (value: string, matches: string, locale: string, values: Record<string, any>, format: ((text: string, values: Record<string, any>) => string)): string

        • Parameters

          • value: string
          • matches: string
          • locale: string
          • values: Record<string, any>
          • format: ((text: string, values: Record<string, any>) => string)
              • (text: string, values: Record<string, any>): string

              • Parameters

                • text: string
                • values: Record<string, any>

                Returns string

          Returns string

    • select: ((value: string, matches: string, locale: string, values: Record<string, any>, format: ((text: string, values: Record<string, any>) => string)) => string)
        • (value: string, matches: string, locale: string, values: Record<string, any>, format: ((text: string, values: Record<string, any>) => string)): string

        • Parameters

          • value: string
          • matches: string
          • locale: string
          • values: Record<string, any>
          • format: ((text: string, values: Record<string, any>) => string)
              • (text: string, values: Record<string, any>): string

              • Parameters

                • text: string
                • values: Record<string, any>

                Returns string

          Returns string

getLocale

Protected preprocessParameters

setLocale

  • Sets the formatter's locale to the provided value.

    Parameters

    • locale: string

    Returns void

trans

Settings

Member Visibility

Theme

Generated using TypeDoc v0.23.24