31 lines
890 B
JavaScript
31 lines
890 B
JavaScript
import { constructNow } from "./constructNow.mjs";
|
|
import { isSameMonth } from "./isSameMonth.mjs";
|
|
|
|
/**
|
|
* @name isThisMonth
|
|
* @category Month Helpers
|
|
* @summary Is the given date in the same month as the current date?
|
|
* @pure false
|
|
*
|
|
* @description
|
|
* Is the given date in the same month as the current 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 check
|
|
*
|
|
* @returns The date is in this month
|
|
*
|
|
* @example
|
|
* // If today is 25 September 2014, is 15 September 2014 in this month?
|
|
* const result = isThisMonth(new Date(2014, 8, 15))
|
|
* //=> true
|
|
*/
|
|
|
|
export function isThisMonth(date) {
|
|
return isSameMonth(date, constructNow(date));
|
|
}
|
|
|
|
// Fallback for modularized imports:
|
|
export default isThisMonth;
|