Intl​.List​Format​.prototype​.formatToParts()

Brouillon: Cette page n'est pas terminée.

La méthode Intl.ListFormat.prototype.formatToParts() renvoie un tableau (Array) d'objets représentants les différentes composantes de la chaine de caractères qui est le résultat du formatage de la liste (selon les options de locale et de style indiquées).

Syntaxe

Intl.ListFormat.prototype.formatToParts(list)

Paramètres

list

Un tableau (Array) de valeurs à mettre en forme selon une locale et des options de style.

Valeur de retour

Un tableau (Array) de fragments composants la chaîne de caractères pour la liste formatée.

Description

Alors que la méthode Intl.ListFormat.prototype.format() (en-US) renvoie une chaîne de caractères avec la liste formatée (en fonction de la locale et des options de style), formatToParts() renvoie un tableau des différentes composantes de cette chaîne.

Chaque élément du tableau résultant possède deux propriétés : type et value. La propriété type pourra valoir "element" (pour indiquer une valeur de la liste) ou "literal" (pour indiquer un élément linguistique). La propriété value fournit quant à elle le contenu du fragment sous forme d'une chaîne de caractères.

Les options de locale et de style utilisées pour le formatage sont fournies lors de la construction de l'instance Intl.ListFormat.

Exemples

const fruits = ['Apple', 'Orange', 'Pineapple'];
const myListFormat = new Intl.ListFormat('en-GB', { style: 'long', type: 'conjunction' });

console.table(myListFormat.formatToParts(fruits));
// [
//  { "type": "element", "value": "Apple" },
//  { "type": "literal", "value": ", " },
//  { "type": "element", "value": "Orange" },
//  { "type": "literal", "value": ", and " },
//  { "type": "element", "value": "Pineapple" }
// ]

Spécifications

Spécification État Commentaires
Intl.ListFormat.prototype.formatToParts proposal Stage 3

Compatibilité des navigateurs

BCD tables only load in the browser

Voir aussi