.png?sv=2022-11-02&spr=https&st=2024-09-19T16%3A09%3A32Z&se=2024-09-19T16%3A19%3A32Z&sr=c&sp=r&sig=qZXiyrDSMLpLJ1qjv59Slm4WFAMhDxN4ANjgP7JF4KA%3D){kind=logo}
toLocaleString
- 23 May 2023
-
DarkLight
-
PDF
toLocaleString
- Updated on 23 May 2023
-
DarkLight
-
PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
toLocaleString Task Purpose
The toLocaleString task is used to convert the elements of a given array to a locale string. The elements are often separated by a locale-specific string. The result of calling this task is similar to the toString method, except this task is locale-specific.
Potential Use Case
This task is typically used to specify a language-specific format for dates, time, numbers, objects and arrays. Let's say you need to format currency such as "USD" for the US dollar, "EUR" for the euro, or "INR" for the Indian Rupee. You could use the toLocaleString task to display the currency in the appropriate format and symbol that represents the locale that should be used.
Parameters
Input and output parameters are shown below.
| Input | Type | Description |
|---|---|---|
arr |
Array | Required. The array to convert. |
locales |
Array | Required. A string that holds a BCP 47 language tag, or an array of such language tags. If the locales parameter is not provided or is undefined, the default locale is used. |
options |
Object | Required. An object with configuration properties. For number objects, use Number.prototype.toLocaleString(). For date objects, use Date.prototype.toLocaleString(). |
| Output | Type | Description |
|---|---|---|
elementString |
String | A string representing the elements of the array. |
Examples
In the IAP examples shown below:
-
All the incoming variables for
toLocaleStringare required.
-
In the examples shown below,
toLocaleStringis used to convert numbers into a locale-specific currency representation (i.e., Euro, USD). TheelementString(output variable) of each example is shown in the Task History, which is accessed from Jobs in Operations Manager.
Examples: Euro
Examples: USD
Further Reading
For more information on using the locales parameter, see the Intl page on the MDN site.
Was this article helpful?
