Temporal.Instant : méthode round()

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 round() des instances de Temporal.Instant retourne un nouvel objet Temporal.Instant représentant cet instant arrondi à l'unité donnée.

Une chaîne de caractères représentant l'option smallestUnit. Il s'agit d'une surcharge pratique, donc round(smallestUnit) est équivalent à round({ smallestUnit }), où smallestUnit est une chaîne de caractères.

options

Un objet contenant certaines ou toutes les propriétés suivantes (dans l'ordre où elles sont récupérées et validées) :

roundingIncrement Facultatif: Un nombre (tronqué à un entier) représentant l'incrément d'arrondi dans l'unité smallestUnit donnée. Par défaut, il est égal à 1. L'incrément et smallestUnit doivent diviser uniformément 24 heures ; par exemple, 45 secondes est un diviseur de 86400 secondes, et 100 minutes est un diviseur de 3600 minutes. Cela est légèrement moins strict que la méthode round() des autres classes, qui exigent toutes que l'incrément soit un diviseur de la valeur maximale de l'unité.
roundingMode Facultatif: Une chaîne de caractères définissant comment arrondir la partie fractionnaire de smallestUnit. Voir Intl.NumberFormat(). Par défaut, "halfExpand".
smallestUnit: Une chaîne de caractères représentant l'unité la plus petite à inclure dans la sortie. La valeur doit être l'une des suivantes : "hour", "minute", "second", "millisecond", "microsecond", "nanosecond", ou leurs formes plurielles. Pour les unités supérieures à "nanosecond", les parties fractionnaires de smallestUnit seront arrondies selon les paramètres roundingIncrement et roundingMode.

Valeur de retour

Un nouvel objet Temporal.Instant représentant cet instant arrondi à l'unité donnée, où toutes les unités inférieures à smallestUnit sont mises à zéro.

Exceptions

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

Exemples

Arrondir les petites unités

const instant = Temporal.Instant.fromEpochMilliseconds(1000);
const roundedInstant = instant.round("second");
console.log(roundedInstant.epochMilliseconds); // 1000

const instant2 = instant.round("minute");
console.log(instant2.epochMilliseconds); // 0