Class I18n

constructor

• new I18n(initialLang, locales, options?): I18n

• Parameters

  • initialLang: string
  • locales: Locales
  • Optionaloptions: I18nOptions

  Returns I18n

Optionalfetcher

Readonlylang$

Readonlylocale$

Readonlylocales$

Readonlyt$

lang

• get lang(): string

• Current lang.

  Returns string

locale

• get locale(): Locale

• Current locale

  Returns Locale

locales

• get locales(): Locales

• All loaded locales.

  Returns Locales

t

• get t(): TFunction

• Current translate function.

  Returns TFunction

addLocale

• addLocale(lang, locale): void

• Add a locale to the locales.

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

  Parameters

  • lang: string
  • locale: Locale

  Returns void

dispose

• dispose(): void

• Returns void

hasKey

• hasKey(key): boolean

• Parameters

  • key: string

  Returns boolean

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

switchLang

• switchLang(lang): Promise<void>

• Change language.

  Parameters

  • lang: string

  Returns Promise<void>

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

Staticpreload

• preload(initialLang, fetcher): Promise<I18n>

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

  Parameters

  • initialLang: string
  • fetcher: LocaleFetcher

  Returns Promise<I18n>