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

25 lines
738 B
TypeScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
/**
* @name setMonth
* @category Month Helpers
* @summary Set the month to the given date.
*
* @description
* Set the month 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 month - The month index to set (0-11)
*
* @returns The new date with the month set
*
* @example
* // Set February to 1 September 2014:
* const result = setMonth(new Date(2014, 8, 1), 1)
* //=> Sat Feb 01 2014 00:00:00
*/
export declare function setMonth<DateType extends Date>(
date: DateType | number | string,
month: number,
): DateType;