Cette page a été traduite à partir de l'anglais par la communauté. Vous pouvez contribuer en rejoignant la communauté francophone sur MDN Web Docs.

View in English Always switch to English

Temporal.PlainMonthDay : méthode toLocaleString()

Disponibilité limitée

Cette fonctionnalité n'est pas Compatible car elle ne fonctionne pas dans certains des navigateurs les plus utilisés.

La méthode toLocaleString() des instances de Temporal.PlainMonthDay retourne une chaîne de caractères représentant ce mois et ce jour de manière sensible à la langue. Dans les implémentations prenant en charge l'API Intl.DateTimeFormat, cette méthode délègue à Intl.DateTimeFormat.

Chaque fois que toLocaleString est appelé, il doit effectuer une recherche dans une grande base de données de chaînes de caractères de localisation, ce qui peut être inefficace. Lorsque la méthode est appelée plusieurs fois avec les mêmes arguments, il est préférable de créer un objet Intl.DateTimeFormat et d'utiliser sa méthode format(), car un objet DateTimeFormat se souvient des arguments qui lui ont été passés et peut décider de mettre en cache une partie de la base de données, de sorte que les appels futurs à format peuvent rechercher des chaînes de localisation dans un contexte plus restreint.

Syntaxe

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

Paramètres

Les paramètres locales et options personnalisent le comportement de la fonction et permettent aux applications de définir la langue dont les conventions de formatage doivent être utilisées.

Dans les implémentations prenant en charge l'API Intl.DateTimeFormat, ces paramètres correspondent exactement aux paramètres du constructeur Intl.DateTimeFormat(). Les implémentations sans support de Intl.DateTimeFormat retournent exactement la même chaîne de caractères que toString(), en ignorant les deux paramètres.

locales Facultatif

Une chaîne de caractères avec une balise de langue BCP 47, ou un tableau de telles chaînes de caractères. Correspond au paramètre locales du constructeur Intl.DateTimeFormat().

options Facultatif

Un objet ajustant le format de sortie. Correspond au paramètre options du constructeur Intl.DateTimeFormat(). L'option calendar doit être fournie avec la même valeur que le calendrier de ce mois et ce jour. En ce qui concerne les options de composant date-heure et les raccourcis de style (dateStyle et timeStyle), les options doivent suivre l'une de ces formes :

  • Ne fournir aucune d'entre elles : month et day seront par défaut "numeric".
  • Fournir uniquement dateStyle : il se développe en formats month et day.
  • Fournir certaines options de composant date et heure, où au moins l'une d'entre elles est month ou day. Seuls les composants de date définis seront inclus dans la sortie.

Voir le constructeur Intl.DateTimeFormat() pour plus de détails sur ces paramètres et comment les utiliser.

Valeur de retour

Une chaîne de caractères représentant le mois et le jour donnés selon les conventions spécifiques à la langue.

Dans les implémentations prenant en charge Intl.DateTimeFormat, cela équivaut à new Intl.DateTimeFormat(locales, options).format(monthDay), où options a été normalisé comme décrit ci-dessus.

Note : La plupart du temps, le formatage retourné par toLocaleString() est cohérent. Cependant, la sortie peut varier entre les implémentations, même au sein du même locale — les variations de sortie sont prévues par la conception et autorisées par la spécification. Elle peut également ne pas être ce à quoi vous vous attendez. Par exemple, la chaîne de caractères peut utiliser des espaces insécables ou être entourée de caractères de contrôle bidirectionnels. Vous ne devez pas comparer les résultats de toLocaleString() à des constantes codées en dur.

Exceptions

RangeError

Levée si l'une des options est invalide.

TypeError

Levée si l'une des options n'est pas du type attendu.

Exemples

Utiliser la méthode toLocaleString()

Une utilisation simple de cette méthode sans définir de locale retourne une chaîne de caractères formatée dans le locale par défaut et avec les options par défaut.

js
// On notera que la simple spécification de "08-01" utilise par défaut le
// calendrier ISO 8601, ce qui génère une erreur si le calendrier par
// défaut du locale n'est pas ISO 8601.
const md = Temporal.PlainMonthDay.from("2021-08-01[u-ca=gregory]");

console.log(md.toLocaleString()); // 1 août (si le locale par défaut est fr-FR et le calendrier grégorien)

Si le calendrier du mois et du jour ne correspond pas au calendrier par défaut du locale, même lorsque son calendrier est iso8601, une option calendar explicite doit être fournie avec la même valeur.

js
const md = Temporal.PlainMonthDay.from("08-01");
md.toLocaleString("fr-FR", { calendar: "iso8601" }); // 08-01

Utiliser toLocaleString() avec des options

Vous pouvez personnaliser les parties du mois et du jour incluses dans la sortie en fournissant le paramètre options.

js
const md = Temporal.PlainMonthDay.from("2021-08-01[u-ca=gregory]");
md.toLocaleString("fr-FR", { dateStyle: "full" }); // 1 août
md.toLocaleString("fr-FR", { month: "long" }); // août
md.toLocaleString("fr-FR", { day: "numeric" }); // 1

Spécifications

Spécification
Temporal
# sec-temporal.plainmonthday.prototype.tolocalestring

Compatibilité des navigateurs

Voir aussi