gunshi / default / DefaultTranslation
Class: DefaultTranslation
Default implementation of TranslationAdapter.
Implements
TranslationAdapter
Constructors
Constructor
ts
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()
ts
getMessage(locale, key): undefined | string;
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
undefined
| string
A message of locale. If message not found, return undefined
.
Implementation of
ts
TranslationAdapter.getMessage
getResource()
ts
getResource(locale): undefined | Record<string, string>;
Get a resource of locale.
Parameters
Parameter | Type | Description |
---|---|---|
locale | string | A locale of resource (BCP 47 language tag) |
Returns
undefined
| Record
<string
, string
>
A resource of locale. If resource not found, return undefined
.
Implementation of
ts
TranslationAdapter.getResource
setResource()
ts
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
ts
TranslationAdapter.setResource
translate()
ts
translate(
locale,
key,
values): undefined | string;
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
undefined
| string
A translated message, if message is not translated, return undefined
.
Implementation of
ts
TranslationAdapter.translate