vremel/dist/datetime/withDayOfWeek.js

JavaScript date utility library for Temporal API

import { isZonedDateTime } from "../type-utils.js";
function withDayOfWeekForClockTime(dt, dayOfWeek, firstDayOfWeek) {
    const current = (dt.dayOfWeek - firstDayOfWeek + dt.daysInWeek) % dt.daysInWeek;
    const target = (dayOfWeek - firstDayOfWeek + dt.daysInWeek) % dt.daysInWeek;
    return dt.add({ days: target - current });
}
/**
 * Returns the datetime in the same week with specified day of a week.
 *
 * For `ZonedDateTime` this function behave like `Temporal.ZonedDateTime.prototype.with()`.
 * As well as `Temporal.ZonedDateTime.prototype.with()`, the result can be previous or next day of the desired day
 * depending on the `disambiguation` option for some edge cases.
 *
 * ```typescript
 * // In Greenland, 2024-03-30T23:10:00 doesn't exist due to DST
 * withDayOfWeek(
 *   Temporal.ZonedDateTime.from("2024-03-29T23:10:00-02:00[America/Nuuk]"),
 *   6, // Saturday
 *   { firstDayOfWeek: 1, disambiguation: "compatible" }
 * ); // 2024-03-31T00:10:00-01:00, Sunday!
 * // In Samoa, 2011-12-30 (Friday) is completely skipped due to an offset transition from `-10:00` to `+14:00`
 * withDayOfWeek(
 *   Temporal.ZonedDateTime.from("2011-12-29T00:00:00-10:00[Pacific/Apia]"),
 *   5, // Friday
 *   { firstDayOfWeek: 1, disambiguation: "compatible" }
 * ); // 2011-12-31T00:00:00+14:00, Saturday!
 * ```
 *
 * 'same week' is ambiguous and locale-dependent,
 * so `firstDayOfWeek` option is required.
 *
 * This function supports a calendar with a fixed `daysInWeek`,
 * even if the week contains more or less than 7 days.
 * But it doesn't support a calendar which lacks a fixed number of days.
 */
export function withDayOfWeek(dt, dayOfWeek, options) {
    const firstDayOfWeek = options.firstDayOfWeek;
    if (!Number.isInteger(firstDayOfWeek) ||
        firstDayOfWeek < 1 ||
        firstDayOfWeek > dt.daysInWeek) {
        throw new Error(`${firstDayOfWeek} isn't a valid day of week`);
    }
    if (isZonedDateTime(dt)) {
        const date = withDayOfWeekForClockTime(dt.toPlainDate(), dayOfWeek, firstDayOfWeek);
        return dt.with({
            year: date.year,
            month: date.month,
            day: date.day,
        }, { disambiguation: options.disambiguation, offset: options.offset });
    }
    return withDayOfWeekForClockTime(dt, dayOfWeek, firstDayOfWeek);
}
//# sourceMappingURL=withDayOfWeek.js.map