UNPKG

@burglekitt/gmt

Version:

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

20 lines (19 loc) 871 B
import { isValidDateCycleField } from "./isValidDateCycleField.js"; import { isValidTimeCycleField } from "./isValidTimeCycleField.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 function isValidDateTimeCycleField(field) { return isValidDateCycleField(field) || isValidTimeCycleField(field); }