41 lines
1.4 KiB
TypeScript
41 lines
1.4 KiB
TypeScript
|
import type { ContextOptions, DateArg } from "./types.js";
|
||
|
|
/**
|
||
|
|
* The {@link addMonths} function options.
|
||
|
|
*/
|
||
|
|
export interface AddMonthsOptions<DateType extends Date = Date>
|
||
|
|
extends ContextOptions<DateType> {}
|
||
|
|
/**
|
||
|
|
* @name addMonths
|
||
|
|
* @category Month Helpers
|
||
|
|
* @summary Add the specified number of months to the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Add the specified number of months 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).
|
||
|
|
* @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 amount - The amount of months to be added.
|
||
|
|
* @param options - The options object
|
||
|
|
*
|
||
|
|
* @returns The new date with the months added
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Add 5 months to 1 September 2014:
|
||
|
|
* const result = addMonths(new Date(2014, 8, 1), 5)
|
||
|
|
* //=> Sun Feb 01 2015 00:00:00
|
||
|
|
*
|
||
|
|
* // Add one month to 30 January 2023:
|
||
|
|
* const result = addMonths(new Date(2023, 0, 30), 1)
|
||
|
|
* //=> Tue Feb 28 2023 00:00:00
|
||
|
|
*/
|
||
|
|
export declare function addMonths<
|
||
|
|
DateType extends Date,
|
||
|
|
ResultDate extends Date = DateType,
|
||
|
|
>(
|
||
|
|
date: DateArg<DateType>,
|
||
|
|
amount: number,
|
||
|
|
options?: AddMonthsOptions<ResultDate> | undefined,
|
||
|
|
): ResultDate;
|