javascript / latest / global_objects / bigint / tolocalestring.html /

BigInt.prototype.toLocaleString()

The toLocaleString() method returns a string with a language-sensitive representation of this BigInt.

Try it

Syntax

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

Parameters

The locales and options arguments customize the behavior of the function and let applications specify the language whose formatting conventions should be used. In implementations that ignore the locales and options arguments, the locale used and the form of the string returned are entirely implementation-dependent.

See the Intl.NumberFormat() constructor for details on these parameters and how to use them.

Return value

A string with a language-sensitive representation of the given BigInt.

Performance

When formatting large numbers of numbers, it is better to create a Intl.NumberFormat object and use the function provided by its NumberFormat.format property.

Examples

Using toLocaleString

In basic use without specifying a locale, a formatted string in the default locale and with default options is returned.

var bigint = 3500n;

bigint.toLocaleString();
// Displays "3,500" if in U.S. English locale

Using locales

This example shows some of the variations in localized number formats. In order to get the format of the language used in the user interface of your application, make sure to specify that language (and possibly some fallback languages) using the locales argument:

var bigint = 123456789123456789n;

// German uses period for thousands
console.log(bigint.toLocaleString('de-DE'));
// → 123.456.789.123.456.789

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

// India uses thousands/lakh/crore separators
console.log(bigint.toLocaleString('en-IN'));
// → 1,23,45,67,89,12,34,56,789

// the nu extension key requests a numbering system, e.g. Chinese decimal
console.log(bigint.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(bigint.toLocaleString(['ban', 'id']));
// → 123.456.789.123.456.789

Using options

The results provided by toLocaleString can be customized using the options argument:

var bigint = 123456789123456789n;

// request a currency format
console.log(bigint.toLocaleString('de-DE', { style: 'currency', currency: 'EUR' }));
// → 123.456.789.123.456.789,00 €

// the Japanese yen doesn't use a minor unit
console.log(bigint.toLocaleString('ja-JP', { style: 'currency', currency: 'JPY' }))
// → ¥123,456,789,123,456,789

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

Specifications

Browser compatibility

Desktop Mobile Server
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet Deno Node.js
toLocaleString
67
79
68
No
54
14
67
67
68
48
14
9.0
1.0
10.4.0
locales
76
79
70
No
No
14
76
76
79
54
14
12.0
1.8
1.0-1.8
Only the locale data for en-US is available.
12.9.0
options
76
79
70
No
No
14
76
76
79
54
14
12.0
?
12.9.0

See also

© 2005–2022 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt/toLocaleString