UNPKG

@burglekitt/gmt

Version:

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

github.com/burglekitt/gmt

burglekitt/gmt

20 lines (19 loc) • 753 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
import type { TimeUnit } from "../../types/index.js"; /** * Return true when `unit` is a valid TimeUnit. * * - Valid units are: "hour", "minute", "second", "millisecond", "microsecond", "nanosecond". * - 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 isValidTimeUnit("hour") // true * @example isValidTimeUnit("minute") // true * @example isValidTimeUnit("second") // true * @example isValidTimeUnit("invalid") // false * @example isValidTimeUnit(123) // false * @example isValidTimeUnit(null) // false */ export declare function isValidTimeUnit(unit: unknown): unit is TimeUnit;