25 lines
822 B
TypeScript
25 lines
822 B
TypeScript
|
/**
|
||
|
|
* @name subMonths
|
||
|
|
* @category Month Helpers
|
||
|
|
* @summary Subtract the specified number of months from the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Subtract the specified number of months from 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 amount - The amount of months to be subtracted.
|
||
|
|
*
|
||
|
|
* @returns The new date with the months subtracted
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Subtract 5 months from 1 February 2015:
|
||
|
|
* const result = subMonths(new Date(2015, 1, 1), 5)
|
||
|
|
* //=> Mon Sep 01 2014 00:00:00
|
||
|
|
*/
|
||
|
|
export declare function subMonths<DateType extends Date>(
|
||
|
|
date: DateType | number | string,
|
||
|
|
amount: number,
|
||
|
|
): DateType;
|