timepiece/node_modules/date-fns/setYear.d.ts

25 lines
728 B
TypeScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
/**
* @name setYear
* @category Year Helpers
* @summary Set the year to the given date.
*
* @description
* Set the year to the given 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 year - The year of the new date
*
* @returns The new date with the year set
*
* @example
* // Set year 2013 to 1 September 2014:
* const result = setYear(new Date(2014, 8, 1), 2013)
* //=> Sun Sep 01 2013 00:00:00
*/
export declare function setYear<DateType extends Date>(
date: DateType | number | string,
year: number,
): DateType;