@burglekitt/gmt
Version:
Temporal-based date and time utilities with timezone support and polyfill integration
23 lines (22 loc) • 735 B
JavaScript
/**
* 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.
*
* @param unit candidate value of any type
* @returns boolean indicating whether the unit is a valid UnixUnit
*
* @example isValidUnixUnit("seconds") // true
* @example isValidUnixUnit("milliseconds") // true
* @example isValidUnixUnit("invalid") // false
* @example isValidUnixUnit(123) // false
* @example isValidUnixUnit(null) // false
*/
export function isValidUnixUnit(unit) {
if (typeof unit !== "string") {
return false;
}
return unit === "seconds" || unit === "milliseconds";
}