30 lines
1023 B
TypeScript
30 lines
1023 B
TypeScript
/**
|
|
* @name isSameMonth
|
|
* @category Month Helpers
|
|
* @summary Are the given dates in the same month (and year)?
|
|
*
|
|
* @description
|
|
* Are the given dates in the same month (and year)?
|
|
*
|
|
* @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 dateLeft - The first date to check
|
|
* @param dateRight - The second date to check
|
|
*
|
|
* @returns The dates are in the same month (and year)
|
|
*
|
|
* @example
|
|
* // Are 2 September 2014 and 25 September 2014 in the same month?
|
|
* const result = isSameMonth(new Date(2014, 8, 2), new Date(2014, 8, 25))
|
|
* //=> true
|
|
*
|
|
* @example
|
|
* // Are 2 September 2014 and 25 September 2015 in the same month?
|
|
* const result = isSameMonth(new Date(2014, 8, 2), new Date(2015, 8, 25))
|
|
* //=> false
|
|
*/
|
|
export declare function isSameMonth<DateType extends Date>(
|
|
dateLeft: DateType | number | string,
|
|
dateRight: DateType | number | string,
|
|
): boolean;
|