Class Translator

Translator translator instance used to translate strings based on the stored gettext information

Index

Constructors

Methods

clone setContext setDomain storeGetText translate translateD translateDN translateDNP translateDP translateN translateNP translateP

Constructors

constructor

new Translator(o?: unknown): Translator
Parameters
- Optionalo: unknown
Returns Translator

Methods

clone

clone(): Translator
Returns Translator

setContext

setContext(ctx: string | null): void
set the context for the following translation operations
Parameters
- ctx: string | null
  Use empty string or null to clear
Returns void

setDomain

setDomain(domain: string | null): void
set the domain for the following translation operations
Parameters
- domain: string | null
  Use empty string or null to clear
Returns void

storeGetText

storeGetText(o: unknown): void
store a gettext object used for all translations
Parameters
- o: unknown
Returns void

translate

translate(
key: string | I18NString<(string | number)[]>,
...var_args: (string | number)[],
): string
translate the provided key
Parameters
- key: string | I18NString<(string | number)[]>
- ...var_args: (string | number)[]
  args for sprintf
Returns string

translateD

translateD(
    domain: string,
    key: string | I18NString<(string | number)[]>,
    ...var_args: (string | number)[],
): string
translate the provided key in a domain
Parameters
- domain: string
- key: string | I18NString<(string | number)[]>
- ...var_args: (string | number)[]
  args for sprintf
Returns string

translateDN

translateDN(
    domain: string,
    singular: string,
    plural: string,
    val: string,
    ...var_args: (string | number)[],
): string
translate the provided singular and plural keys in a domain
Parameters
- domain: string
- singular: string
- plural: string
- val: string
- ...var_args: (string | number)[]
  args for sprintf
Returns string

translateDNP

translateDNP(
    domain: string,
    ctx: string,
    singular: string,
    plural: string,
    val: string,
    ...var_args: (string | number)[],
): string
translate the provided singular and plural keys in a domain in context
Parameters
- domain: string
- ctx: string
- singular: string
- plural: string
- val: string
- ...var_args: (string | number)[]
  args for sprintf
Returns string

translateDP

translateDP(
    domain: string,
    ctx: string,
    key: string | I18NString<(string | number)[]>,
    ...var_args: (string | number)[],
): string
translate the provided key in a domain in context
Parameters
- domain: string
- ctx: string
- key: string | I18NString<(string | number)[]>
- ...var_args: (string | number)[]
  args for sprintf
Returns string

translateN

translateN(
    singular: string,
    plural: string,
    val?: number,
    ...var_args: (string | number)[],
): string
translate the provided singular and plural keys
Parameters
- singular: string
- plural: string
- Optionalval: number
- ...var_args: (string | number)[]
  args for sprintf
Returns string

translateNP

translateNP(
    ctx: string,
    singular: string,
    plural: string,
    val: string,
    ...var_args: (string | number)[],
): string
translate the provided singular and plural keys in a context
Parameters
- ctx: string
- singular: string
- plural: string
- val: string
- ...var_args: (string | number)[]
  args for sprintf
Returns string

translateP

translateP(
    ctx: string,
    key: string | I18NString<(string | number)[]>,
    ...var_args: (string | number)[],
): string
translate the provided key in context
Parameters
- ctx: string
- key: string | I18NString<(string | number)[]>
- ...var_args: (string | number)[]
  args for sprintf
Returns string