Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
34 lines
996 B
Plaintext
34 lines
996 B
Plaintext
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;
|