Class Translator

Hierarchy

Translator

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Translator(): Translator

- Defined in translator.service.ts:23
Create a new translator.

Returns Translator

Properties

Private availableLanguages

availableLanguages: string[] = []

Private currentLanguage

currentLanguage: string

Private translationEmitter

translationEmitter: Subject<object> = new Subject<translation>()

Private translations

translations: object

Type declaration

[key: string]: translation

Methods

addTranslation

addTranslation(language: string, translation: any): void

- Defined in translator.service.ts:103
Add translation data to the translator. translation can be a nested object.

throws

If language isn't available in translator

Parameters
- language: string
  
  The language for which to add the translation
- translation: any
  
  A translation object of the form {id: translationForId}
Returns void

Private deepFlattenTranslations

deepFlattenTranslations(translationObject: any, oldId: string, result: translation): void

- Defined in translator.service.ts:195
Parameters
- translationObject: any
- oldId: string
- result: translation
Returns void

Private flattenTranslations

flattenTranslations(translationObject: any): translation

- Defined in translator.service.ts:182
Flattens a translation object into flat ids.

Parameters
- translationObject: any
Returns translation

flattened translation object

getAvailableLanguages

getAvailableLanguages(): string[]

- Defined in translator.service.ts:38
Get the available languages.

Returns string[]

getLanguage

getLanguage(): string

- Defined in translator.service.ts:58
Get the currently used language.

throws

if no language is set yet

Returns string

guessLanguage

guessLanguage(): void

- Defined in translator.service.ts:69
Guess user language from user agent if available, or use first available language otherwise

throws

If no language is available in translator

Returns void

observe

observe(id: string): Observable<string>

- Defined in translator.service.ts:143
Subscribe to translations for an id.

Parameters
- id: string
Returns Observable<string>

an Observable that emits new translations

setAvailableLanguages

setAvailableLanguages(availableLanguages: string[]): void

- Defined in translator.service.ts:46
Set the available languages. The first one is the default language.

Parameters
- availableLanguages: string[]
  
  The new default language, e.g. ["en", "de", "ar"]
Returns void

setLanguage

setLanguage(language: string): void

- Defined in translator.service.ts:89
Set the language to use for translations.

throws

If language isn't available in translator

Parameters
- language: string
  
  The language to use for translations, e.g. "en"
Returns void

setTranslation

setTranslation(language: string, translation: any): void

- Defined in translator.service.ts:117
Overwrite translation data on the translator. translation can be a nested object.

throws

If language isn't available in translator

Parameters
- language: string
  
  The language for which to add the translation
- translation: any
  
  A translation object of the form {id: translationForId}
Returns void

subscribe

subscribe(id: string, callback: function): void

- Defined in translator.service.ts:157
Subscribe to translations for an id.

Parameters
- id: string
- callback: function
  - - (text: string): void
    - Parameters
      - text: string
      Returns void
Returns void

Private throwIfNotAvailable

throwIfNotAvailable(language: any): void

- Defined in translator.service.ts:170
Throws an error if language isn't available in translator

throws

If language isn't available in translator

Parameters
- language: any
Returns void

translate

translate(id: string): string

- Defined in translator.service.ts:129
Translate an id into the corresponding translation for the current language

throws

if no language is set yet

throws

if no translation is available for that id

Parameters
- id: string
Returns string