Interface ListFormat

interface ListFormat {
    format(list: Iterable<string, any, any>): string;
    formatToParts(list: Iterable<string, any, any>): {
        type: "literal" | "element";
        value: string;
    }[];
    resolvedOptions(): ResolvedListFormatOptions;
}

Index

Methods

format formatToParts resolvedOptions

Methods

format

format(list): string
Returns a string with a language-specific representation of the list.
Parameters
- list: Iterable<string, any, any>
  An iterable object, such as an Array.
Returns string
A language-specific formatted string representing the elements of the list.

MDN.

Throws
TypeError if list includes something other than the possible values.

formatToParts

formatToParts(list): {
type: "literal" | "element";
value: string;
}[]
Returns an Array of objects representing the different components that can be used to format a list of values in a locale-aware fashion.
Parameters
- list: Iterable<string, any, any>
  An iterable object, such as an Array, to be formatted according to a locale.
Returns {
type: "literal" | "element";
value: string;
}[]
An Array of components which contains the formatted parts from the list.

MDN.

Throws
TypeError if list includes something other than the possible values.

resolvedOptions

resolvedOptions(): ResolvedListFormatOptions
Returns a new object with properties reflecting the locale and style formatting options computed during the construction of the current Intl.ListFormat object.

MDN.

Returns ResolvedListFormatOptions