ng2-translate

property templateMatcher

templateMatcher: RegExp;

method getValue

getValue: (target: any, key: string) => string;

method interpolate

interpolate: (expr: string, params?: any) => string;

method handle

abstract handle: (params: MissingTranslationHandlerParams) => any;

• A function that handles missing translations.

  Parameter params

  context for resolving a missing translation

  Returns

  {any} a value or an observable If it returns a value, then this value is used. If it return an observable, the value returned by this observable will be used (except if the method was "instant"). If it doesn't return then the key will be used as a value

constructor

constructor(translateService: TranslateService, element: ElementRef);

property key

key: string;

property lastParams

lastParams: any;

property onDefaultLangChangeSub

onDefaultLangChangeSub: Subscription;

property onLangChangeSub

onLangChangeSub: Subscription;

property onTranslationChangeSub

onTranslationChangeSub: Subscription;

property translate

translate: string;

property translateParams

translateParams: any;

method checkNodes

checkNodes: (forceUpdate?: boolean, translations?: any) => void;

method ngAfterViewChecked

ngAfterViewChecked: () => void;

method ngOnDestroy

ngOnDestroy: () => void;

method updateValue

updateValue: (key: string, node: any, translations: any) => void;

method getTranslation

abstract getTranslation: (lang: string) => Observable<any>;

method forRoot

static forRoot: (providedLoader?: any) => ModuleWithProviders;

method getValue

abstract getValue: (target: any, key: string) => string;

• Gets a value from an object by composed key parser.getValue({ key1: { keyA: 'valueI' }}, 'key1.keyA') ==> 'valueI'

  Parameter target

  Parameter key

  Returns

  {string}

method interpolate

abstract interpolate: (expr: string, params?: any) => string;

• Interpolates a string to replace parameters "This is a {{ key }}" ==> "This is a value", with params = { key: "value" }

  Parameter expr

  Parameter params

  Returns

  {string}

constructor

constructor(translate: TranslateService, _ref: ChangeDetectorRef);

property lastKey

lastKey: string;

property lastParams

lastParams: any[];

property onDefaultLangChange

onDefaultLangChange: EventEmitter<DefaultLangChangeEvent>;

property onLangChange

onLangChange: EventEmitter<LangChangeEvent>;

property onTranslationChange

onTranslationChange: EventEmitter<TranslationChangeEvent>;

property value

value: string;

method ngOnDestroy

ngOnDestroy: () => void;

method transform

transform: (query: string, ...args: any[]) => any;

method updateValue

updateValue: (
    key: string,
    interpolateParams?: Object,
    translations?: any
) => void;

constructor

constructor(
    currentLoader: TranslateLoader,
    parser: TranslateParser,
    missingTranslationHandler: MissingTranslationHandler
);

• Parameter currentLoader

  An instance of the loader currently used

  Parameter parser

  An instance of the parser currently used

  Parameter missingTranslationHandler

  A handler for missing translations.

property currentLang

currentLang: string;

• The lang currently used

property currentLoader

currentLoader: TranslateLoader;

property onDefaultLangChange

onDefaultLangChange: EventEmitter<DefaultLangChangeEvent>;

• An EventEmitter to listen to default lang change events onDefaultLangChange.subscribe((params: DefaultLangChangeEvent) => { // do something }); {EventEmitter}

property onLangChange

onLangChange: EventEmitter<LangChangeEvent>;

• An EventEmitter to listen to lang change events onLangChange.subscribe((params: LangChangeEvent) => { // do something }); {EventEmitter}

property onTranslationChange

onTranslationChange: EventEmitter<TranslationChangeEvent>;

• An EventEmitter to listen to translation change events onTranslationChange.subscribe((params: TranslationChangeEvent) => { // do something }); {EventEmitter}

property parser

parser: TranslateParser;

method addLangs

addLangs: (langs: Array<string>) => void;

• Parameter langs

  Add available langs

method get

get: (
    key: string | Array<string>,
    interpolateParams?: Object
) => Observable<any>;

• Gets the translated value of a key (or an array of keys)

  Parameter key

  Parameter interpolateParams

  Returns

  {any} the translated key, or an object of translated keys

method getBrowserCultureLang

getBrowserCultureLang: () => string;

• Returns the culture language code name from the browser, e.g. "de-DE"

  Returns

  string

method getBrowserLang

getBrowserLang: () => string;

• Returns the language code name from the browser, e.g. "de"

  Returns

  string

method getDefaultLang

getDefaultLang: () => string;

• Gets the default language used

  Returns

  string

method getLangs

getLangs: () => Array<string>;

• Returns an array of currently available langs

  Returns

  {any}

method getParsedResult

getParsedResult: (
    translations: any,
    key: any,
    interpolateParams?: Object
) => any;

• Returns the parsed result of the translations

  Parameter translations

  Parameter key

  Parameter interpolateParams

  Returns

  {any}

method getTranslation

getTranslation: (lang: string) => Observable<any>;

• Gets an object of translations for a given language with the current loader

  Parameter lang

  Returns

  {Observable<*>}

method instant

instant: (
    key: string | Array<string>,
    interpolateParams?: Object
) => string | any;

• Returns a translation instantly from the internal state of loaded translation. All rules regarding the current language, the preferred language of even fallback languages will be used except any promise handling.

  Parameter key

  Parameter interpolateParams

  Returns

  {string}

method reloadLang

reloadLang: (lang: string) => Observable<any>;

• Allows to reload the lang file from the file

  Parameter lang

  Returns

  {Observable}

method resetLang

resetLang: (lang: string) => void;

• Deletes inner translation

  Parameter lang

method set

set: (key: string, value: string, lang?: string) => void;

• Sets the translated value of a key

  Parameter key

  Parameter value

  Parameter lang

method setDefaultLang

setDefaultLang: (lang: string) => void;

• Sets the default language to use as a fallback

  Parameter lang

method setTranslation

setTranslation: (
    lang: string,
    translations: Object,
    shouldMerge?: boolean
) => void;

• Manually sets an object of translations for a given language

  Parameter lang

  Parameter translations

  Parameter shouldMerge

method use

use: (lang: string) => Observable<any>;

• Changes the lang currently used

  Parameter lang

  Returns

  {Observable<*>}

constructor

constructor(http: Http, prefix?: string, suffix?: string);

method getTranslation

getTranslation: (lang: string) => Observable<any>;

• Gets the translations from the server

  Parameter lang

  Returns

  {any}

property lang

lang: string;

property translations

translations: any;

property lang

lang: string;

property translations

translations: any;

property interpolateParams

interpolateParams?: Object;

• interpolation params that were passed along for translating the given key.

  {Object}

property key

key: string;

• the key that's missing in translation files

  {string}

property translateService

translateService: TranslateService;

• an instance of the service that was unable to translate the key.

  {TranslateService}

property lang

lang: string;

property translations

translations: any;