isValidUnixUnit

Signature

isValidUnixUnit(unit: unknown): unit is UnixUnit

import { isValidUnixUnit } from "@northguild/gmt/unix/validate";

Return true when unit is a valid UnixUnit.

• Valid units are: “seconds”, “milliseconds”.
• 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 whether the unit is a valid UnixUnit

Related types

• UnixUnit

Examples

isValidUnixUnit("seconds") // true
isValidUnixUnit("milliseconds") // true
isValidUnixUnit("invalid") // false
isValidUnixUnit(123) // false
isValidUnixUnit(null) // false

Source

unix/validate/isValidUnixUnit.ts