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