index.js 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", {
  3. value: true
  4. });
  5. exports.default = isWeekend;
  6. var _index = _interopRequireDefault(require("../toDate/index.js"));
  7. var _index2 = _interopRequireDefault(require("../_lib/requiredArgs/index.js"));
  8. function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
  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. * ### v2.0.0 breaking changes:
  18. *
  19. * - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes).
  20. *
  21. * @param {Date|Number} date - the date to check
  22. * @returns {Boolean} the date falls on a weekend
  23. * @throws {TypeError} 1 argument required
  24. *
  25. * @example
  26. * // Does 5 October 2014 fall on a weekend?
  27. * const result = isWeekend(new Date(2014, 9, 5))
  28. * //=> true
  29. */
  30. function isWeekend(dirtyDate) {
  31. (0, _index2.default)(1, arguments);
  32. var date = (0, _index.default)(dirtyDate);
  33. var day = date.getDay();
  34. return day === 0 || day === 6;
  35. }
  36. module.exports = exports.default;