UNPKG

@burglekitt/gmt

Version:

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

github.com/burglekitt/gmt

burglekitt/gmt

22 lines (21 loc) • 798 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
import type { DateUnit } from "../../types/index.js"; /** * Return true when `unit` is a valid DateUnit. * * - Valid units are: "year", "month", "week", "day". * - Accepts any input type and returns false for non-string values. * - Uses type assertion to narrow the type. * * @param unit candidate value of any type * @returns boolean indicating validity * * @example isValidDateUnit("year") // true * @example isValidDateUnit("month") // true * @example isValidDateUnit("week") // true * @example isValidDateUnit("day") // true * @example isValidDateUnit("hour") // false * @example isValidDateUnit("invalid") // false * @example isValidDateUnit(123) // false * @example isValidDateUnit(null) // false */ export declare function isValidDateUnit(unit: unknown): unit is DateUnit;