Class: DefaultTranslation

Default implementation of TranslationAdapter.

Implements

• TranslationAdapter

Signature

declare class DefaultTranslation implements TranslationAdapter

Constructors

Constructor

new DefaultTranslation(options: TranslationAdapterFactoryOptions): DefaultTranslation;

Creates a new instance of DefaultTranslation.

Parameters

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

Returns

DefaultTranslation

Methods

getMessage()

getMessage(locale: string, key: string): string | undefined;

Get a message of locale.

Parameters

Name	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.

---

getResource()

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

Get a resource of locale.

Parameters

Name	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.

---

setResource()

setResource(locale: string, resource: Record<string, string>): void;

Set a resource of locale.

Parameters

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

Returns

void

---

translate()

translate(locale: string, key: string, values?: Record<string, unknown>): string | undefined;

Translate a message.

Parameters

Name	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 (optional)

Returns

string | undefined — A translated message, if message is not translated, return undefined.