isValidDateTimeUnit
Signature
Section titled “Signature”isValidDateTimeUnit(unit: unknown): unit is DateTimeUnitReturn true when unit is a valid DateTimeUnit.
- Valid units are: “year”, “month”, “week”, “day”, “hour”, “minute”, “second”, “millisecond”, “microsecond”, “nanosecond”.
- Accepts any input type and returns false for non-string values.
- Uses type assertion to narrow the type.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
unit | unknown | candidate value of any type |
Returns
Section titled “Returns”boolean indicating validity
Related types
Section titled “Related types”Examples
Section titled “Examples”import { isValidDateTimeUnit } from "@northguild/gmt/plain/validate";
isValidDateTimeUnit("year") // true