Перейти к содержанию

Описание API

Функция локализации localize

Локализует строку, используя текущий объект LocalizationManager.instance. Подставляет в строку переданные дополнительные аргументы (если присутствуют).

Возвращает строку, в которой выполнена локализация и форматирование, или пустую строку '', если переданы null или undefined.

Note

Функция доступна с версии TESSA 3.6.0.9.

Определения

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

declare function localize(display: readonly string[], ...values: readonly unknown[]): string;

Параметры

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

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

Импорт в коде расширений

import { localize } from 'tessa/localization';

Примеры использования

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

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

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

Back to top