1234567891011121314151617181920212223242526272829 |
- import type { ContextOptions, DateArg } from "./types.js";
- /**
- * The {@link differenceInYears} function options.
- */
- export interface DifferenceInYearsOptions extends ContextOptions<Date> {}
- /**
- * @name differenceInYears
- * @category Year Helpers
- * @summary Get the number of full years between the given dates.
- *
- * @description
- * Get the number of full 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 full years
- *
- * @example
- * // How many full years are between 31 December 2013 and 11 February 2015?
- * const result = differenceInYears(new Date(2015, 1, 11), new Date(2013, 11, 31))
- * //=> 1
- */
- export declare function differenceInYears(
- laterDate: DateArg<Date> & {},
- earlierDate: DateArg<Date> & {},
- options?: DifferenceInYearsOptions | undefined,
- ): number;
|