42 lines
1.3 KiB
TypeScript
42 lines
1.3 KiB
TypeScript
|
import type { ContextOptions, DateArg } from "./types.js";
|
||
|
|
/**
|
||
|
|
* The {@link differenceInCalendarDays} function options.
|
||
|
|
*/
|
||
|
|
export interface DifferenceInCalendarDaysOptions extends ContextOptions<Date> {}
|
||
|
|
/**
|
||
|
|
* @name differenceInCalendarDays
|
||
|
|
* @category Day Helpers
|
||
|
|
* @summary Get the number of calendar days between the given dates.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Get the number of calendar days between the given dates. This means that the times are removed
|
||
|
|
* from the dates and then the difference in days is calculated.
|
||
|
|
*
|
||
|
|
* @param laterDate - The later date
|
||
|
|
* @param earlierDate - The earlier date
|
||
|
|
* @param options - The options object
|
||
|
|
*
|
||
|
|
* @returns The number of calendar days
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // How many calendar days are between
|
||
|
|
* // 2 July 2011 23:00:00 and 2 July 2012 00:00:00?
|
||
|
|
* const result = differenceInCalendarDays(
|
||
|
|
* new Date(2012, 6, 2, 0, 0),
|
||
|
|
* new Date(2011, 6, 2, 23, 0)
|
||
|
|
* )
|
||
|
|
* //=> 366
|
||
|
|
* // How many calendar days are between
|
||
|
|
* // 2 July 2011 23:59:00 and 3 July 2011 00:01:00?
|
||
|
|
* const result = differenceInCalendarDays(
|
||
|
|
* new Date(2011, 6, 3, 0, 1),
|
||
|
|
* new Date(2011, 6, 2, 23, 59)
|
||
|
|
* )
|
||
|
|
* //=> 1
|
||
|
|
*/
|
||
|
|
export declare function differenceInCalendarDays(
|
||
|
|
laterDate: DateArg<Date> & {},
|
||
|
|
earlierDate: DateArg<Date> & {},
|
||
|
|
options?: DifferenceInCalendarDaysOptions | undefined,
|
||
|
|
): number;
|