differenceInCalendarISOWeekYears.d.ts 1.2 KB

1234567891011121314151617181920212223242526272829303132333435
  1. import type { ContextOptions, DateArg } from "./types.js";
  2. /**
  3. * The {@link differenceInCalendarISOWeekYears} function options.
  4. */
  5. export interface DifferenceInCalendarISOWeekYearsOptions
  6. extends ContextOptions<Date> {}
  7. /**
  8. * @name differenceInCalendarISOWeekYears
  9. * @category ISO Week-Numbering Year Helpers
  10. * @summary Get the number of calendar ISO week-numbering years between the given dates.
  11. *
  12. * @description
  13. * Get the number of calendar ISO week-numbering years 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 week-numbering years
  22. *
  23. * @example
  24. * // How many calendar ISO week-numbering years are 1 January 2010 and 1 January 2012?
  25. * const result = differenceInCalendarISOWeekYears(
  26. * new Date(2012, 0, 1),
  27. * new Date(2010, 0, 1)
  28. * )
  29. * //=> 2
  30. */
  31. export declare function differenceInCalendarISOWeekYears(
  32. laterDate: DateArg<Date> & {},
  33. earlierDate: DateArg<Date> & {},
  34. options?: DifferenceInCalendarISOWeekYearsOptions | undefined,
  35. ): number;