TranslationModule | @iamsquare/convert-units - v2.0.0

Type parameters

TTranslationKeys: string

Hierarchy

TranslationModule

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TranslationModule<TTranslationKeys>(defaultTranslations?: Partial<Record<TTranslationKeys, string>>): TranslationModule<TTranslationKeys>

- Defined in i18n/index.ts:5
Type parameters
- TTranslationKeys: string
Parameters
- defaultTranslations: Partial<Record<TTranslationKeys, string>> = {}
Returns TranslationModule<TTranslationKeys>

Properties

Private _defaultTranslations

_defaultTranslations: Partial<Record<TTranslationKeys, string>> = {}

Private _translations

_translations: Partial<Record<TTranslationKeys, string>>

Methods

getTranslationByKey

getTranslationByKey(key: TTranslationKeys): Partial<Record<TTranslationKeys, string>>[TTranslationKeys]

- Defined in i18n/index.ts:41
Parameters
- key: TTranslationKeys
  
  The translation key
Returns Partial<Record<TTranslationKeys, string>>[TTranslationKeys]

The current translation value for the given key or the key if the translation is missing

mergeTranslations

mergeTranslations(translations: Partial<Record<TTranslationKeys, string>>): void

- Defined in i18n/index.ts:26
Merges the current translations with a translation dictionary (if two keys are the same the dictionary passed as parameter takes precedence)

Parameters
- translations: Partial<Record<TTranslationKeys, string>>
  
  The dictionary containing the merged translations
Returns void

resetTranslations

resetTranslations(): void

- Defined in i18n/index.ts:33
Resets the translations to their original state

Returns void

setTranslations

setTranslations(translations: Partial<Record<TTranslationKeys, string>>): void

- Defined in i18n/index.ts:17
Set the current translations

Parameters
- translations: Partial<Record<TTranslationKeys, string>>
  
  The dictionary containing the translations
Returns void

Generated using TypeDoc