Skip to main content
Module

x/date_fns/monthsToYears/index.ts

date-fns Deno package
Very Popular
Latest
File
import requiredArgs from '../_lib/requiredArgs/index.ts'import { monthsInYear } from '../constants/index.ts'
/** * @name monthsToYears * @category Conversion Helpers * @summary Convert number of months to years. * * @description * Convert a number of months to a full number of years. * * @param {number} months - number of months to be converted * * @returns {number} the number of months converted in years * @throws {TypeError} 1 argument required * * @example * // Convert 36 months to years: * const result = monthsToYears(36) * //=> 3 * * // It uses floor rounding: * const result = monthsToYears(40) * //=> 3 */export default function monthsToYears(months: number): number { requiredArgs(1, arguments) const years = months / monthsInYear return Math.floor(years)}