isValidUnixUnit
Signature
Section titled “Signature”isValidUnixUnit(unit: unknown): unit is UnixUnitReturn true when unit is a valid UnixUnit.
- Valid units are
"seconds","milliseconds"and their singular forms"second","millisecond"(Temporal §13.17 GetTemporalUnitValuedOption accepts both). - Names are case-sensitive; any non-string input returns false.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
unit | unknown | candidate value of any type |
Returns
Section titled “Returns”boolean indicating whether the unit is a valid UnixUnit
Related types
Section titled “Related types”Examples
Section titled “Examples”import { isValidUnixUnit } from "@northguild/gmt/unix/validate";
isValidUnixUnit("seconds") // true