quartersToYears.js 738 B

12345678910111213141516171819202122232425262728293031
  1. import { quartersInYear } from "./constants.js";
  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. * @param quarters - The number of quarters to be converted
  11. *
  12. * @returns The number of quarters converted in years
  13. *
  14. * @example
  15. * // Convert 8 quarters to years
  16. * const result = quartersToYears(8)
  17. * //=> 2
  18. *
  19. * @example
  20. * // It uses floor rounding:
  21. * const result = quartersToYears(11)
  22. * //=> 2
  23. */
  24. export function quartersToYears(quarters) {
  25. const years = quarters / quartersInYear;
  26. return Math.trunc(years);
  27. }
  28. // Fallback for modularized imports:
  29. export default quartersToYears;