ClassI18nInternal

constructor

• new I18n(translations?, config?): I18n
• Internal

  Parameters

  • translations: {
        [key: string]: string | TranslationPluralForms;
    } = {}

    Key-value pairs of the translation strings to use.

    • [key: string]: string | TranslationPluralForms

  • Optionalconfig: {
        locale: string;
    } = {}

    Configuration options for the function.

    • locale: string

      An overriding locale for the PluralRules functionality.

  Returns I18n

locale

translations

Static InternalpluralRules

Static InternalpluralRulesMap

getPluralRulesForLocale

• getPluralRulesForLocale(): string
• Internal

  Work out which pluralisation rules to use for the current locale

  The locale may include a regional indicator (such as en-GB), but we don't usually care about this part, as pluralisation rules are usually the same regardless of region. There are exceptions, however, (e.g. Portuguese) so this searches by both the full and shortened locale codes, just to be sure.

  Returns string

  The name of the pluralisation rule to use (a key for one of the functions in this.pluralRules)

getPluralSuffix

• getPluralSuffix(lookupKey, count): PluralRule
• Internal

  Get the appropriate suffix for the plural form.

  Uses Intl.PluralRules (or our own fallback implementation) to get the 'preferred' form to use for the given count.

  Checks that a translation has been provided for that plural form – if it hasn't, it'll fall back to the 'other' plural form (unless that doesn't exist either, in which case an error will be thrown)

  Parameters

  • lookupKey: string

    The lookup key of the string to use.
  • count: number

    Number used to determine which pluralisation to use.

  Returns PluralRule

  The suffix associated with the correct pluralisation for this locale.

  Throws

  Plural form .other required when preferred plural form is missing

hasIntlPluralRulesSupport

• hasIntlPluralRulesSupport(): boolean
• Internal

  Check to see if the browser supports Intl.PluralRules

  It requires all conditions to be met in order to be supported:

  • The implementation of Intl supports PluralRules (NOT true in Safari 10–12)
  • The browser/OS has plural rules for the current locale (browser dependent)

  https://browsersl.ist/#q=supports+es6-module+and+not+supports+intl-pluralrules

  Returns boolean

  Returns true if all conditions are met. Returns false otherwise.

replacePlaceholders

• replacePlaceholders(translationString, options): string
• Internal

  Takes a translation string with placeholders, and replaces the placeholders with the provided data

  Parameters

  • translationString: string

    The translation string
  • options: {
        [key: string]: unknown;
    }

    Any options passed with the translation string, e.g: for string interpolation.

    • [key: string]: unknown

  Returns string

  The translation string to output, with ${} placeholders replaced

selectPluralFormUsingFallbackRules

• selectPluralFormUsingFallbackRules(count): PluralRule
• Internal

  Get the plural form using our fallback implementation

  This is split out into a separate function to make it easier to test the fallback behaviour in an environment where Intl.PluralRules exists.

  Parameters

  • count: number

    Number used to determine which pluralisation to use.

  Returns PluralRule

  The pluralisation form for count in this locale.

t

• t(lookupKey, options?): string
• Internal

  The most used function - takes the key for a given piece of UI text and returns the appropriate string.

  Parameters

  • lookupKey: string

    The lookup key of the string to use.
  • Optionaloptions: {
        [key: string]: unknown;
    }

    Any options passed with the translation string, e.g: for string interpolation.

    • [key: string]: unknown

  Returns string

  The appropriate translation string.

  Throws

  Lookup key required

  Throws

  Options required for ${} placeholders