Temporal.PlainYearMonth.compare()

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Die statische Methode Temporal.PlainYearMonth.compare() gibt eine Zahl (-1, 0 oder 1) zurück, die angibt, ob der erste Jahr-Monat vor dem zweiten Jahr-Monat liegt, gleich ist oder danach kommt. Dies entspricht dem Vergleich ihrer zugrunde liegenden ISO 8601-Daten. Zwei Jahr-Monate aus verschiedenen Kalendern können als gleich angesehen werden, wenn sie am gleichen ISO-Datum beginnen.

Hinweis:>PlainYearMonth-Objekte verfolgen einen Referenz-ISO-Tag, der ebenfalls im Vergleich verwendet wird. Dieser Tag wird automatisch gesetzt, wenn die Methode Temporal.PlainYearMonth.from() verwendet wird, kann jedoch manuell mit dem Temporal.PlainYearMonth() Konstruktor gesetzt werden. Dies kann dazu führen, dass zwei äquivalente Jahr-Monate als unterschiedlich angesehen werden, wenn sie unterschiedliche Referenztage haben. Aus diesem Grund sollten Sie es vermeiden, den Konstruktor direkt zu verwenden und stattdessen die from()-Methode bevorzugen.

Syntax

Temporal.PlainYearMonth.compare(yearMonth1, yearMonth2)

Parameter

yearMonth1: Ein String, ein Objekt oder eine Temporal.PlainYearMonth Instanz, die den ersten zu vergleichenden Jahr-Monat darstellt. Es wird mit demselben Algorithmus wie Temporal.PlainYearMonth.from() in ein Temporal.PlainYearMonth-Objekt umgewandelt.
yearMonth2: Der zweite zu vergleichende Jahr-Monat, der mit demselben Algorithmus wie yearMonth1 in ein Temporal.PlainYearMonth-Objekt umgewandelt wird.

Rückgabewert

Gibt -1 zurück, wenn yearMonth1 vor yearMonth2 kommt, 0, wenn sie gleich sind, und 1, wenn yearMonth1 nach yearMonth2 kommt. Sie werden nach ihren zugrunde liegenden Datumswerten verglichen (normalerweise der erste Tag des Monats), wobei ihre Kalender ignoriert werden.

Beispiele

Verwendung von Temporal.PlainYearMonth.compare()

const ym1 = Temporal.PlainYearMonth.from("2021-08");
const ym2 = Temporal.PlainYearMonth.from("2021-09");
console.log(Temporal.PlainYearMonth.compare(ym1, ym2)); // -1

const ym3 = Temporal.PlainYearMonth.from("2021-07");
console.log(Temporal.PlainYearMonth.compare(ym1, ym3)); // 1

Vergleich von Jahr-Monaten in verschiedenen Kalendern

const ym1 = Temporal.PlainYearMonth.from({ year: 2021, month: 8 });
const ym2 = Temporal.PlainYearMonth.from({
  year: 2021,
  month: 8,
  calendar: "islamic-umalqura",
});
const ym3 = Temporal.PlainYearMonth.from({
  year: 2021,
  month: 8,
  calendar: "hebrew",
});
console.log(ym1.toString()); // "2021-08"
console.log(ym2.toString()); // "2582-12-17[u-ca=islamic-umalqura]"
console.log(ym3.toString()); // "-001739-04-06[u-ca=hebrew]"
console.log(Temporal.PlainYearMonth.compare(ym1, ym2)); // -1
console.log(Temporal.PlainYearMonth.compare(ym1, ym3)); // 1

Sortieren eines Arrays von Jahr-Monaten

Der Zweck dieser compare()-Funktion besteht darin, als Vergleichsfunktion zu dienen, die an Array.prototype.sort() und verwandte Funktionen übergeben wird.

const months = [
  Temporal.PlainYearMonth.from({ year: 2021, month: 8 }),
  Temporal.PlainYearMonth.from({
    year: 2021,
    month: 8,
    calendar: "islamic-umalqura",
  }),
  Temporal.PlainYearMonth.from({ year: 2021, month: 8, calendar: "hebrew" }),
];

months.sort(Temporal.PlainYearMonth.compare);
console.log(months.map((d) => d.toString()));
// [ "-001739-04-06[u-ca=hebrew]", "2021-08", "2582-12-17[u-ca=islamic-umalqura]" ]

Spezifikationen

Specification
Temporal proposal # sec-temporal.plainyearmonth.compare