index.js 824 B

123456789101112131415161718192021222324252627282930
  1. import requiredArgs from "../_lib/requiredArgs/index.js";
  2. import { quartersInYear } from "../constants/index.js";
  3. /**
  4. * @name quartersToYears
  5. * @category Conversion Helpers
  6. * @summary Convert number of quarters to years.
  7. *
  8. * @description
  9. * Convert a number of quarters to a full number of years.
  10. *
  11. * @param {number} quarters - number of quarters to be converted
  12. *
  13. * @returns {number} the number of quarters converted in years
  14. * @throws {TypeError} 1 argument required
  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 default function quartersToYears(quarters) {
  27. requiredArgs(1, arguments);
  28. var years = quarters / quartersInYear;
  29. return Math.floor(years);
  30. }