123456789101112131415161718192021222324252627 |
- import toDate from "../toDate/index.js";
- import requiredArgs from "../_lib/requiredArgs/index.js";
- /**
- * @name isPast
- * @category Common Helpers
- * @summary Is the given date in the past?
- * @pure false
- *
- * @description
- * Is the given date in the past?
- *
- * > ⚠️ 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 the past
- * @throws {TypeError} 1 argument required
- *
- * @example
- * // If today is 6 October 2014, is 2 July 2014 in the past?
- * const result = isPast(new Date(2014, 6, 2))
- * //=> true
- */
- export default function isPast(dirtyDate) {
- requiredArgs(1, arguments);
- return toDate(dirtyDate).getTime() < Date.now();
- }
|