35 lines
1.1 KiB
JavaScript
35 lines
1.1 KiB
JavaScript
|
"use strict";
|
|||
|
|
|
|||
|
|
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
|
|||
|
|
Object.defineProperty(exports, "__esModule", {
|
|||
|
|
value: true
|
|||
|
|
});
|
|||
|
|
exports.default = isFuture;
|
|||
|
|
var _index = _interopRequireDefault(require("../toDate/index.js"));
|
|||
|
|
var _index2 = _interopRequireDefault(require("../_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.
|
|||
|
|
*
|
|||
|
|
* @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?
|
|||
|
|
* const result = isFuture(new Date(2014, 11, 31))
|
|||
|
|
* //=> true
|
|||
|
|
*/
|
|||
|
|
function isFuture(dirtyDate) {
|
|||
|
|
(0, _index2.default)(1, arguments);
|
|||
|
|
return (0, _index.default)(dirtyDate).getTime() > Date.now();
|
|||
|
|
}
|
|||
|
|
module.exports = exports.default;
|