isValidTimeUnit

Signature

isValidTimeUnit(unit: unknown): unit is TimeUnit

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

Return true when unit is a valid TimeUnit.

• Valid units are: “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

• TimeUnit

Examples

isValidTimeUnit("hour") // true
isValidTimeUnit("minute") // true
isValidTimeUnit("second") // true
isValidTimeUnit("invalid") // false
isValidTimeUnit(123) // false
isValidTimeUnit(null) // false

Source

plain/validate/isValidTimeUnit.ts