Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Translate

Hierarchy

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

  • Returns Translate

Properties

defaultLanguage

defaultLanguage: string = "en-US"

i18n

i18n: object = i18n

Type declaration

language

language: string

libTranslate

libTranslate: any

supportedLanguages

supportedLanguages: string[] = ['en-US','nl-NL']

t

t: any

translations

translations: object

Type declaration

translationsLocation

translationsLocation: string = "assets/translations"

Methods

add

  • add(translationsObject: any): void

  • Parameters

    • translationsObject: any

    Returns void

get

  • get(translationKey: any, ...params: any[]): string

  • Translates a string to the current language of the TranslateService.

    Parameters

    • translationKey: any

      The string to translate.

    • Rest ...params: any[]

      The parameters to send to the translate function.

    Returns string

initTranslateJs

  • initTranslateJs(): void

  • Returns void

loadTranslation

  • loadTranslation(language: string): Promise<void>

  • Parameters

    • language: string

    Returns Promise<void>

set

  • set(translationKey: string, value: any): void

  • Adds a translated string to the current language object.

    Parameters

    • translationKey: string

      The identifier of the translation.

    • value: any

      The value of the translation in the current selected language.

    Returns void

updateTranslateComponents

  • updateTranslateComponents(): void

  • Returns void

use

  • use(language: string, reloadRemote?: boolean): Promise<void>

  • Switch the current language of the translateService. If the supplied language parameter is not yet present in the translations object, the service will try to load a json file in the location specified in translationsLocation property. example: use('fr'), will load 'assets/translations/fr.json' by default

    Parameters

    • language: string

      The language identifier.

    • Default value reloadRemote: boolean = false

      Set this to true to reload the json translation file.

    Returns Promise<void>

Object literals

options

options: object

debug

debug: boolean = false

namespaceSplitter

namespaceSplitter: string = "::"