23 lines
628 B
TypeScript
23 lines
628 B
TypeScript
/**
|
|
* @name getMonth
|
|
* @category Month Helpers
|
|
* @summary Get the month of the given date.
|
|
*
|
|
* @description
|
|
* Get the 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 month index (0-11)
|
|
*
|
|
* @example
|
|
* // Which month is 29 February 2012?
|
|
* const result = getMonth(new Date(2012, 1, 29))
|
|
* //=> 1
|
|
*/
|
|
export declare function getMonth<DateType extends Date>(
|
|
date: DateType | number | string,
|
|
): number;
|