previousThursday.d.ts 1.2 KB

12345678910111213141516171819202122232425262728293031323334
  1. import type { ContextOptions, DateArg } from "./types.js";
  2. /**
  3. * The {@link previousThursday} function options.
  4. */
  5. export interface PreviousThursdayOptions<DateType extends Date = Date>
  6. extends ContextOptions<DateType> {}
  7. /**
  8. * @name previousThursday
  9. * @category Weekday Helpers
  10. * @summary When is the previous Thursday?
  11. *
  12. * @description
  13. * When is the previous Thursday?
  14. *
  15. * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
  16. * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
  17. *
  18. * @param date - The date to start counting from
  19. * @param options - An object with options
  20. *
  21. * @returns The previous Thursday
  22. *
  23. * @example
  24. * // When is the previous Thursday before Jun, 18, 2021?
  25. * const result = previousThursday(new Date(2021, 5, 18))
  26. * //=> Thu June 17 2021 00:00:00
  27. */
  28. export declare function previousThursday<
  29. DateType extends Date,
  30. ResultDate extends Date = DateType,
  31. >(
  32. date: DateArg<DateType>,
  33. options?: PreviousThursdayOptions<ResultDate> | undefined,
  34. ): ResultDate;