isValidDateTimeCycleField

Signature

isValidDateTimeCycleField(field: unknown): field is DateTimeCycleField

import { isValidDateTimeCycleField } from "@northguild/gmt/plain/validate";

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.

Parameters

Parameter	Type	Description
field	unknown	candidate value of any type

Returns

boolean indicating validity

Related types

• DateTimeCycleField
• TimeCycleField

Examples

isValidDateTimeCycleField("year") // true
isValidDateTimeCycleField("hour") // true
isValidDateTimeCycleField("week") // false
isValidDateTimeCycleField("invalid") // false
isValidDateTimeCycleField(123) // false
isValidDateTimeCycleField(null) // false

Source

plain/validate/isValidDateTimeCycleField.ts