• JavaScript Video Tutorials

JavaScript - TypedArray toLocaleString() Method

The JavaScript TypedArray toLocaleString() method returns a string representation of the current typed array elements. The typed array elements are converted to strings using this method, and these strings are separated with the specified locale-specific separator such as a comma (","), a symbol ($, ₹), etc.

The specified locale parameter is BCP (best current practice) 47 language tags are standard for the representation of regionalized language.

Syntax

Following is the syntax of JavaScript TypedArray toLocaleString() method −

toLocaleString(locales, options)

Parameters

This method accepts two parameters named 'locales' and 'options', which are described below −

  • locales − It is a string with a BCP 47 language tag that specifies the language and formatting options.

  • options − An object is used as an option to change the style, currency, minimum and maximum fraction digits, etc.

Return value

This method returns a string representation of the current typed array elements.

Examples

Example 1

If both locales and options parameters are omitted, it converts the elements of the current typed array [1000, 205, 5993, 4032] to strings considering your system locale and separates the strings with a comma (',').

<html>
<head>
   <title>JavaScript TypedArray toLocaleString() Method</title>
</head>
<body>
   <script>
      const T_array = new Int16Array([1000, 205, 5993, 4032]);
      document.write("Typed array: ", T_array);
      
      //using toLocaleString() method
      let str = T_array.toLocaleString();
      document.write("<br>The string representing typed array elements: ", str);
   </script>
</body>
</html>

Output

The above program returns a string representing the typed array element −

Typed array: 1000,205,5993,4032
The string representing typed array elements: 1,000,205,5,993,4,032

Example 2

If we pass only the "locale" parameter to this method, it converts the typed array elements to string based on the specified locale.

The following is another example of the JavaScript TypedArray toLocaleString() method. We use this method to retrieve a string representation of the elements of this typed array [4023, 6123, 30, 146] based on the specified locale "de-DE".

<html>
<head>
   <title>JavaScript TypedArray toLocaleString() Method</title>
</head>
<body>
   <script>
      const T_array = new Int16Array([4023, 6123, 30, 146]);
      document.write("Typed array: ", T_array);
      const locale = "de-DE";
      document.write("<br>The locale: ", locale);
      
      //using toLocaleString() method
      let str = T_array.toLocaleString(locale);
      document.write("<br>The string representing typed array elements: ", str);
   </script>
</body>
</html>

Output

After executing the above program, it will return a string representing the typed array elements as −

Typed array: 4023,6123,30,146
The locale: de-DE
The string representing typed array elements: 4.023,6.123,30,146

Example 3

If we pass both the locale and the options parameters to this method, it will convert the typed array elements to strings based on the specified locale and options (configure the properties like the currency symbol).

In the example below, we use the JavaScript TypedArray toLocaleString() method to retrieve a string representation of the elements of this typed array [5034, 6946, 234, 1003] using the specified country locale "en-In" and the currency symbol "₹".

<html>
<head>
   <title>JavaScript TypedArray toLocaleString() Method</title>
</head>
<body>
   <script>
      const T_array = new Int16Array([5034, 6946, 234, 1003]);
      document.write("Typed array: ", T_array);
      const locale = "en-IN";
      const options = {style: "currency", currency: "INR"};
      document.write("<br>The locale: ", locale);
      document.write("<br>The options: ", options.style,", ",options.currency);
      
      //using toLocaleString() method
      let str = T_array.toLocaleString(locale, options);
      document.write("<br>The string representing typed array elements: ", str);
   </script>
</body>
</html>

Output

Once the above program is executed, it will display the output as shown below −

Typed array: 5034,6946,234,1003
The locale: en-IN
The options: currency, INR
The string representing typed array elements: ₹5,034.00,₹6,946.00,₹234.00,₹1,003.00
Advertisements