Function translate

Translate a string

Param: app

the id of the app for which to translate the string

Param: text

the string to translate

Param: placeholdersOrNumber

map of placeholder key to value or a number replacing %n

Param: optionsOrNumber

the translation options or a number to replace %n with

Param: options

options object

Param: options.escape

enable/disable auto escape of placeholders (by default enabled)

Param: options.sanitize

enable/disable sanitization (by default enabled)

translate<T extends string>(
    app: string,
    text: T,
    placeholders?: TranslationVariables<T>,
    options?: TranslationOptions,
): string
Type Parameters
- T extends string
Parameters
- app: string
- text: T
- Optionalplaceholders: TranslationVariables<T>
- Optionaloptions: TranslationOptions
Returns string
- Defined in lib/translation.ts:50
translate<T extends string>(
    app: string,
    text: T,
    number?: number,
    options?: TranslationOptions,
): string
Type Parameters
- T extends string
Parameters
- app: string
- text: T
- Optionalnumber: number
- Optionaloptions: TranslationOptions
Returns string
- Defined in lib/translation.ts:51
translate<T extends string>(
    app: string,
    text: T,
    placeholders?: TranslationVariables<T>,
    number?: number,
    options?: TranslationOptions,
): string
Type Parameters
- T extends string
Parameters
- app: string
- text: T
- Optionalplaceholders: TranslationVariables<T>
- Optionalnumber: number
- Optionaloptions: TranslationOptions
Returns string
Inherit Doc
Deprecated
This overload is deprecated either use placeholders or a number but not both
- Defined in lib/translation.ts:56