UNPKG

@burglekitt/gmt

Version:

Temporal-based date and time utilities with timezone support and polyfill integration

github.com/burglekitt/gmt

burglekitt/gmt

27 lines (26 loc) • 1.58 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
/** * Return true when `dateTime` is between `start` and `end` (inclusive by default). * * - Uses Temporal.PlainDateTime.compare to compare date-times. * - Returns false if start > end (invalid range). * - Returns false if any input is invalid. * - Use options.inclusiveStart and options.inclusiveEnd to control boundary inclusivity. * * @param dateTime ISO PlainDateTime string to check * @param start ISO PlainDateTime string for the start of the range * @param end ISO PlainDateTime string for the end of the range * @param options { inclusiveStart?: boolean = true, inclusiveEnd?: boolean = true } * @returns boolean indicating whether dateTime is between start and end * * @example isBetweenDateTime("2024-02-29T12:00:00", "2024-02-01T00:00:00", "2024-02-28T23:59:59") // false * @example isBetweenDateTime("2024-02-29T12:00:00", "2024-02-01T00:00:00", "2024-02-29T12:00:00") // true * @example isBetweenDateTime("2024-02-29T12:00:00", "2024-02-29T12:00:00", "2024-02-28T23:59:59") // false * @example isBetweenDateTime("2024-02-29T12:00:00", "2024-02-28T23:59:59", "2024-03-01T00:00:00") // true * @example isBetweenDateTime("invalid", "2024-02-01T00:00:00", "2024-02-28T23:59:59") // false * @example isBetweenDateTime("2024-02-29T12:00:00", "invalid", "2024-02-28T23:59:59") // false * @example isBetweenDateTime("2024-02-29T12:00:00", "2024-02-01T00:00:00", "invalid") // false */ export declare function isBetweenDateTime(dateTime: string, start: string, end: string, options?: { inclusiveStart?: boolean; inclusiveEnd?: boolean; }): boolean;