vremel/src/datetime/latest.ts

JavaScript date utility library for Temporal API

import { isPlainMonthDay } from "../type-utils.js";
import type { ArrayOf, Temporal } from "../types.js";
import { compare } from "./_compare.js";

/**
 * Returns the latest of the given datetime objects.
 * @param dateTimes array of datetime objects
 * @returns the latest of the datetime objects
 */
export function latest<
	DateTime extends
		| Temporal.Instant
		| Temporal.ZonedDateTime
		| Temporal.PlainDate
		| Temporal.PlainTime
		| Temporal.PlainDateTime
		| Temporal.PlainYearMonth,
>(dateTimes: ArrayOf<DateTime>): DateTime {
	if (dateTimes.some(isPlainMonthDay)) {
		throw new Error("Can't compare PlainMonthDay");
	}
	return dateTimes.reduce((a, b) => (compare(a, b) === -1 ? b : a)) as DateTime;
}