UNPKG

@burglekitt/gmt

Version:

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

github.com/burglekitt/gmt

burglekitt/gmt

21 lines (20 loc) • 995 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
/** * Restrict `value` to the range [`min`, `max`]. * * - Returns `value` if it falls within the bounds (inclusive on both ends). * - Returns `min` if `value` is before `min`. * - Returns `max` if `value` is after `max`. * - Returns `""` if any input is invalid or `min > max`. * * @param value ISO PlainDate string to clamp * @param min ISO PlainDate string for the lower bound (inclusive) * @param max ISO PlainDate string for the upper bound (inclusive) * @returns The clamped date string, or "" on invalid input * * @example clampDate("2024-03-15", "2024-03-01", "2024-03-31") // "2024-03-15" * @example clampDate("2024-02-01", "2024-03-01", "2024-03-31") // "2024-03-01" * @example clampDate("2024-05-01", "2024-03-01", "2024-03-31") // "2024-03-31" * @example clampDate("2024-03-15", "2024-03-31", "2024-03-01") // "" * @example clampDate("invalid", "2024-03-01", "2024-03-31") // "" */ export declare function clampDate(value: string, min: string, max: string): string;