vremel/dist/datetime/withDayOfWeek.d.ts

JavaScript date utility library for Temporal API

import type { Temporal } from "../types.js";
export interface WithDayOfWeekOptions {
    /**
     * First day of the week.
     * For example, in ISO calendar Monday is `1`, Sunday is `7`.
     */
    firstDayOfWeek: number;
    /**
     * Same to `disambiguation` option in `Temporal.ZonedDateTime.prototype.with()`.
     * For other types it will be simply ignored.
     */
    disambiguation?: "compatible" | "earlier" | "later" | "reject";
    /**
     * Same to `offset` option in `Temporal.ZonedDateTime.prototype.with()`.
     * For other types it will be simply ignored.
     */
    offset?: "use" | "prefer" | "ignore" | "reject";
}
/**
 * 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 declare function withDayOfWeek<DateTime extends Temporal.PlainDate | Temporal.PlainDateTime | Temporal.ZonedDateTime>(dt: DateTime, dayOfWeek: number, options: WithDayOfWeekOptions): DateTime;
//# sourceMappingURL=withDayOfWeek.d.ts.map