1234567891011121314151617181920212223242526272829303132 |
- import isSameMonth from "../isSameMonth/index.js";
- import requiredArgs from "../_lib/requiredArgs/index.js";
- /**
- * @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?
- *
- * > ⚠️ Please note that this function is not present in the FP submodule as
- * > it uses `Date.now()` internally hence impure and can't be safely curried.
- *
- * ### v2.0.0 breaking changes:
- *
- * - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes).
- *
- * @param {Date|Number} date - the date to check
- * @returns {Boolean} the date is in this month
- * @throws {TypeError} 1 argument required
- *
- * @example
- * // If today is 25 September 2014, is 15 September 2014 in this month?
- * var result = isThisMonth(new Date(2014, 8, 15))
- * //=> true
- */
- export default function isThisMonth(dirtyDate) {
- requiredArgs(1, arguments);
- return isSameMonth(Date.now(), dirtyDate);
- }
|