import toDate from '../toDate/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. * * ### 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 past * @throws {TypeError} 1 argument required * * @example * // If today is 6 October 2014, is 2 July 2014 in the past? * var result = isPast(new Date(2014, 6, 2)) * //=> true */ export default function isPast(dirtyDate) { if (arguments.length < 1) { throw new TypeError('1 argument required, but only ' + arguments.length + ' present'); } return toDate(dirtyDate).getTime() < Date.now(); }