timepiece/node_modules/date-fns/yearsToMonths.mjs

26 lines
584 B
JavaScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
import { monthsInYear } from "./constants.mjs";
/**
* @name yearsToMonths
* @category Conversion Helpers
* @summary Convert years to months.
*
* @description
* Convert a number of years to a full number of months.
*
* @param years - The number of years to be converted
*
* @returns The number of years converted in months
*
* @example
* // Convert 2 years into months
* const result = yearsToMonths(2)
* //=> 24
*/
export function yearsToMonths(years) {
return Math.trunc(years * monthsInYear);
}
// Fallback for modularized imports:
export default yearsToMonths;