Interface I18N<KeyType>

The i18n information of a bundle.

interface I18N<KeyType = I18NData> {
    get<ExpectedType = KeyType>(locale?: string): ExpectedType;
    load(locale?: string): Promise<I18N<KeyType>>;
    loc<ExpectedType = I18NValue>(key: string, locale?: string): ExpectedType;
}

Type Parameters

KeyType = I18NData

Index

Methods

Methods

get

get<ExpectedType = KeyType>(locale?: string): ExpectedType
Get all i18n entries of the bundle.
Type Parameters
- ExpectedType = KeyType
Parameters
- Optionallocale: string
  e.g. de or en (optional)
Returns ExpectedType
the i18n data
- Defined in apprt/api/index.ts:823

load

load(locale?: string): Promise<I18N<KeyType>>
Loads the i18n data. This method is used during the 'resolve' phase of a bundle.
Parameters
- Optionallocale: string
  e.g. de, en. (optional)
Returns Promise<I18N<KeyType>>
a promise resolving to the i18n data.
- Defined in apprt/api/index.ts:817

loc

loc<ExpectedType = I18NValue>(key: string, locale?: string): ExpectedType
Look up an i18n value for a given key. Note, that this method supports chained keys, e.g. "a.b" This will return 1 from the i18n data structure { 'a': { 'b': '1' }}
Type Parameters
- ExpectedType = I18NValue
Parameters
- key: string
  the i18n key.
- Optionallocale: string
  e.g. de or en (optional)
Returns ExpectedType
the i18n value
- Defined in apprt/api/index.ts:832