isThursday.d.cts 678 B

123456789101112131415161718192021222324252627
  1. import type { ContextOptions, DateArg } from "./types.js";
  2. /**
  3. * The {@link isThursday} function options.
  4. */
  5. export interface IsThursdayOptions extends ContextOptions<Date> {}
  6. /**
  7. * @name isThursday
  8. * @category Weekday Helpers
  9. * @summary Is the given date Thursday?
  10. *
  11. * @description
  12. * Is the given date Thursday?
  13. *
  14. * @param date - The date to check
  15. * @param options - An object with options
  16. *
  17. * @returns The date is Thursday
  18. *
  19. * @example
  20. * // Is 25 September 2014 Thursday?
  21. * const result = isThursday(new Date(2014, 8, 25))
  22. * //=> true
  23. */
  24. export declare function isThursday(
  25. date: DateArg<Date> & {},
  26. options?: IsThursdayOptions | undefined,
  27. ): boolean;