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