31 lines
825 B
JavaScript
31 lines
825 B
JavaScript
|
import requiredArgs from "../_lib/requiredArgs/index.js";
|
||
|
|
import { quartersInYear } from "../constants/index.js";
|
||
|
|
/**
|
||
|
|
* @name quartersToYears
|
||
|
|
* @category Conversion Helpers
|
||
|
|
* @summary Convert number of quarters to years.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Convert a number of quarters to a full number of years.
|
||
|
|
*
|
||
|
|
* @param {number} quarters - number of quarters to be converted
|
||
|
|
*
|
||
|
|
* @returns {number} the number of quarters converted in years
|
||
|
|
* @throws {TypeError} 1 argument required
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Convert 8 quarters to years
|
||
|
|
* const result = quartersToYears(8)
|
||
|
|
* //=> 2
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // It uses floor rounding:
|
||
|
|
* const result = quartersToYears(11)
|
||
|
|
* //=> 2
|
||
|
|
*/
|
||
|
|
|
||
|
|
export default function quartersToYears(quarters) {
|
||
|
|
requiredArgs(1, arguments);
|
||
|
|
var years = quarters / quartersInYear;
|
||
|
|
return Math.floor(years);
|
||
|
|
}
|