Temporal.PlainTime : 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.PlainTime retourne une chaîne de caractères représentant cette heure 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ée, elle 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 caractères de localisation dans un contexte plus restreint.

Syntaxe

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(). Concernant les options de composant de date et d'heure et les raccourcis de style (dateStyle et timeStyle), les options doivent suivre l'une de ces formes :

Ne fournir aucune d'entre elles : hour, minute et second seront par défaut "numeric".
Fournir uniquement timeStyle : cela se développe en formats dayPeriod, hour, minute, second et fractionalSecondDigits.
Fournir certaines options de composant date-heure, où au moins une d'entre elles est une option de temps (dayPeriod, hour, minute, second, fractionalSecondDigits). Seuls les composants de temps spécifiés 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 l'heure donnée selon les conventions spécifiques à la langue.

Dans les implémentations avec Intl.DateTimeFormat, cela équivaut à new Intl.DateTimeFormat(locales, options).format(time), 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 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.

const time = Temporal.PlainTime.from("12:34:56");

console.log(time.toLocaleString()); // 12:34:56 PM (en supposant la locale en-US)

Utiliser `toLocaleString()` avec des options

Vous pouvez personnaliser les parties de l'heure incluses dans la sortie en fournissant le paramètre options.

const time = Temporal.PlainTime.from("12:34:56");
time.toLocaleString("en-US", { timeStyle: "short" }); // 12:34 PM
time.toLocaleString("en-US", { hour: "2-digit" }); // 12 PM

Spécifications

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

Compatibilité des navigateurs

Voir aussi

L'objet Temporal.PlainTime
L'objet Intl.DateTimeFormat
La méthode Temporal.PlainTime.prototype.toJSON()
La méthode Temporal.PlainTime.prototype.toString()

Aider à améliorer MDN

Apprendre à contribuer

Cette page a été modifiée le 29 mars 2026 par les contributeur·ice·s du MDN.

Voir cette page sur GitHub • Signaler un problème avec ce contenu