quartersToYears.js 900 B

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