23 lines
693 B
TypeScript
23 lines
693 B
TypeScript
|
/**
|
||
|
|
* @name getDaysInMonth
|
||
|
|
* @category Month Helpers
|
||
|
|
* @summary Get the number of days in a month of the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Get the number of days in a month of 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 given date
|
||
|
|
*
|
||
|
|
* @returns The number of days in a month
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // How many days are in February 2000?
|
||
|
|
* const result = getDaysInMonth(new Date(2000, 1))
|
||
|
|
* //=> 29
|
||
|
|
*/
|
||
|
|
export declare function getDaysInMonth<DateType extends Date>(
|
||
|
|
date: DateType | number | string,
|
||
|
|
): number;
|