isValidDateTimeDurationUnit

Signature

isValidDateTimeDurationUnit(unit: string): unit is keyof DurationLike

Return true when unit is a valid DateTimeDurationUnit.

• Valid units are: “years”, “months”, “weeks”, “days”, “hours”, “minutes”, “seconds”, “milliseconds”, “microseconds”, “nanoseconds”.
• Uses type assertion to narrow the type.

Parameters

Parameter	Type	Description
unit	string	candidate string

Returns

boolean indicating validity

Related types

• DateTimeDurationUnit

Examples

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

isValidDateTimeDurationUnit("days") // true

unit

output

 

Source

plain/validate/isValidDateTimeDurationUnit.ts