index.js 929 B

1234567891011121314151617181920212223242526272829303132
  1. "use strict";
  2. var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
  3. Object.defineProperty(exports, "__esModule", {
  4. value: true
  5. });
  6. exports.default = yearsToMonths;
  7. var _index = _interopRequireDefault(require("../_lib/requiredArgs/index.js"));
  8. var _index2 = require("../constants/index.js");
  9. /**
  10. * @name yearsToMonths
  11. * @category Conversion Helpers
  12. * @summary Convert years to months.
  13. *
  14. * @description
  15. * Convert a number of years to a full number of months.
  16. *
  17. * @param {number} years - number of years to be converted
  18. *
  19. * @returns {number} the number of years converted in months
  20. * @throws {TypeError} 1 argument required
  21. *
  22. * @example
  23. * // Convert 2 years into months
  24. * const result = yearsToMonths(2)
  25. * //=> 24
  26. */
  27. function yearsToMonths(years) {
  28. (0, _index.default)(1, arguments);
  29. return Math.floor(years * _index2.monthsInYear);
  30. }
  31. module.exports = exports.default;