timepiece/node_modules/date-fns/monthsToYears.d.mts

23 lines
537 B
TypeScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
/**
* @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 months - The number of months to be converted
*
* @returns The number of months converted in years
*
* @example
* // Convert 36 months to years:
* const result = monthsToYears(36)
* //=> 3
*
* // It uses floor rounding:
* const result = monthsToYears(40)
* //=> 3
*/
export declare function monthsToYears(months: number): number;