quartersToYears.mjs 923 B

123456789101112131415161718192021222324252627282930313233
  1. import { quartersInYear } from "./constants.mjs";
  2. /**
  3. * @name quartersToYears
  4. * @category Conversion Helpers
  5. * @summary Convert number of quarters to years.
  6. *
  7. * @description
  8. * Convert a number of quarters to a full number of years.
  9. *
  10. * @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).
  11. *
  12. * @param quarters - The number of quarters to be converted
  13. *
  14. * @returns The number of quarters converted in years
  15. *
  16. * @example
  17. * // Convert 8 quarters to years
  18. * const result = quartersToYears(8)
  19. * //=> 2
  20. *
  21. * @example
  22. * // It uses floor rounding:
  23. * const result = quartersToYears(11)
  24. * //=> 2
  25. */
  26. export function quartersToYears(quarters) {
  27. const years = quarters / quartersInYear;
  28. return Math.trunc(years);
  29. }
  30. // Fallback for modularized imports:
  31. export default quartersToYears;