Temporal.Duration : méthode statique compare()

Syntaxe

Temporal.Duration.compare(duration1, duration2)
Temporal.Duration.compare(duration1, duration2, options)

Paramètres

duration1

Une chaîne de caractères, un objet ou une instance de Temporal.Duration représentant la première durée à comparer. Elle est convertie en objet Temporal.Duration en utilisant le même algorithme que Temporal.Duration.from().

duration2

La seconde durée à comparer, convertie en objet Temporal.Duration en utilisant le même algorithme que duration1.

options Facultatif

Un objet contenant la propriété suivante :

relativeTo Facultatif

Une date avec un fuseau horaire ou une date(heure) normale qui fournit les informations de temps et de calendrier pour résoudre les durées de calendrier (voir le lien pour l'interprétation générale de cette option). Requis si duration1 ou duration2 est une durée de calendrier (à moins qu'elles ne soient égales composant par composant, auquel cas 0 est retourné sans calculs).

Valeur de retour

Retourne -1 si duration1 est plus courte que duration2, 0 si elles sont égales, et 1 si duration1 est plus longue que duration2.

Exceptions

RangeError

Levée si duration1 ou duration2 est une durée de calendrier (elle a des years, months ou weeks non nuls), et que relativeTo n'est pas fourni.

Description

Si relativeTo est une date et heure avec un fuseau horaire, et que duration1 ou duration2 est une durée de calendrier, le résultat est calculé en ajoutant les durées au point de départ, puis en comparant les instants résultants. Sinon, la comparaison se fait en convertissant les deux durées en nanosecondes (en supposant des jours de 24 heures, et en utilisant le calendrier de relativeTo si nécessaire) et en comparant les résultats.

Exemples

Utiliser la méthode compare()

const d1 = Temporal.Duration.from({ hours: 1, minutes: 30 });
const d2 = Temporal.Duration.from({ minutes: 100 });
console.log(Temporal.Duration.compare(d1, d2)); // -1

const d3 = Temporal.Duration.from({ hours: 2 });
const d4 = Temporal.Duration.from({ minutes: 110 });
console.log(Temporal.Duration.compare(d3, d4)); // 1

const d5 = Temporal.Duration.from({ hours: 1, minutes: 30 });
const d6 = Temporal.Duration.from({ seconds: 5400 });
console.log(Temporal.Duration.compare(d5, d6)); // 0

Comparer des durées de calendrier

const d1 = Temporal.Duration.from({ days: 31 });
const d2 = Temporal.Duration.from({ months: 1 });

console.log(
  Temporal.Duration.compare(d1, d2, {
    relativeTo: Temporal.PlainDate.from("2021-01-01"), // calendrier ISO 8601
  }),
); // 0

console.log(
  Temporal.Duration.compare(d1, d2, {
    relativeTo: Temporal.PlainDate.from("2021-02-01"), // calendrier ISO 8601
  }),
); // 1; février a 28 jours

Utiliser relativeTo avec fuseau horaire

En utilisant un relativeTo avec fuseau horaire, vous pouvez même prendre en compte les changements d'heure d'été. Le 3 novembre 2024, les États-Unis passent de l'heure d'été à l'heure standard, donc ce jour-là a 25 heures car l'horloge est reculée d'une heure.

const d1 = Temporal.Duration.from({ days: 1 });
const d2 = Temporal.Duration.from({ hours: 24 });

console.log(
  Temporal.Duration.compare(d1, d2, {
    relativeTo: Temporal.ZonedDateTime.from(
      "2024-11-03T01:00-04:00[America/New_York]",
    ),
  }),
); // 1

Trier un tableau de durées

Le but de cette fonction compare() est d'agir comme un comparateur à passer à Array.prototype.sort() et aux fonctions associées.

const durations = [
  Temporal.Duration.from({ hours: 1 }),
  Temporal.Duration.from({ hours: 2 }),
  Temporal.Duration.from({ hours: 1, minutes: 30 }),
  Temporal.Duration.from({ hours: 1, minutes: 45 }),
];

durations.sort(Temporal.Duration.compare);
console.log(durations.map((d) => d.toString()));
// [ 'PT1H', 'PT1H30M', 'PT1H45M', 'PT2H' ]

Passer des options comme ceci :

durations.sort((a, b) =>
  Temporal.Duration.compare(a, b, {
    relativeTo: Temporal.Now.zonedDateTimeISO(),
  }),
);

Spécifications

Compatibilité des navigateurs

Voir aussi

• L'objet Temporal.Duration
• La méthode Temporal.Duration.prototype.subtract()