Vlad Durnea
cffdf8af86
Some checks failed
CI/CD Pipeline / unit-tests (push) Failing after 1m16s
CI/CD Pipeline / integration-tests (push) Failing after 2m32s
CI/CD Pipeline / lint (push) Successful in 5m22s
CI/CD Pipeline / e2e-tests (push) Has been skipped
CI/CD Pipeline / build (push) Has been skipped
34 lines
923 B
JavaScript
34 lines
923 B
JavaScript
import { quartersInYear } from "./constants.mjs";
|
|
|
|
/**
|
|
* @name quartersToYears
|
|
* @category Conversion Helpers
|
|
* @summary Convert number of quarters to years.
|
|
*
|
|
* @description
|
|
* Convert a number of quarters to a full number of years.
|
|
*
|
|
* @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).
|
|
*
|
|
* @param quarters - The number of quarters to be converted
|
|
*
|
|
* @returns The number of quarters converted in years
|
|
*
|
|
* @example
|
|
* // Convert 8 quarters to years
|
|
* const result = quartersToYears(8)
|
|
* //=> 2
|
|
*
|
|
* @example
|
|
* // It uses floor rounding:
|
|
* const result = quartersToYears(11)
|
|
* //=> 2
|
|
*/
|
|
export function quartersToYears(quarters) {
|
|
const years = quarters / quartersInYear;
|
|
return Math.trunc(years);
|
|
}
|
|
|
|
// Fallback for modularized imports:
|
|
export default quartersToYears;
|