isWeekend.js 750 B

12345678910111213141516171819202122232425262728293031
  1. import { toDate } from "./toDate.js";
  2. /**
  3. * The {@link isWeekend} function options.
  4. */
  5. /**
  6. * @name isWeekend
  7. * @category Weekday Helpers
  8. * @summary Does the given date fall on a weekend?
  9. *
  10. * @description
  11. * Does the given date fall on a weekend? A weekend is either Saturday (`6`) or Sunday (`0`).
  12. *
  13. * @param date - The date to check
  14. * @param options - An object with options
  15. *
  16. * @returns The date falls on a weekend
  17. *
  18. * @example
  19. * // Does 5 October 2014 fall on a weekend?
  20. * const result = isWeekend(new Date(2014, 9, 5))
  21. * //=> true
  22. */
  23. export function isWeekend(date, options) {
  24. const day = toDate(date, options?.in).getDay();
  25. return day === 0 || day === 6;
  26. }
  27. // Fallback for modularized imports:
  28. export default isWeekend;