isValidTimeCycleField
Signature
Section titled “Signature”isValidTimeCycleField(field: unknown): field is TimeCycleFieldReturn 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.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
field | unknown | candidate value of any type |
Returns
Section titled “Returns”boolean indicating validity
Related types
Section titled “Related types”Examples
Section titled “Examples”import { isValidTimeCycleField } from "@northguild/gmt/plain/validate";
isValidTimeCycleField("hour") // true