UNPKG

@burglekitt/gmt

Version:

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

github.com/burglekitt/gmt

burglekitt/gmt

17 lines (16 loc) • 769 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import type { DateTimeCycleField } from "../../types/index.js"; /** * Return true when `field` is a valid DateTimeCycleField (a valid DateCycleField or * TimeCycleField). Used by `cycleDateTime` and `cycleZoned`, which can cycle either kind of field. * * @param field candidate value of any type * @returns boolean indicating validity * * @example isValidDateTimeCycleField("year") // true * @example isValidDateTimeCycleField("hour") // true * @example isValidDateTimeCycleField("week") // false * @example isValidDateTimeCycleField("invalid") // false * @example isValidDateTimeCycleField(123) // false * @example isValidDateTimeCycleField(null) // false */ export declare function isValidDateTimeCycleField(field: unknown): field is DateTimeCycleField;