Array : méthode toLocaleString()

Exemple interactif

const array1 = [1, "a", new Date("21 Dec 1997 14:12:00 UTC")];
const localeString = array1.toLocaleString("en", { timeZone: "UTC" });

console.log(localeString);
// Résultat attendu : "1,a,12/21/1997, 2:12:00 PM",
// Ceci suppose la locale "en" et le fuseau horaire UTC : votre résultat peut différer

Syntaxe

toLocaleString()
toLocaleString(locales)
toLocaleString(locales, options)

Paramètres

locales Facultatif

Une chaîne de caractères avec une étiquette de langue BCP 47, ou un tableau de telles chaînes. Pour la forme générale et l'interprétation de l'argument locales, voir la description du paramètre sur la page principale de Intl.

options Facultatif

Un objet avec des propriétés de configuration. Ce que vous pouvez passer ici dépend des éléments à convertir. Par exemple, pour les nombres, voir Number.prototype.toLocaleString().

Valeur de retour

Une chaîne de caractères qui représente les éléments du tableau.

Description

La méthode Array.prototype.toLocaleString parcourt le contenu du tableau, appelle la méthode toLocaleString de chaque élément avec les paramètres locales et options fournis, puis concatène les résultats avec un séparateur défini par l'implémentation (par exemple une virgule ,).

Si un élément vaut undefined ou null, il est converti en chaîne de caractères vide au lieu de la chaîne de caractères "null" ou "undefined".

Lorsqu'elle est utilisée sur un tableau creux, la méthode toLocaleString() parcourt les cases vides comme si elles avaient la valeur undefined.

La méthode toLocaleString() est générique. Elle attend seulement que la valeur de this possède une propriété length et des propriétés à clés entières.

Exemples

Utiliser les arguments locales et options

Chaque élément du tableau est converti en chaîne de caractères via sa méthode toLocaleString(). Par exemple, cet extrait appelle implicitement la méthode Number.prototype.toLocaleString() pour afficher la devise pour les chaînes de caractères et les nombres du tableau prix :

const prix = ["￥7", 500, 8123, 12];
prix.toLocaleString("ja-JP", { style: "currency", currency: "JPY" });

// "￥7,￥500,￥8,123,￥12"

Séparateur de liste

Le séparateur de liste n'est pas affecté par le paramètre locales. Pour le configurer, utilisez plutôt Intl.ListFormat.

const nums = [8888, 9999];
console.log(nums.toLocaleString("zh")); // "8,888,9,999"

const formateur = new Intl.ListFormat("zh", {
  type: "conjunction",
  style: "narrow",
});
console.log(formateur.format(nums.map((x) => x.toLocaleString("zh"))));
// "8,888、9,999"

Tableau creux et méthode toLocaleString()

toLocaleString() traite les cases vides comme undefined et produit un séparateur supplémentaire :

console.log([1, , 3].toLocaleString()); // '1,,3'

Objet non tableau et méthode toLocaleString()

La méthode toLocaleString() lit la propriété length de this puis accède à chaque propriété dont la clé est un entier non négatif inférieur à length.

const objetSimilaireTableau = {
  length: 3,
  0: 1,
  1: 2,
  2: 3,
  3: 4, // ignoré par toLocaleString() car length vaut 3
};
console.log(Array.prototype.toLocaleString.call(objetSimilaireTableau));
// 1,2,3

Spécifications

Compatibilité des navigateurs

Voir aussi

• Guide des collections indexées
• L'objet global Array
• La méthode Array.prototype.toString()
• La méthode TypedArray.prototype.toLocaleString()
• L'objet global Intl
• La propriété Intl.ListFormat
• La méthode Object.prototype.toLocaleString()
• La méthode Number.prototype.toLocaleString()
• La méthode Temporal.PlainDate.prototype.toLocaleString()