51 lines
1.3 KiB
TypeScript
51 lines
1.3 KiB
TypeScript
|
import type { ContextOptions, DateArg, Interval } from "./types.js";
|
||
|
|
/**
|
||
|
|
* The {@link isWithinInterval} function options.
|
||
|
|
*/
|
||
|
|
export interface IsWithinIntervalOptions extends ContextOptions<Date> {}
|
||
|
|
/**
|
||
|
|
* @name isWithinInterval
|
||
|
|
* @category Interval Helpers
|
||
|
|
* @summary Is the given date within the interval?
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Is the given date within the interval? (Including start and end.)
|
||
|
|
*
|
||
|
|
* @param date - The date to check
|
||
|
|
* @param interval - The interval to check
|
||
|
|
* @param options - An object with options
|
||
|
|
*
|
||
|
|
* @returns The date is within the interval
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // For the date within the interval:
|
||
|
|
* isWithinInterval(new Date(2014, 0, 3), {
|
||
|
|
* start: new Date(2014, 0, 1),
|
||
|
|
* end: new Date(2014, 0, 7)
|
||
|
|
* })
|
||
|
|
* // => true
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // For the date outside of the interval:
|
||
|
|
* isWithinInterval(new Date(2014, 0, 10), {
|
||
|
|
* start: new Date(2014, 0, 1),
|
||
|
|
* end: new Date(2014, 0, 7)
|
||
|
|
* })
|
||
|
|
* // => false
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // For date equal to the interval start:
|
||
|
|
* isWithinInterval(date, { start, end: date })
|
||
|
|
* // => true
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // For date equal to the interval end:
|
||
|
|
* isWithinInterval(date, { start: date, end })
|
||
|
|
* // => true
|
||
|
|
*/
|
||
|
|
export declare function isWithinInterval(
|
||
|
|
date: DateArg<Date> & {},
|
||
|
|
interval: Interval,
|
||
|
|
options?: IsWithinIntervalOptions | undefined,
|
||
|
|
): boolean;
|