Class Gettext

Gettext class providing localization methods.

Constructors

constructor

Methods

__ _n _np _p dcnpgettext getContextDelimiter getDomain getLocale getStringsPrefix gettext loadJSON ngettext npgettext pgettext setContextDelimiter setDomain setLocale setStringsPrefix strfmt

Constructors

constructor

Methods

__

  • __(msgid: string, ...args: any[]): string

  • Shorthand for gettext.

    Parameters

    • msgid: string

      The singular string to translate.

    • ...args: any[]

      Any additional values to use with interpolation.

    Returns string

    A translated string if found, or the original string.

    Notes

    This is not a private method (starts with an underscore) it is just a shorter and standard way to call these methods.

_n

  • _n(msgid: string, msgid_plural: string, n: number, ...args: any[]): string

  • Shorthand for ngettext.

    Parameters

    • msgid: string

      The singular string to translate.

    • msgid_plural: string

      The plural string to translate.

    • n: number

      The number for pluralization.

    • ...args: any[]

      Any additional values to use with interpolation.

    Returns string

    A translated string if found, or the original string.

    Notes

    This is not a private method (starts with an underscore) it is just a shorter and standard way to call these methods.

_np

  • _np(
        msgctxt: string,
        msgid: string,
        msgid_plural: string,
        n: number,
        ...args: any[],
    ): string

  • Shorthand for npgettext.

    Parameters

    • msgctxt: string

      The message context.

    • msgid: string

      The singular string to translate.

    • msgid_plural: string

      The plural string to translate.

    • n: number

      The number for pluralization.

    • ...args: any[]

      Any additional values to use with interpolation.

    Returns string

    A translated string if found, or the original string.

    Notes

    This is not a private method (starts with an underscore) it is just a shorter and standard way to call these methods.

_p

  • _p(msgctxt: string, msgid: string, ...args: any[]): string

  • Shorthand for pgettext.

    Parameters

    • msgctxt: string

      The message context.

    • msgid: string

      The singular string to translate.

    • ...args: any[]

      Any additional values to use with interpolation.

    Returns string

    A translated string if found, or the original string.

    Notes

    This is not a private method (starts with an underscore) it is just a shorter and standard way to call these methods.

dcnpgettext

  • dcnpgettext(
        domain: string,
        msgctxt: string,
        msgid: string,
        msgid_plural: string,
        n: number,
        ...args: any[],
    ): string

  • Translate a singular string with extra interpolation values.

    Parameters

    • domain: string

      The translations domain.

    • msgctxt: string

      The message context.

    • msgid: string

      The singular string to translate.

    • msgid_plural: string

      The plural string to translate.

    • n: number

      The number for pluralization.

    • ...args: any[]

      Any additional values to use with interpolation

    Returns string

    A translated string if found, or the original string.

getContextDelimiter

getDomain

getLocale

getStringsPrefix

gettext

  • gettext(msgid: string, ...args: any[]): string

  • Translate a singular string with extra interpolation values.

    Parameters

    • msgid: string

      The singular string to translate.

    • ...args: any[]

      Any additional values to use with interpolation.

    Returns string

    A translated string if found, or the original string.

loadJSON

  • loadJSON(jsonData: IJsonData, domain: string): void

  • Load json translations strings (In Jed 2.x format).

    Parameters

    • jsonData: IJsonData

      The translation strings plus metadata.

    • domain: string

      The translation domain, e.g. "jupyterlab".

    Returns void

ngettext

  • ngettext(msgid: string, msgid_plural: string, n: number, ...args: any[]): string

  • Translate a plural string with extra interpolation values.

    Parameters

    • msgid: string

      The singular string to translate.

    • msgid_plural: string
    • n: number
    • ...args: any[]

      Any additional values to use with interpolation.

    Returns string

    A translated string if found, or the original string.

npgettext

  • npgettext(
        msgctxt: string,
        msgid: string,
        msgid_plural: string,
        n: number,
        ...args: any[],
    ): string

  • Translate a contextualized plural string with extra interpolation values.

    Parameters

    • msgctxt: string

      The message context.

    • msgid: string

      The singular string to translate.

    • msgid_plural: string

      The plural string to translate.

    • n: number

      The number for pluralization.

    • ...args: any[]

      Any additional values to use with interpolation

    Returns string

    A translated string if found, or the original string.

pgettext

  • pgettext(msgctxt: string, msgid: string, ...args: any[]): string

  • Translate a contextualized singular string with extra interpolation values.

    Parameters

    • msgctxt: string

      The message context.

    • msgid: string

      The singular string to translate.

    • ...args: any[]

      Any additional values to use with interpolation.

    Returns string

    A translated string if found, or the original string.

    Notes

    This is not a private method (starts with an underscore) it is just a shorter and standard way to call these methods.

setContextDelimiter

  • setContextDelimiter(delimiter: string): void

  • Set current context delimiter.

    Parameters

    • delimiter: string

      The delimiter to set.

    Returns void

setDomain

setLocale

setStringsPrefix

  • setStringsPrefix(prefix: string): void

  • Set current strings prefix.

    Parameters

    • prefix: string

      The string prefix to set.

    Returns void

Staticstrfmt

  • strfmt(fmt: string, ...args: any[]): string

  • sprintf equivalent, takes a string and some arguments to make a computed string.

    Parameters

    • fmt: string

      The string to interpolate.

    • ...args: any[]

      The variables to use in interpolation.

      Examples

      strfmt("%1 dogs are in %2", 7, "the kitchen"); => "7 dogs are in the kitchen" strfmt("I like %1, bananas and %1", "apples"); => "I like apples, bananas and apples"

    Returns string

Settings

Member Visibility

On This Page

Constructors
Methods