Interface BackendModule<TOptions>

Used to load data for i18next. Can be provided as a singleton or as a prototype constructor (preferred for supporting multiple instances of i18next). For singleton set property type to 'backend' For a prototype constructor set static property.

interface BackendModule<TOptions> {
    type: "backend";
    create?(languages, namespace, key, fallbackValue): void;
    init(services, backendOptions, i18nextOptions): void;
    read(language, namespace, callback): void;
    readMulti?(languages, namespaces, callback): void;
    save?(language, namespace, data): void;
}

Type Parameters

  • TOptions = object

Hierarchy (view full)

Properties

type

Methods

create? init read readMulti? save?

Properties

type

type: "backend"

Methods

Optional create

  • create(languages, namespace, key, fallbackValue): void

  • Save the missing translation

    Parameters

    • languages: readonly string[]
    • namespace: string
    • key: string
    • fallbackValue: string

    Returns void

init

  • init(services, backendOptions, i18nextOptions): void

  • Parameters

    Returns void

read

  • read(language, namespace, callback): void

  • Parameters

    Returns void

Optional readMulti

  • readMulti(languages, namespaces, callback): void

  • Load multiple languages and namespaces. For backends supporting multiple resources loading

    Parameters

    Returns void

Optional save

  • save(language, namespace, data): void

  • Store the translation. For backends acting as cache layer

    Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

typecreateinitreadreadMultisave