Interface i18n

exists

format

isInitialized

language

languages

modules

options

Optional resolvedLanguage

services

store

t

addResource

• addResource(lng, ns, key, value, options?): i18n

• Adds one key/value.

  Parameters

  • lng: string

  • ns: string

  • key: string

  • value: string

  • Optional options: {
        keySeparator?: string;
        silent?: boolean;
    }

    Optional

    • Optional keySeparator?: string

    • Optional silent?: boolean

  Returns i18n

addResourceBundle

• addResourceBundle(lng, ns, resources, deep?, overwrite?): i18n

• Adds a complete bundle. Setting deep param to true will extend existing translations in that file. Setting overwrite to true it will overwrite existing translations in that file.

  Parameters

  • lng: string

  • ns: string

  • resources: any

  • Optional deep: boolean

    Optional

  • Optional overwrite: boolean

    Optional

  Returns i18n

addResources

• addResources(lng, ns, resources): i18n

• Adds multiple key/values.

  Parameters

  • lng: string

  • ns: string

  • resources: any

  Returns i18n

changeLanguage

• changeLanguage(lng?, callback?): Promise<TFunction<"translation", undefined>>

• Changes the language. The callback will be called as soon translations were loaded or an error occurs while loading. HINT: For easy testing - setting lng to 'cimode' will set t function to always return the key.

  Parameters

  • Optional lng: string

    Optional

  • Optional callback: Callback

    Optional

  Returns Promise<TFunction<"translation", undefined>>

cloneInstance

• cloneInstance(options?, callback?): i18n

• Creates a clone of the current instance. Shares store, plugins and initial configuration. Can be used to create an instance sharing storage but being independent on set language or namespaces.

  Parameters

  • Optional options: CloneOptions

    Optional

  • Optional callback: Callback

    Optional

  Returns i18n

createInstance

• createInstance(options?, callback?): i18n

• Will return a new i18next instance. Please read the options page for details on configuration options. Providing a callback will automatically call init. The callback will be called after all translations were loaded or with an error when failed (in case of using a backend).

  Parameters

  • Optional options: InitOptions<object>

    Optional

  • Optional callback: Callback

    Optional

  Returns i18n

dir

• dir(lng?): "ltr" | "rtl"

• Returns rtl or ltr depending on languages read direction.

  Parameters

  • Optional lng: string

    Optional

  Returns "ltr" | "rtl"

emit

• emit(eventName, ...args): void

• Emit event

  Parameters

  • eventName: string

  • Rest ...args: any[]

    Rest

  Returns void

getDataByLanguage

• getDataByLanguage(lng): {
      [key: string]: {
          [key: string]: string;
      };
  }

• Returns a resource data by language.

  Parameters

  • lng: string

  Returns {
      [key: string]: {
          [key: string]: string;
      };
  }

  • [key: string]: {
        [key: string]: string;
    }

    • [key: string]: string

getFixedT

• getFixedT<Ns, TKPrefix, ActualNs>(...args): TFunction<ActualNs, TKPrefix>

• Returns a t function that defaults to given language or namespace. Both params could be arrays of languages or namespaces and will be treated as fallbacks in that case. On the returned function you can like in the t function override the languages or namespaces by passing them in options or by prepending namespace.

  Accepts optional keyPrefix that will be automatically applied to returned t function.

  Type Parameters

  • Ns extends Namespace = "translation"

  • TKPrefix extends string = undefined

  • ActualNs extends Namespace = Ns extends null
        ? "translation"
        : Ns

  Parameters

  • Rest ...args: [lng: string | readonly string[], ns?: Ns, keyPrefix?: TKPrefix] | [lng: null, ns: Ns, keyPrefix?: TKPrefix]

    Rest

  Returns TFunction<ActualNs, TKPrefix>

getResource

• getResource(lng, ns, key, options?): any

• Gets one value by given key.

  Parameters

  • lng: string

  • ns: string

  • key: string

  • Optional options: Pick<InitOptions<object>, "keySeparator" | "ignoreJSONStructure">

    Optional

  Returns any

getResourceBundle

• getResourceBundle(lng, ns): any

• Returns a resource bundle.

  Parameters

  • lng: string

  • ns: string

  Returns any

hasLoadedNamespace

• hasLoadedNamespace(ns, options?): boolean

• Checks if namespace has loaded yet. i.e. used by react-i18next

  Parameters

  • ns: string | readonly string[]

  • Optional options: {
        lng?: string | readonly string[];
        precheck: ((i18n, loadNotPending) => boolean);
    }

    Optional

    • Optional lng?: string | readonly string[]

    • precheck: ((i18n, loadNotPending) => boolean)

      • • (i18n, loadNotPending): boolean

        • Parameters

          • i18n: i18n

          • loadNotPending: ((lng, ns) => boolean)

            • • (lng, ns): boolean

              • Parameters

                • lng: string | readonly string[]

                • ns: string | readonly string[]

                Returns boolean

          Returns boolean

  Returns boolean
• hasLoadedNamespace(ns, options?): boolean

• Checks if a namespace has been loaded.

  Parameters

  • ns: string

  • Optional options: Pick<InitOptions<object>, "fallbackLng">

    Optional

  Returns boolean

hasResourceBundle

• hasResourceBundle(lng, ns): boolean

• Checks if a resource bundle exists.

  Parameters

  • lng: string

  • ns: string

  Returns boolean

init

• init(callback?): Promise<TFunction<"translation", undefined>>

• The default of the i18next module is an i18next instance ready to be initialized by calling init. You can create additional instances using the createInstance function.

  Parameters

  • Optional callback: Callback

    will be called after all translations were loaded or with an error when failed (in case of using a backend).

    Optional

  Returns Promise<TFunction<"translation", undefined>>
• init<T>(options, callback?): Promise<TFunction<"translation", undefined>>

• Type Parameters

  • T

  Parameters

  • options: InitOptions<T>

  • Optional callback: Callback

    Optional

  Returns Promise<TFunction<"translation", undefined>>

loadLanguages

• loadLanguages(lngs, callback?): Promise<void>

• Loads additional languages not defined in init options (preload).

  Parameters

  • lngs: string | readonly string[]

  • Optional callback: Callback

    Optional

  Returns Promise<void>

loadNamespaces

• loadNamespaces(ns, callback?): Promise<void>

• Loads additional namespaces not defined in init options.

  Parameters

  • ns: string | readonly string[]

  • Optional callback: Callback

    Optional

  Returns Promise<void>

loadResources

• loadResources(callback?): void

• Parameters

  • Optional callback: ((err) => void)

    Optional
    • • (err): void

      • Parameters

        • err: any

        Returns void

  Returns void

off

• off(event, listener?): void

• Remove event listener removes all callback when callback not specified

  Parameters

  • event: string

  • Optional listener: ((...args) => void)

    Optional
    • • (...args): void

      • Parameters

        • Rest ...args: any[]

          Rest

        Returns void

  Returns void

on

• on(event, callback): void

• Gets fired after initialization.

  Parameters

  • event: "initialized"

  • callback: ((options) => void)

    • • (options): void

      • Parameters

        • options: InitOptions<object>

        Returns void

  Returns void
• on(event, callback): void

• Gets fired on loaded resources.

  Parameters

  • event: "loaded"

  • callback: ((loaded) => void)

    • • (loaded): void

      • Parameters

        • loaded: {
              [language: string]: {
                  [namespace: string]: boolean;
              };
          }

          • [language: string]: {
                [namespace: string]: boolean;
            }

            • [namespace: string]: boolean

        Returns void

  Returns void
• on(event, callback): void

• Gets fired if loading resources failed.

  Parameters

  • event: "failedLoading"

  • callback: ((lng, ns, msg) => void)

    • • (lng, ns, msg): void

      • Parameters

        • lng: string

        • ns: string

        • msg: string

        Returns void

  Returns void
• on(event, callback): void

• Gets fired on accessing a key not existing.

  Parameters

  • event: "missingKey"

  • callback: ((lngs, namespace, key, res) => void)

    • • (lngs, namespace, key, res): void

      • Parameters

        • lngs: readonly string[]

        • namespace: string

        • key: string

        • res: string

        Returns void

  Returns void
• on(event, callback): void

• Gets fired when resources got added or removed.

  Parameters

  • event: "added" | "removed"

  • callback: ((lng, ns) => void)

    • • (lng, ns): void

      • Parameters

        • lng: string

        • ns: string

        Returns void

  Returns void
• on(event, callback): void

• Gets fired when changeLanguage got called.

  Parameters

  • event: "languageChanged"

  • callback: ((lng) => void)

    • • (lng): void

      • Parameters

        • lng: string

        Returns void

  Returns void
• on(event, listener): void

• Event listener

  Parameters

  • event: string

  • listener: ((...args) => void)

    • • (...args): void

      • Parameters

        • Rest ...args: any[]

          Rest

        Returns void

  Returns void

reloadResources

• reloadResources(lngs?, ns?, callback?): Promise<void>

• Reloads resources on given state. Optionally you can pass an array of languages and namespaces as params if you don't want to reload all.

  Parameters

  • Optional lngs: string | readonly string[]

    Optional

  • Optional ns: string | readonly string[]

    Optional

  • Optional callback: (() => void)

    Optional
    • • (): void

      • Returns void

  Returns Promise<void>
• reloadResources(lngs, ns, callback?): Promise<void>

• Parameters

  • lngs: null

  • ns: string | readonly string[]

  • Optional callback: (() => void)

    Optional
    • • (): void

      • Returns void

  Returns Promise<void>

removeResourceBundle

• removeResourceBundle(lng, ns): i18n

• Removes an existing bundle.

  Parameters

  • lng: string

  • ns: string

  Returns i18n

setDefaultNamespace

• setDefaultNamespace(ns): void

• Changes the default namespace.

  Parameters

  • ns: string

  Returns void

use

• use<T>(module): i18n

• The use function is there to load additional plugins to i18next. For available module see the plugins page and don't forget to read the documentation of the plugin.

  Type Parameters

  • T extends Module

  Parameters

  • module: T | NewableModule<T> | Newable<T>

    Accepts a class or object

  Returns i18n