Interface LanguageDetectorAsyncModule

Used to detect language in user land. Can be provided as a singleton or as a prototype constructor (preferred for supporting multiple instances of i18next). For singleton set property type to 'languageDetector' For a prototype constructor set static property.

interface LanguageDetectorAsyncModule {
    async: true;
    type: "languageDetector";
    cacheUserLanguage?(lng): void | Promise<void>;
    detect(callback): void | Promise<string | readonly string[]>;
    init?(services, detectorOptions, i18nextOptions): void;
}

Hierarchy (view full)

  • Module
    • LanguageDetectorAsyncModule

Properties

async type

Methods

cacheUserLanguage? detect init?

Properties

async

async: true

Set to true to enable async detection

type

type: "languageDetector"

Methods

Optional cacheUserLanguage

  • cacheUserLanguage(lng): void | Promise<void>

  • Parameters

    • lng: string

    Returns void | Promise<void>

detect

  • detect(callback): void | Promise<string | readonly string[]>

  • Must call callback passing detected language or return a Promise

    Parameters

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

        • Parameters

          • lng: string | readonly string[]

          Returns void

    Returns void | Promise<string | readonly string[]>

Optional init

  • init(services, detectorOptions, i18nextOptions): void

  • Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

asynctypecacheUserLanguagedetectinit