gunshi / default / DefaultTranslation

Class: DefaultTranslation

Default implementation of TranslationAdapter.

Implements

• TranslationAdapter

Constructors

Constructor

new DefaultTranslation(options): DefaultTranslation;

Creates a new instance of DefaultTranslation.

Parameters

Parameter	Type	Description
options	TranslationAdapterFactoryOptions	Options for the translation adapter, see TranslationAdapterFactoryOptions

Returns

DefaultTranslation

Methods

getMessage()

getMessage(locale, key): string | undefined;

Get a message of locale.

Parameters

Parameter	Type	Description
locale	string	A locale of message (BCP 47 language tag)
key	string	A key of message resource

Returns

string | undefined

A message of locale. If message not found, return undefined.

Implementation of

TranslationAdapter.getMessage

---

getResource()

getResource(locale): Record<string, string> | undefined;

Get a resource of locale.

Parameters

Parameter	Type	Description
locale	string	A locale of resource (BCP 47 language tag)

Returns

Record<string, string> | undefined

A resource of locale. If resource not found, return undefined.

Implementation of

TranslationAdapter.getResource

---

setResource()

setResource(locale, resource): void;

Set a resource of locale.

Parameters

Parameter	Type	Description
locale	string	A locale of resource (BCP 47 language tag)
resource	Record<string, string>	A resource of locale

Returns

void

Implementation of

TranslationAdapter.setResource

---

translate()

translate(
   locale, 
   key, 
   values): string | undefined;

Translate a message.

Parameters

Parameter	Type	Description
locale	string	A locale of message (BCP 47 language tag)
key	string	A key of message resource
values	Record<string, unknown>	A values to interpolate in the message

Returns

string | undefined

A translated message, if message is not translated, return undefined.

Implementation of

TranslationAdapter.translate