Object : mthode toLocaleString()

Exemple interactif

const date = new Date(Date.UTC(2012, 11, 20, 3, 0, 0));

console.log(date.toLocaleString("ar-EG"));
// Rsultat attendu : "// :: "

const number = 123456.789;

console.log(number.toLocaleString("de-DE"));
// Rsultat attendu : "123.456,789"

Syntaxe

toLocaleString()

Paramtres

Aucun. Cependant, tous les objets qui redfinissent cette mthode sont censs accepter au maximum deux paramtres, correspondant locales et options, comme Number.prototype.toLocaleString. Les positions des paramtres ne doivent pas tre utilises d'autres fins.

Valeur de retour

La valeur de retour de l'appel this.toString().

Description

Tous les objets qui hritent de Object.prototype (c'est--dire tous sauf les objets avec prototype null) hritent de la mthode toLocaleString(). La mthode toLocaleString de Object retourne le rsultat de l'appel this.toString().

Cette fonction est fournie pour donner aux objets une mthode gnrique toLocaleString, mme si tous ne peuvent l'utiliser. Dans le langage de base, ces objets intgrs redfinissent toLocaleString pour fournir un formatage spcifique la locale :

• Array : Array.prototype.toLocaleString()
• Number : Number.prototype.toLocaleString()
• Date : Date.prototype.toLocaleString()
• TypedArray : TypedArray.prototype.toLocaleString()
• BigInt : BigInt.prototype.toLocaleString()

Exemples

Utiliser la mthode toLocaleString()

La mthode de base toLocaleString() appelle simplement toString().

const obj = {
  toString() {
    return "Mon Objet";
  },
};
console.log(obj.toLocaleString()); // "Mon Objet"

Surcharger la mthode toLocaleString() pour les tableaux

Array.prototype.toLocaleString() est utilis pour afficher les valeurs d'un tableau sous forme de chane de caractres en appelant la mthode toLocaleString() de chaque lment et en joignant les rsultats avec un sparateur spcifique la locale. Par exemple 

const tableauTest = [4, 7, 10];

const prixEuro = tableauTest.toLocaleString("fr", {
  style: "currency",
  currency: "EUR",
});
// "4,00 ,7,00 ,10,00 "

Surcharger la mthode toLocaleString() pour les dates

Date.prototype.toLocaleString() est utilis pour afficher les dates de manire plus adapte aux locales spcifiques. Par exemple :

const dateTest = new Date();
// "Fri May 29 2020 18:04:24 GMT+0100 (British Summer Time)"

const dateAllemande = dateTest.toLocaleString("de");
// "29.5.2020, 18:04:24"

const dateFrancaise = dateTest.toLocaleString("fr");
// "29/05/2020, 18:04:24"

Surcharger la mthode toLocaleString() pour les nombres

Number.prototype.toLocaleString() est utilis pour afficher les nombres de manire plus adapte aux locales spcifiques, par exemple avec les sparateurs corrects. Par exemple :

const nombreTest = 2901234564;
// "2901234564"

const nombreAllemand = nombreTest.toLocaleString("de");
// "2.901.234.564"

const nombreFrancais = nombreTest.toLocaleString("fr");
// "2 901 234 564"

Spcifications

Compatibilit des navigateurs

Voir aussi

• La mthode Object.prototype.toString()