isValidDateCycleField

Signature

isValidDateCycleField(field: unknown): field is DateCycleField

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

Return true when field is a valid DateCycleField.

• Valid fields are: “year”, “month”, “day”.
• Accepts any input type and returns false for non-string values.
• Note “week” is a valid DateUnit elsewhere in GMT but is NOT a valid cycle field — it isn’t a .with()-settable field, so it can’t be cycled.

Parameters

Parameter	Type	Description
field	unknown	candidate value of any type

Returns

boolean indicating validity

Related types

• DateCycleField

Examples

isValidDateCycleField("year") // true
isValidDateCycleField("month") // true
isValidDateCycleField("day") // true
isValidDateCycleField("week") // false
isValidDateCycleField("invalid") // false
isValidDateCycleField(123) // false
isValidDateCycleField(null) // false

Source

plain/validate/isValidDateCycleField.ts