39 lines
1.3 KiB
TypeScript
39 lines
1.3 KiB
TypeScript
|
import type { ContextOptions, DateArg } from "./types.js";
|
||
|
|
/**
|
||
|
|
* The {@link setISODay} function options.
|
||
|
|
*/
|
||
|
|
export interface SetISODayOptions<DateType extends Date = Date>
|
||
|
|
extends ContextOptions<DateType> {}
|
||
|
|
/**
|
||
|
|
* @name setISODay
|
||
|
|
* @category Weekday Helpers
|
||
|
|
* @summary Set the day of the ISO week to the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Set the day of the ISO week to the given date.
|
||
|
|
* ISO week starts with Monday.
|
||
|
|
* 7 is the index of Sunday, 1 is the index of Monday, etc.
|
||
|
|
*
|
||
|
|
* @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
|
||
|
|
* @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
|
||
|
|
*
|
||
|
|
* @param date - The date to be changed
|
||
|
|
* @param day - The day of the ISO week of the new date
|
||
|
|
* @param options - An object with options
|
||
|
|
*
|
||
|
|
* @returns The new date with the day of the ISO week set
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Set Sunday to 1 September 2014:
|
||
|
|
* const result = setISODay(new Date(2014, 8, 1), 7)
|
||
|
|
* //=> Sun Sep 07 2014 00:00:00
|
||
|
|
*/
|
||
|
|
export declare function setISODay<
|
||
|
|
DateType extends Date,
|
||
|
|
ResultDate extends Date = DateType,
|
||
|
|
>(
|
||
|
|
date: DateArg<DateType>,
|
||
|
|
day: number,
|
||
|
|
options?: SetISODayOptions<ResultDate> | undefined,
|
||
|
|
): ResultDate;
|