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

29 lines
933 B
JavaScript

import isSameHour from "../isSameHour/index.js";
import requiredArgs from "../_lib/requiredArgs/index.js";
/**
* @name isThisHour
* @category Hour Helpers
* @summary Is the given date in the same hour as the current date?
* @pure false
*
* @description
* Is the given date in the same hour 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 hour
* @throws {TypeError} 1 argument required
*
* @example
* // If now is 25 September 2014 18:30:15.500,
* // is 25 September 2014 18:00:00 in this hour?
* const result = isThisHour(new Date(2014, 8, 25, 18))
* //=> true
*/
export default function isThisHour(dirtyDate) {
requiredArgs(1, arguments);
return isSameHour(Date.now(), dirtyDate);
}