Class I18n

Hierarchy

  • I18n

Constructors

constructor

Properties

fetcher? lang$ locale$ locales$ t$

Accessors

lang locale locales t

Methods

addLocale dispose hasKey switchLang preload

Constructors

constructor

Properties

Optional fetcher

fetcher?: LocaleFetcher

Fetch locale of the specified lang.

Readonly lang$

lang$: ReadonlyVal<string>

A Val of current lang.

Readonly locale$

locale$: ReadonlyVal<Locale>

A Val of current locale.

Readonly locales$

locales$: Val<Locales>

A Val of all loaded locales.

Readonly t$

t$: ReadonlyVal<TFunction>

A Val of current translate function.

Accessors

lang

  • get lang(): string

  • Current lang.

    Returns string

locale

locales

t

Methods

addLocale

  • Add a locale to the locales.

    Use i18n.locales$.set() for more control.

    Parameters

    Returns void

dispose

hasKey

  • Returns

    — boolean indicating whether a message with the specified key in current language exists or not.

    Parameters

    • key: string

    Returns boolean

switchLang

  • Change language.

    Returns

    — a promise that resolves when the new locale is fetched.

    Parameters

    • lang: string

    Returns Promise<void>

Static preload

  • Fetch locale of initialLang and return an I18n instance with the locale.

    Parameters

    Returns Promise<I18n>

Settings

Theme