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 das erste Jahr-Monat vor dem zweiten Jahr-Monat liegt, gleich wie dieses ist oder danach kommt. Es 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 behalten einen Referenz-ISO-Tag im Auge, der auch 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 festgelegt werden, was dazu führt, dass zwei äquivalente Jahr-Monate als unterschiedlich betrachtet werden, wenn sie unterschiedliche Referenztage haben. Aus diesem Grund sollten Sie vermeiden, den Konstruktor direkt zu verwenden, und besser die from()-Methode nutzen.

Syntax

Temporal.PlainYearMonth.compare(yearMonth1, yearMonth2)

Parameter

yearMonth1: Ein String, ein Objekt oder eine Instanz von Temporal.PlainYearMonth, die das erste zu vergleichende Jahr-Monat darstellt. Es wird in ein Temporal.PlainYearMonth-Objekt umgewandelt, unter Verwendung des gleichen Algorithmus wie Temporal.PlainYearMonth.from().
yearMonth2: Das zweite zu vergleichende Jahr-Monat, wird mit dem gleichen Algorithmus wie yearMonth1 in ein Temporal.PlainYearMonth-Objekt umgewandelt.

Rückgabewert

Gibt -1 zurück, wenn yearMonth1 vor yearMonth2 liegt, 0 wenn sie gleich sind, und 1 wenn yearMonth1 nach yearMonth2 kommt. Sie werden anhand ihrer zugrunde liegenden Datumswerte verglichen (üblicherweise 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 fungieren, 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 # sec-temporal.plainyearmonth.compare