Function localize

  • localize(
        display: undefined | null | string,
        ...values: readonly unknown[],
    ): string

    Локализует строку, используя текущий объект LocalizationManager.

    В функцию могут быть переданы:

    • строка локализации display='$Something';
    • строка с плейсхолдерами локализации display='{$Something}';
    • строка с аргументами values, подставляемыми в строку display на позициях {0}, {1} и др., где каждый из них может быть или строкой локализации $Something, или строкой, содержащей плейсхолдер {$Something}, или нестроковым значением, которое форматируется по правилам функции formatToString;
    • интерполированная строка вида localize`{$Something} ${variableName}` , где значения подставляемых переменных variableName имеют такие же правила подстановки, как и значения массива values из соответствующей перегрузки.

    Parameters

    • display: undefined | null | string

      строка, содержащая обычную строку, строку локализации, строку с плейсхолдерами локализации, или массив строк при вызове tag function.

    • ...values: readonly unknown[]

      параметры, подставляемые в строку display на позициях {0}, {1} и др., или вставляемые между элементами массива display при вызове как tag function. Каждый параметр может быть значением любого типа, а также строкой локализации.

    Returns string

    строка, в которой выполнена локализация и форматирование.

    See

    • LocalizationManager класс, предоставляющий средства локализации.
    • LocalizationManager.localize функция, выполняющая локализацию строки без аргументов, заменяет как строки локализации $Something, так и строки с плейсхолдерами локализации {$Something} else.
    • LocalizationHelper.format функция, выполняющая форматирование строки с аргументами ({0}, {1} и др.) совместно с локализацией.
    • LocalizationHelper.formatLocalized функция, выполняющая форматирование и локализацию при вызове как tag function.

    Example: <caption>Строка локализации</caption>

    localize('$Something')
    localize`$Something`
    // SOMETHING

    Example: <caption>Плейсхолдеры локализации</caption>

    localize('{$Something} else')
    localize`{$Something} else`
    // SOMETHING else

    Example: <caption>Форматирование с аргументами</caption>

    const firstName = 'John';
    const lastName = 'Doe';
    localize('{$Hello}, {0} {1}!', firstName, lastName)
    localize`{$Hello}, ${firstName} ${lastName}!`
    // Hello, John Doe!
  • localize(display: readonly string[], ...values: readonly unknown[]): string

    Локализует строку, используя текущий объект LocalizationManager.

    В функцию могут быть переданы:

    • строка локализации display='$Something';
    • строка с плейсхолдерами локализации display='{$Something}';
    • строка с аргументами values, подставляемыми в строку display на позициях {0}, {1} и др., где каждый из них может быть или строкой локализации $Something, или строкой, содержащей плейсхолдер {$Something}, или нестроковым значением, которое форматируется по правилам функции formatToString;
    • интерполированная строка вида localize`{$Something} ${variableName}` , где значения подставляемых переменных variableName имеют такие же правила подстановки, как и значения массива values из соответствующей перегрузки.

    Parameters

    • display: readonly string[]

      строка, содержащая обычную строку, строку локализации, строку с плейсхолдерами локализации, или массив строк при вызове tag function.

    • ...values: readonly unknown[]

      параметры, подставляемые в строку display на позициях {0}, {1} и др., или вставляемые между элементами массива display при вызове как tag function. Каждый параметр может быть значением любого типа, а также строкой локализации.

    Returns string

    строка, в которой выполнена локализация и форматирование.

    See

    • LocalizationManager класс, предоставляющий средства локализации.
    • LocalizationManager.localize функция, выполняющая локализацию строки без аргументов, заменяет как строки локализации $Something, так и строки с плейсхолдерами локализации {$Something} else.
    • LocalizationHelper.format функция, выполняющая форматирование строки с аргументами ({0}, {1} и др.) совместно с локализацией.
    • LocalizationHelper.formatLocalized функция, выполняющая форматирование и локализацию при вызове как tag function.

    Example: <caption>Строка локализации</caption>

    localize('$Something')
    localize`$Something`
    // SOMETHING

    Example: <caption>Плейсхолдеры локализации</caption>

    localize('{$Something} else')
    localize`{$Something} else`
    // SOMETHING else

    Example: <caption>Форматирование с аргументами</caption>

    const firstName = 'John';
    const lastName = 'Doe';
    localize('{$Hello}, {0} {1}!', firstName, lastName)
    localize`{$Hello}, ${firstName} ${lastName}!`
    // Hello, John Doe!

Settings

Member Visibility