UNPKG

445 BTypeScriptView Raw
1/**
2 * @name yearsToMonths
3 * @category Conversion Helpers
4 * @summary Convert years to months.
5 *
6 * @description
7 * Convert a number of years to a full number of months.
8 *
9 * @param years - The number of years to be converted
10 *
11 * @returns The number of years converted in months
12 *
13 * @example
14 * // Convert 2 years into months
15 * const result = yearsToMonths(2)
16 * //=> 24
17 */
18export declare function yearsToMonths(years: number): number;