isValidDateUnit

Signature

isValidDateUnit(unit: unknown): unit is DateUnit

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

Return true when unit is a valid DateUnit.

• Valid units are: “year”, “month”, “week”, “day”.
• Accepts any input type and returns false for non-string values.
• Uses type assertion to narrow the type.

Parameters

Parameter	Type	Description
unit	unknown	candidate value of any type

Returns

boolean indicating validity

Related types

• DateUnit

Examples

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

Source

plain/validate/isValidDateUnit.ts