28 lines
997 B
TypeScript
28 lines
997 B
TypeScript
|
/**
|
||
|
|
* @name setISOWeekYear
|
||
|
|
* @category ISO Week-Numbering Year Helpers
|
||
|
|
* @summary Set the ISO week-numbering year to the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Set the ISO week-numbering year to the given date,
|
||
|
|
* saving the week number and the weekday number.
|
||
|
|
*
|
||
|
|
* ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
|
||
|
|
*
|
||
|
|
* @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 weekYear - The ISO week-numbering year of the new date
|
||
|
|
*
|
||
|
|
* @returns The new date with the ISO week-numbering year set
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Set ISO week-numbering year 2007 to 29 December 2008:
|
||
|
|
* const result = setISOWeekYear(new Date(2008, 11, 29), 2007)
|
||
|
|
* //=> Mon Jan 01 2007 00:00:00
|
||
|
|
*/
|
||
|
|
export declare function setISOWeekYear<DateType extends Date>(
|
||
|
|
date: DateType | number | string,
|
||
|
|
weekYear: number,
|
||
|
|
): DateType;
|