hugoWebsite/node_modules/date-fns/esm/isThisMonth/index.js

28 lines
914 B
JavaScript
Raw Normal View History

2022-10-29 00:20:35 +02:00
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.
*
* @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?
* const result = isThisMonth(new Date(2014, 8, 15))
* //=> true
*/
export default function isThisMonth(dirtyDate) {
requiredArgs(1, arguments);
return isSameMonth(Date.now(), dirtyDate);
}