peanut-framework / Classes/Properties/language / Language

Class: Language

Translation class used for generating text translations.

Generates multiple xx_XX.lang files based on specified translations.

Example

project.language.translate({
 entries: [
   {
     key: "accessibility.chat.howtoopen",
     text: "Press T to tell us you like Cookies!",
     overrideTranslation: [{ source: "en_GB", text: "Press T to tell us you like Biscuits!" }],
   },
 ],
});

Constructors

new Language()

new Language(options?): Language

Parameters

options?

whitelistAsBlacklist

boolean

whitelistLanguages

LanguageKey[]

Returns

Language

Methods

autoTranslate()

autoTranslate(): Language

Returns

Language

---

compile()

compile(): Promise<void>

Returns

Promise<void>

---

configure()

configure(options?): Promise<void>

Parameters

options?

whitelistAsBlacklist

boolean

whitelistLanguages

LanguageKey[]

Returns

Promise<void>

---

translate()

translate(...translations): void

Parameters

translations

...object[]

Returns

void