27 lines
880 B
TypeScript
27 lines
880 B
TypeScript
|
/**
|
||
|
|
* @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).
|
||
|
|
*
|
||
|
|
* @param date - The date to be changed
|
||
|
|
* @param day - The day of the ISO week of the new date
|
||
|
|
*
|
||
|
|
* @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>(
|
||
|
|
date: DateType | number | string,
|
||
|
|
day: number,
|
||
|
|
): DateType;
|