date-fns
Version:
Modern JavaScript date utility library
34 lines (32 loc) • 996 B
text/typescript
import type { ContextOptions, DateArg } from "./types.js";
/**
* The {@link differenceInCalendarYears} function options.
*/
export interface DifferenceInCalendarYearsOptions
extends ContextOptions<Date> {}
/**
* @name differenceInCalendarYears
* @category Year Helpers
* @summary Get the number of calendar years between the given dates.
*
* @description
* Get the number of calendar years between the given dates.
*
* @param laterDate - The later date
* @param earlierDate - The earlier date
* @param options - An object with options
* @returns The number of calendar years
*
* @example
* // How many calendar years are between 31 December 2013 and 11 February 2015?
* const result = differenceInCalendarYears(
* new Date(2015, 1, 11),
* new Date(2013, 11, 31)
* );
* //=> 2
*/
export declare function differenceInCalendarYears(
laterDate: DateArg<Date> & {},
earlierDate: DateArg<Date> & {},
options?: DifferenceInCalendarYearsOptions | undefined,
): number;