differenceInCalendarISOWeeks.d.cts 1.1 KB

1234567891011121314151617181920212223242526272829303132333435
  1. import type { ContextOptions, DateArg } from "./types.js";
  2. /**
  3. * The {@link differenceInCalendarISOWeeks} function options.
  4. */
  5. export interface DifferenceInCalendarISOWeeksOptions
  6. extends ContextOptions<Date> {}
  7. /**
  8. * @name differenceInCalendarISOWeeks
  9. * @category ISO Week Helpers
  10. * @summary Get the number of calendar ISO weeks between the given dates.
  11. *
  12. * @description
  13. * Get the number of calendar ISO weeks between the given dates.
  14. *
  15. * ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
  16. *
  17. * @param laterDate - The later date
  18. * @param earlierDate - The earlier date
  19. * @param options - An object with options
  20. *
  21. * @returns The number of calendar ISO weeks
  22. *
  23. * @example
  24. * // How many calendar ISO weeks are between 6 July 2014 and 21 July 2014?
  25. * const result = differenceInCalendarISOWeeks(
  26. * new Date(2014, 6, 21),
  27. * new Date(2014, 6, 6),
  28. * );
  29. * //=> 3
  30. */
  31. export declare function differenceInCalendarISOWeeks(
  32. laterDate: DateArg<Date> & {},
  33. earlierDate: DateArg<Date> & {},
  34. options?: DifferenceInCalendarISOWeeksOptions | undefined,
  35. ): number;