isTuesday.cjs 612 B

1234567891011121314151617181920212223242526272829
  1. "use strict";
  2. exports.isTuesday = isTuesday;
  3. var _index = require("./toDate.cjs");
  4. /**
  5. * The {@link isTuesday} function options.
  6. */
  7. /**
  8. * @name isTuesday
  9. * @category Weekday Helpers
  10. * @summary Is the given date Tuesday?
  11. *
  12. * @description
  13. * Is the given date Tuesday?
  14. *
  15. * @param date - The date to check
  16. * @param options - An object with options
  17. *
  18. * @returns The date is Tuesday
  19. *
  20. * @example
  21. * // Is 23 September 2014 Tuesday?
  22. * const result = isTuesday(new Date(2014, 8, 23))
  23. * //=> true
  24. */
  25. function isTuesday(date, options) {
  26. return (0, _index.toDate)(date, options?.in).getDay() === 2;
  27. }