/* eslint-disable eslint-comments/no-unlimited-disable */ /* eslint-disable */ // @ts-nocheck import { toDate } from '../toDate/index.ts'; import type { ContextOptions, DateArg, Interval } from '../types.ts'; /** * The {@link isWithinInterval} function options. */ export interface IsWithinIntervalOptions extends ContextOptions {} /** * @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 function isWithinInterval( date: DateArg & {}, interval: Interval, options?: IsWithinIntervalOptions | undefined, ): boolean { const time = +toDate(date, options?.in); const [startTime, endTime] = [+toDate(interval.start, options?.in), +toDate(interval.end, options?.in)].sort( (a, b) => a - b, ); return time >= startTime && time <= endTime; } /* eslint-enable */