Intl.ListFormat.prototype.format()
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since April 2021.
The format()
method of Intl.ListFormat
instances returns a string with a
language-specific representation of the list.
Try it
Syntax
format()
format(list)
Parameters
list
-
An iterable object, such as an Array.
Return value
A language-specific formatted string representing the elements of the list.
Note: Most of the time, the formatting returned by format()
is consistent. However, the output may vary between implementations, even within the same locale — output variations are by design and allowed by the specification. It may also not be what you expect. For example, the string may use non-breaking spaces or be surrounded by bidirectional control characters. You should not compare the results of format()
to hardcoded constants.
Description
The format()
method returns a string that has been
formatted based on parameters provided in the Intl.ListFormat
object. The
locales
and options
parameters customize the behavior of
format()
and let applications specify the language conventions that
should be used to format the list.
Examples
Using format
The following example shows how to create a List formatter using the English language.
const list = ["Motorcycle", "Bus", "Car"];
console.log(
new Intl.ListFormat("en-GB", { style: "long", type: "conjunction" }).format(
list,
),
);
// Motorcycle, Bus and Car
console.log(
new Intl.ListFormat("en-GB", { style: "short", type: "disjunction" }).format(
list,
),
);
// Motorcycle, Bus or Car
console.log(
new Intl.ListFormat("en-GB", { style: "narrow", type: "unit" }).format(list),
);
// Motorcycle Bus Car
Specifications
Specification |
---|
ECMAScript Internationalization API Specification # sec-Intl.ListFormat.prototype.format |
Browser compatibility
BCD tables only load in the browser