Files
vanillajs-seed/node_modules/i18next-browser-languagedetector/index.d.ts
2019-12-20 20:02:44 +01:00

70 lines
1.5 KiB
TypeScript

import * as i18next from "i18next";
interface DetectorOptions {
/**
* order and from where user language should be detected
*/
order?: Array<
"querystring" | "cookie" | "localStorage" | "navigator" | "htmlTag" | string
>;
/**
* keys or params to lookup language from
*/
lookupQuerystring?: string;
lookupCookie?: string;
lookupLocalStorage?: string;
/**
* cache user language on
*/
caches?: string[];
/**
* languages to not persist (cookie, localStorage)
*/
excludeCacheFor?: string[];
/**
* optional expire and domain for set cookie
* @default 10
*/
cookieMinutes?: number;
cookieDomain?: string;
/**
* optional htmlTag with lang attribute
* @default document.documentElement
*/
htmlTag?: HTMLElement | null;
}
interface CustomDetector {
name: string;
cacheUserLanguage?(lng: string, options: DetectorOptions): void;
lookup(options: DetectorOptions): string | undefined;
}
export default class I18nextBrowserLanguageDetector
implements i18next.LanguageDetectorModule {
constructor(services?: any, options?: DetectorOptions);
/**
* Adds detector.
*/
addDetector(detector: CustomDetector): I18nextBrowserLanguageDetector;
/**
* Initializes detector.
*/
init(services?: any, options?: DetectorOptions): void;
detect(detectionOrder?: DetectorOptions["order"]): string | undefined;
cacheUserLanguage(lng: string, caches?: string[]): void;
type: "languageDetector";
detectors: { [key: string]: any };
services: any;
i18nOptions: any;
}