isValidTimeCycleField

Signature

isValidTimeCycleField(field: unknown): field is TimeCycleField

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

Return 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

Parameter	Type	Description
field	unknown	candidate value of any type

Returns

boolean indicating validity

Related types

• TimeCycleField

Examples

isValidTimeCycleField("hour") // true
isValidTimeCycleField("nanosecond") // true
isValidTimeCycleField("year") // false
isValidTimeCycleField("invalid") // false
isValidTimeCycleField(123) // false
isValidTimeCycleField(null) // false

Source

plain/validate/isValidTimeCycleField.ts