Skip to content

isValidDateTimeCycleField

isValidDateTimeCycleField(field: unknown): field is DateTimeCycleField

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.

ParameterTypeDescription
fieldunknowncandidate value of any type

boolean indicating validity

import { isValidDateTimeCycleField } from "@northguild/gmt/plain/validate";
isValidDateTimeCycleField("year") // true
output 

plain/validate/isValidDateTimeCycleField.ts