index.js 997 B

123456789101112131415161718192021222324252627282930313233
  1. "use strict";
  2. var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
  3. Object.defineProperty(exports, "__esModule", {
  4. value: true
  5. });
  6. exports.default = isWeekend;
  7. var _index = _interopRequireDefault(require("../toDate/index.js"));
  8. var _index2 = _interopRequireDefault(require("../_lib/requiredArgs/index.js"));
  9. /**
  10. * @name isWeekend
  11. * @category Weekday Helpers
  12. * @summary Does the given date fall on a weekend?
  13. *
  14. * @description
  15. * Does the given date fall on a weekend?
  16. *
  17. * @param {Date|Number} date - the date to check
  18. * @returns {Boolean} the date falls on a weekend
  19. * @throws {TypeError} 1 argument required
  20. *
  21. * @example
  22. * // Does 5 October 2014 fall on a weekend?
  23. * const result = isWeekend(new Date(2014, 9, 5))
  24. * //=> true
  25. */
  26. function isWeekend(dirtyDate) {
  27. (0, _index2.default)(1, arguments);
  28. var date = (0, _index.default)(dirtyDate);
  29. var day = date.getDay();
  30. return day === 0 || day === 6;
  31. }
  32. module.exports = exports.default;