Class I18n

Constructors

constructor

Accessors

i18next language ns t

Methods

detectBrowserLanguage languageToLocale loadFilesystemResources localeToLanguage setLanguage

Constructors

constructor

  • new I18n(_options?: InitOptions<object> & { fsTranslationsPath?: string }): I18n

  • Parameters

    • Optional_options: InitOptions<object> & { fsTranslationsPath?: string }

    Returns I18n

Accessors

i18next

language

ns

  • get ns(): {
        common: TFunction<"translation", undefined>;
        coreutils: TFunction<"translation", undefined>;
        filesystem: TFunction<"translation", undefined>;
        kernel: TFunction<"translation", undefined>;
        terminal: TFunction<"translation", undefined>;
    }

  • Returns {
        common: TFunction<"translation", undefined>;
        coreutils: TFunction<"translation", undefined>;
        filesystem: TFunction<"translation", undefined>;
        kernel: TFunction<"translation", undefined>;
        terminal: TFunction<"translation", undefined>;
    }

t

  • get t(): TFunction<["translation", ...string[]], undefined>

  • Returns TFunction<["translation", ...string[]], undefined>

Methods

detectBrowserLanguage

  • detectBrowserLanguage(): string

  • Detects the browser language using the language detector Returns the detected language code (e.g., 'en', 'es')

    Returns string

languageToLocale

  • languageToLocale(language: string): string

  • Converts a language code to a locale string Examples: 'en' -> 'en_US', 'es' -> 'es_ES' Falls back to language code if no region mapping exists

    Parameters

    • language: string

    Returns string

loadFilesystemResources

  • loadFilesystemResources(
        fs: I18nFilesystemAdapter,
        rootPath?: string,
    ): Promise<I18nResourceLoadResult>

  • Parameters

    • fs: I18nFilesystemAdapter
    • OptionalrootPath: string

    Returns Promise<I18nResourceLoadResult>

localeToLanguage

  • localeToLanguage(locale: string): string

  • Converts a locale string to a language code Examples: 'en_US' -> 'en', 'es_ES' -> 'es', 'en' -> 'en'

    Parameters

    • locale: string

    Returns string

setLanguage

  • setLanguage(locale: string): void

  • Sets the language for i18next

    Parameters

    • locale: string

      Locale string (e.g., 'en_US', 'es_ES', 'en', 'es')

    Returns void

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods