@burglekitt/gmt
Version:
Temporal-based date and time utilities with timezone support and polyfill integration
23 lines (22 loc) • 775 B
JavaScript
/**
* Return true when `unit` is a valid TimeDurationUnit.
*
* - Valid units are: "hours", "minutes", "seconds", "milliseconds", "microseconds", "nanoseconds".
* - Uses type assertion to narrow the type.
*
* @param unit string candidate
* @returns boolean indicating whether the unit is valid
*
* @example isValidTimeDurationUnit("hours") // true
* @example isValidTimeDurationUnit("minutes") // true
* @example isValidTimeDurationUnit("seconds") // true
* @example isValidTimeDurationUnit("invalid") // false
*/
export const isValidTimeDurationUnit = (unit) => {
return (unit === "hours" ||
unit === "minutes" ||
unit === "seconds" ||
unit === "milliseconds" ||
unit === "microseconds" ||
unit === "nanoseconds");
};