Number.prototype.toLocaleString()

Метод toLocaleString() объекта Number возвращает строку с представлением числа, соответствующим языковым соглашениям. В реализациях с поддержкой Intl.NumberFormat API этот метод делегирует вызов Intl.NumberFormat.

Каждый раз, когда вызывается toLocaleString, приходится выполнять поиск в большой базе данных строк локализации, что потенциально неэффективно. Когда метод вызывается многократно с одинаковыми аргументами, лучше создать объект Intl.NumberFormat и использовать его метод format(), поскольку объект NumberFormat запоминает переданные ему аргументы и может решить кэшировать часть базы данных, чтобы последующие вызовы format могли искать строки локализации в более ограниченном контексте.

Попробуйте

function eArabic(x) {
  return x.toLocaleString("ar-EG");
}

console.log(eArabic(123456.789));
// Expected output: "١٢٣٬٤٥٦٫٧٨٩"

console.log(eArabic("123456.789"));
// Expected output: "123456.789"

console.log(eArabic(NaN));
// Expected output: "ليس رقم"

Синтаксис

toLocaleString()
toLocaleString(locales)
toLocaleString(locales, options)

Параметры

Параметры locales и options настраивают поведение функции и позволяют приложениям указывать язык, соглашения форматирования которого следует использовать.

В реализациях, поддерживающих Intl.NumberFormat API, эти параметры точно соответствуют параметрам конструктора Intl.NumberFormat(). Реализациям без поддержки Intl.NumberFormat предписывается игнорировать оба параметра, делая используемую локаль и форму возвращаемой строки полностью зависимыми от реализации.

locales Необязательный

Строка с теги языка BCP 47 или массив таких строк. Соответствует параметру locales конструктора Intl.NumberFormat().

В реализациях без поддержки Intl.NumberFormat этот параметр игнорируется, и обычно используется локаль хоста.

options Необязательный

Объект, настраивающий формат вывода. Соответствует параметру options конструктора Intl.NumberFormat().

В реализациях без поддержки Intl.NumberFormat этот параметр игнорируется.

Подробности об этих параметрах и способах их использования см. в конструкторе Intl.NumberFormat().

Возвращаемое значение

Строка, представляющая данное число в соответствии с языковыми соглашениями.

В реализациях с Intl.NumberFormat это эквивалентно new Intl.NumberFormat(locales, options).format(number).

Примеры

Использование toLocaleString()

Базовое использование этого метода без указания locale возвращает форматированную строку в локали по умолчанию и с параметрами по умолчанию.

const number = 3500;

console.log(number.toLocaleString()); // "3,500" if in U.S. English locale

Проверка поддержки параметров locales и options

Параметры locales и options могут поддерживаться не во всех реализациях, поскольку поддержка API интернационализации является необязательной, и некоторые системы могут не иметь необходимых данных. Для реализаций без поддержки интернационализации toLocaleString() всегда использует локаль системы, которая может быть не тем, что вам нужно. Поскольку любая реализация, поддерживающая параметры locales и options, должна поддерживать Intl API, вы можете проверить наличие последнего для поддержки:

function toLocaleStringSupportsLocales() {
  return (
    typeof Intl === "object" &&
    !!Intl &&
    typeof Intl.NumberFormat === "function"
  );
}

Использование locales

Этот пример показывает некоторые вариации локализованных числовых форматов. Чтобы получить формат языка, используемого в пользовательском интерфейсе вашего приложения, убедитесь, что вы указали этот язык (и, возможно, некоторые запасные языки) с помощью аргумента locales:

const number = 123456.789;

// German uses comma as decimal separator and period for thousands
console.log(number.toLocaleString("de-DE"));
// 123.456,789

// Arabic in most Arabic speaking countries uses Eastern Arabic digits
console.log(number.toLocaleString("ar-EG"));
// ١٢٣٤٥٦٫٧٨٩

// India uses thousands/lakh/crore separators
console.log(number.toLocaleString("en-IN"));
// 1,23,456.789

// the nu extension key requests a numbering system, e.g. Chinese decimal
console.log(number.toLocaleString("zh-Hans-CN-u-nu-hanidec"));
// 一二三,四五六.七八九

// when requesting a language that may not be supported, such as
// Balinese, include a fallback language, in this case Indonesian
console.log(number.toLocaleString(["ban", "id"]));
// 123.456,789

Использование options

Результаты, предоставляемые toLocaleString(), можно настроить с помощью параметра options:

const number = 123456.789;

// request a currency format
console.log(
  number.toLocaleString("de-DE", { style: "currency", currency: "EUR" }),
);
// 123.456,79 €

// the Japanese yen doesn't use a minor unit
console.log(
  number.toLocaleString("ja-JP", { style: "currency", currency: "JPY" }),
);
// ￥123,457

// limit to three significant digits
console.log(number.toLocaleString("en-IN", { maximumSignificantDigits: 3 }));
// 1,23,000

// Use the host default language with options for number formatting
const num = 30000.65;
console.log(
  num.toLocaleString(undefined, {
    minimumFractionDigits: 2,
    maximumFractionDigits: 2,
  }),
);
// "30,000.65" where English is the default language, or
// "30.000,65" where German is the default language, or
// "30 000,65" where French is the default language

Спецификации

Совместимость с браузерами

См. также

• Intl.NumberFormat
• Number.prototype.toString()