33 lines
900 B
JavaScript
33 lines
900 B
JavaScript
|
"use strict";
|
||
|
|
exports.quartersToYears = quartersToYears;
|
||
|
|
var _index = require("./constants.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.
|
||
|
|
*
|
||
|
|
* @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
|
||
|
|
*/
|
||
|
|
function quartersToYears(quarters) {
|
||
|
|
const years = quarters / _index.quartersInYear;
|
||
|
|
return Math.trunc(years);
|
||
|
|
}
|