date-manip/dist/diffInYears.d.ts

A lightweight JavaScript date utility library that provides modularity, high performance, and additional features. It supports various date operations, including date addition and subtraction, formatting, comparison, etc.

import { DateInput } from './types';
/**
 * Calculates the difference in months between two dates.
 * 计算两个日期之间的月份差
 *
 * @param date - The first date to compare.
 * @param input - The second date to compare.
 * @param asFloat - Whether to return the result as a float.
 * @returns The difference in months between the two dates.
 * @example
 * ```ts
 * diffInYears(new Date(), new Date()); // 0
 * diffInYears(new Date(), new Date(Date.now() + 1000 * 60 * 60 * 24 * 30)); // 1
 * diffInYears(new Date(), new Date(Date.now() - 1000 * 60 * 60 * 24 * 30)); // -1
 * diffInYears(new Date(), new Date(Date.now() - 1000 * 60 * 60 * 24 * 30 * 12)); // -1
 * diffInYears(new Date(), new Date(Date.now() - 1000 * 60 * 60 * 24 * 30 * 12 * 2)); // -2
 * ```
 */
export default function diffInYears(date: Date, input: DateInput, asFloat?: boolean): number;