isValidDateTimeUnit

Signature

isValidDateTimeUnit(unit: unknown): unit is DateTimeUnit

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

Return 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

Parameter	Type	Description
unit	unknown	candidate value of any type

Returns

boolean indicating validity

Related types

• DateTimeUnit
• TimeUnit

Examples

isValidDateTimeUnit("year") // true
isValidDateTimeUnit("month") // true
isValidDateTimeUnit("weeks") // false
isValidDateTimeUnit("invalid") // false
isValidDateTimeUnit(123) // false
isValidDateTimeUnit(null) // false

Source

plain/validate/isValidDateTimeUnit.ts