differenceInCalendarYears.cjs 1.0 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. "use strict";
  2. exports.differenceInCalendarYears = differenceInCalendarYears;
  3. var _index = require("./_lib/normalizeDates.cjs");
  4. /**
  5. * The {@link differenceInCalendarYears} function options.
  6. */
  7. /**
  8. * @name differenceInCalendarYears
  9. * @category Year Helpers
  10. * @summary Get the number of calendar years between the given dates.
  11. *
  12. * @description
  13. * Get the number of calendar years between the given dates.
  14. *
  15. * @param laterDate - The later date
  16. * @param earlierDate - The earlier date
  17. * @param options - An object with options
  18. * @returns The number of calendar years
  19. *
  20. * @example
  21. * // How many calendar years are between 31 December 2013 and 11 February 2015?
  22. * const result = differenceInCalendarYears(
  23. * new Date(2015, 1, 11),
  24. * new Date(2013, 11, 31)
  25. * );
  26. * //=> 2
  27. */
  28. function differenceInCalendarYears(laterDate, earlierDate, options) {
  29. const [laterDate_, earlierDate_] = (0, _index.normalizeDates)(
  30. options?.in,
  31. laterDate,
  32. earlierDate,
  33. );
  34. return laterDate_.getFullYear() - earlierDate_.getFullYear();
  35. }