index.js 705 B

12345678910111213141516171819202122232425
  1. import toDate from "../toDate/index.js";
  2. import requiredArgs from "../_lib/requiredArgs/index.js";
  3. /**
  4. * @name isWeekend
  5. * @category Weekday Helpers
  6. * @summary Does the given date fall on a weekend?
  7. *
  8. * @description
  9. * Does the given date fall on a weekend?
  10. *
  11. * @param {Date|Number} date - the date to check
  12. * @returns {Boolean} the date falls on a weekend
  13. * @throws {TypeError} 1 argument required
  14. *
  15. * @example
  16. * // Does 5 October 2014 fall on a weekend?
  17. * const result = isWeekend(new Date(2014, 9, 5))
  18. * //=> true
  19. */
  20. export default function isWeekend(dirtyDate) {
  21. requiredArgs(1, arguments);
  22. var date = toDate(dirtyDate);
  23. var day = date.getDay();
  24. return day === 0 || day === 6;
  25. }