Interface I18nextStatic

Index

Properties

Methods

Properties

public functions: { extend(target: any, ...objs: any[]): Object; extend(deep: boolean, target: any, ...objs: any[]): Object; each(collection: any, callback: (indexInArray: any, valueOfElement: any) => any): any; ajax(settings: JQueryAjaxSettings): JQueryXHR; ajax(url: string, settings?: JQueryAjaxSettings): JQueryXHR; cookie: { create: (name: string, value: string, minutes: number) => void; read: (name: string) => string; remove: (name: string) => void; }; detectLanguage(): string; log(message: string): void; toLanguages(language: string): string[]; regexEscape(str: string): string; }

public cookie.create: (name: string, value: string, minutes: number) => void

public cookie.read: (name: string) => string

public cookie.remove: (name: string) => void

public functions.cookie: { create: (name: string, value: string, minutes: number) => void; read: (name: string) => string; remove: (name: string) => void; }

public ajax(): JQueryXHR

Returns

JQueryXHR

.settings.settings: JQueryAjaxSettings

public ajax(): JQueryXHR

Returns

JQueryXHR

optional .settings.settings?: JQueryAjaxSettings

.url.url: string

public detectLanguage(): string

Returns

string

public each(): any

Returns

any

.callback.callback: (indexInArray: any, valueOfElement: any) => any

.collection.collection: any

public extend(): Object

Returns

Object

.deep.deep: boolean

optional .objs.objs?: Array<any>

.target.target: any

public extend(): Object

Returns

Object

optional .objs.objs?: Array<any>

.target.target: any

public log()

.message.message: string

public regexEscape(): string

Returns

string

.str.str: string

public toLanguages(): Array<string>

Returns

Array<string>

.language.language: string

public pluralExtensions: { addRule(language: string, obj: { name: string; numbers: number[]; plurals: (n: number) => number; }): void; get(language: string, count: number): number; rules: any; setCurrentLng: (language: string) => void; }

public pluralExtensions.rules: any

public pluralExtensions.setCurrentLng: (language: string) => void

public addRule()

.language.language: string

.obj.obj: { name: string; numbers: number[]; plurals: (n: number) => number; }

public obj.name: string

public obj.numbers: Array<number>

public obj.plurals: (n: number) => number

public get(): number

Returns

number

.count.count: number

.language.language: string

public sync: { load: (languages: string[], options: I18nextOptions, callback: (err: Error, store: IResourceStore) => void) => void; postMissing: (language: string, namespace: string, key: string, defaultValue: any, languages: string[]) => void; }

public sync.load: (languages: string[], options: I18nextOptions, callback: (err: Error, store: IResourceStore) => void) => void

public sync.postMissing: (language: string, namespace: string, key: string, defaultValue: any, languages: string[]) => void

Methods

public addPostProcessor(name: string, fn: (value: any, key: string, options: any) => string)

Parameters

  • name: string
  • fn: (value: any, key: string, options: any) => string

public detectLanguage(): string

Returns

string

public init(callback?: (t: (key: string, options?: any) => string) => void): JQueryDeferred

Parameters

  • callback?: (t: (key: string, options?: any) => string) => void optional

Returns

JQueryDeferred

public init(options?: I18nextOptions, callback?: (t: (key: string, options?: any) => string) => void): JQueryDeferred

Parameters

  • options?: I18nextOptions optional
  • callback?: (t: (key: string, options?: any) => string) => void optional

Returns

JQueryDeferred

public lng(): string

Returns

string

public loadNamespace(namespace: string, callback?: () => void)

Parameters

  • namespace: string
  • callback?: () => void optional

public loadNamespaces(namespaces: Array<string>, callback?: () => void)

Parameters

  • namespaces: Array<string>
  • callback?: () => void optional

public preload(language: string, callback?: (t: (key: string, options?: any) => string) => void)

Parameters

  • language: string
  • callback?: (t: (key: string, options?: any) => string) => void optional

public preload(languages: Array<string>, callback?: (t: (key: string, options?: any) => string) => void)

Parameters

  • languages: Array<string>
  • callback?: (t: (key: string, options?: any) => string) => void optional

public setDefaultNamespace(namespace: string)

Parameters

  • namespace: string

public setLng(language: string, callback?: (t: (key: string, options?: any) => string) => void)

Parameters

  • language: string
  • callback?: (t: (key: string, options?: any) => string) => void optional

public t(key: string, options?: any): string

Parameters

  • key: string
  • options?: any optional

Returns

string

public translate(key: string, options?: any): string

Parameters

  • key: string
  • options?: any optional

Returns

string