UNPKG

1.31 kBTypeScriptView Raw
1import type { Interval } from "./types.js";
2/**
3 * @name isWithinInterval
4 * @category Interval Helpers
5 * @summary Is the given date within the interval?
6 *
7 * @description
8 * Is the given date within the interval? (Including start and end.)
9 *
10 * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
11 *
12 * @param date - The date to check
13 * @param interval - The interval to check
14 *
15 * @returns The date is within the interval
16 *
17 * @example
18 * // For the date within the interval:
19 * isWithinInterval(new Date(2014, 0, 3), {
20 * start: new Date(2014, 0, 1),
21 * end: new Date(2014, 0, 7)
22 * })
23 * //=> true
24 *
25 * @example
26 * // For the date outside of the interval:
27 * isWithinInterval(new Date(2014, 0, 10), {
28 * start: new Date(2014, 0, 1),
29 * end: new Date(2014, 0, 7)
30 * })
31 * //=> false
32 *
33 * @example
34 * // For date equal to interval start:
35 * isWithinInterval(date, { start, end: date })
36 * // => true
37 *
38 * @example
39 * // For date equal to interval end:
40 * isWithinInterval(date, { start: date, end })
41 * // => true
42 */
43export declare function isWithinInterval<DateType extends Date>(
44 date: DateType | number | string,
45 interval: Interval<DateType>,
46): boolean;