Temporal.PlainYearMonth.compare()

Статический метод Temporal.PlainYearMonth.compare() возвращает число (-1, 0 или 1), указывающее, идет ли первый год-месяц перед вторым, совпадает ли он с ним или идет после него. Это эквивалентно сравнению их базовых дат ISO 8601. Два года-месяца из разных календарей могут считаться равными, если они начинаются в один и тот же день по ISO.

Синтаксис

Temporal.PlainYearMonth.compare(yearMonth1, yearMonth2)

Параметры

yearMonth1

Строка, объект или экземпляр Temporal.PlainYearMonth, представляющий первый сравниваемый год-месяц. Он преобразуется в объект Temporal.PlainYearMonth с использованием того же алгоритма, что и Temporal.PlainYearMonth.from().

yearMonth2

Второй сравниваемый год-месяц, преобразованный в объект Temporal.PlainYearMonth с использованием того же алгоритма, что и yearMonth1.

Возвращаемое значение

Возвращает -1, если yearMonth1 предшествует yearMonth2, 0, если они равны, и 1, если yearMonth1 следует за yearMonth2. Они сравниваются по своим базовым значениям даты (обычно первому дню месяца), игнорируя их календари.

Примеры

Использование 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

Сравнение годов-месяцев в разных календарях

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

Сортировка массива годов-месяцев

Назначение этой функции compare() — служить компаратором для передачи в Array.prototype.sort() и связанные с ним функции.

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]" ]

Спецификации

Совместимость с браузерами

См. также

• Temporal.PlainYearMonth
• Temporal.PlainYearMonth.prototype.equals()