32 lines
929 B
JavaScript
32 lines
929 B
JavaScript
|
"use strict";
|
||
|
|
|
||
|
|
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
|
||
|
|
Object.defineProperty(exports, "__esModule", {
|
||
|
|
value: true
|
||
|
|
});
|
||
|
|
exports.default = yearsToMonths;
|
||
|
|
var _index = _interopRequireDefault(require("../_lib/requiredArgs/index.js"));
|
||
|
|
var _index2 = require("../constants/index.js");
|
||
|
|
/**
|
||
|
|
* @name yearsToMonths
|
||
|
|
* @category Conversion Helpers
|
||
|
|
* @summary Convert years to months.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Convert a number of years to a full number of months.
|
||
|
|
*
|
||
|
|
* @param {number} years - number of years to be converted
|
||
|
|
*
|
||
|
|
* @returns {number} the number of years converted in months
|
||
|
|
* @throws {TypeError} 1 argument required
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Convert 2 years into months
|
||
|
|
* const result = yearsToMonths(2)
|
||
|
|
* //=> 24
|
||
|
|
*/
|
||
|
|
function yearsToMonths(years) {
|
||
|
|
(0, _index.default)(1, arguments);
|
||
|
|
return Math.floor(years * _index2.monthsInYear);
|
||
|
|
}
|
||
|
|
module.exports = exports.default;
|