Array : mthode 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);
// Rsultat attendu : "1,a,12/21/1997, 2:12:00 PM",
// Ceci suppose la locale "en" et le fuseau horaire UTC : votre rsultat peut diffrer

Syntaxe

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

Paramtres

locales Facultatif

Une chane de caractres avec une tiquette de langue BCP 47, ou un tableau de telles chanes. Pour la forme gnrale et l'interprtation de l'argument locales, voir la description du paramtre sur la page principale de Intl.

options Facultatif

Un objet avec des proprits de configuration. Ce que vous pouvez passer ici dpend des lments convertir. Par exemple, pour les nombres, voir Number.prototype.toLocaleString().

Valeur de retour

Une chane de caractres qui reprsente les lments du tableau.

Description

La mthode Array.prototype.toLocaleString parcourt le contenu du tableau, appelle la mthode toLocaleString de chaque lment avec les paramtres locales et options fournis, puis concatne les rsultats avec un sparateur dfini par l'implmentation (par exemple une virgule ,).

Si un lment vaut undefined ou null, il est converti en chane de caractres vide au lieu de la chane de caractres "null" ou "undefined".

Lorsqu'elle est utilise sur un tableau creux, la mthode toLocaleString() parcourt les cases vides comme si elles avaient la valeur undefined.

La mthode toLocaleString() est gnrique. Elle attend seulement que la valeur de this possde une proprit length et des proprits cls entires.

Exemples

Utiliser les arguments locales et options

Chaque lment du tableau est converti en chane de caractres via sa mthode toLocaleString(). Par exemple, cet extrait appelle implicitement la mthode Number.prototype.toLocaleString() pour afficher la devise pour les chanes de caractres 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"

Sparateur de liste

Le sparateur de liste n'est pas affect par le paramtre locales. Pour le configurer, utilisez plutt 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,8889,999"

Tableau creux et mthode toLocaleString()

toLocaleString() traite les cases vides comme undefined et produit un sparateur supplmentaire :

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

Objet non tableau et mthode toLocaleString()

La mthode toLocaleString() lit la proprit length de this puis accde chaque proprit dont la cl est un entier non ngatif infrieur 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

Spcifications

Compatibilit des navigateurs

Voir aussi

• Guide des collections indexes
• L'objet global Array
• La mthode Array.prototype.toString()
• La mthode TypedArray.prototype.toLocaleString()
• L'objet global Intl
• La proprit Intl.ListFormat
• La mthode Object.prototype.toLocaleString()
• La mthode Number.prototype.toLocaleString()
• La mthode Temporal.PlainDate.prototype.toLocaleString()