UNPKG

@burglekitt/gmt

Version:

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

github.com/burglekitt/gmt

burglekitt/gmt

19 lines (18 loc) • 776 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
import type { TimeCycleField } from "../../types/index.js"; /** * Return true when `field` is a valid TimeCycleField. * * - Valid fields are: "hour", "minute", "second", "millisecond", "microsecond", "nanosecond". * - Accepts any input type and returns false for non-string values. * * @param field candidate value of any type * @returns boolean indicating validity * * @example isValidTimeCycleField("hour") // true * @example isValidTimeCycleField("nanosecond") // true * @example isValidTimeCycleField("year") // false * @example isValidTimeCycleField("invalid") // false * @example isValidTimeCycleField(123) // false * @example isValidTimeCycleField(null) // false */ export declare function isValidTimeCycleField(field: unknown): field is TimeCycleField;