Class Internationalization

constructor

• new Internationalization(
      application: null | Application,
  ): Internationalization.Internationalization
• Internal

  If constructed without an application, will use the default language. Intended for use in unit tests only.

  Parameters

  • application: null | Application

  Returns Internationalization.Internationalization

addTranslations

• addTranslations(
      lang: string,
      translations: Partial<
          Record<keyof Internationalization.TranslatableStrings, string>,
      >,
      override?: boolean,
  ): void

• Add translations for a string which will be displayed to the user.

  Parameters

  • lang: string
  • translations: Partial<Record<keyof Internationalization.TranslatableStrings, string>>
  • override: boolean = false

  Returns void

flagString

• flagString(flag: Models.ReflectionFlag): TranslatedString

• Parameters

  • flag: Models.ReflectionFlag

  Returns TranslatedString

getSupportedLanguages

• getSupportedLanguages(): string[]

• Gets a list of all languages with at least one translation.

  Returns string[]

hasTranslations

• hasTranslations(lang: string): boolean

• Checks if we have any translations in the specified language.

  Parameters

  • lang: string

  Returns boolean

kindPluralString

• kindPluralString(kind: Models.ReflectionKind): TranslatedString

• Parameters

  • kind: Models.ReflectionKind

  Returns TranslatedString

kindSingularString

• kindSingularString(kind: Models.ReflectionKind): TranslatedString

• Parameters

  • kind: Models.ReflectionKind

  Returns TranslatedString

translate

• translate<T extends keyof Internationalization.TranslatableStrings>(
      key: T,
      ...args: Internationalization.TranslatableStrings[T],
  ): TranslatedString

• Get the translation of the specified key, replacing placeholders with the arguments specified.

  Type Parameters

  • T extends keyof Internationalization.TranslatableStrings

  Parameters

  • key: T
  • ...args: Internationalization.TranslatableStrings[T]

  Returns TranslatedString

translateTagName

• translateTagName(tag: `@${string}`): TranslatedString

• Parameters

  • tag: `@${string}`

  Returns TranslatedString

proxy