@burglekitt/gmt
Version:
Temporal-based date and time utilities with timezone support and polyfill integration
17 lines (16 loc) • 726 B
TypeScript
import type { DateTimeDurationUnit } from "../../types/index.js";
/**
* 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.
*
* @param unit candidate string
* @returns boolean indicating validity
*
* @example isValidDateTimeDurationUnit("days") // true
* @example isValidDateTimeDurationUnit("hours") // true
* @example isValidDateTimeDurationUnit("minutes") // true
* @example isValidDateTimeDurationUnit("invalid") // false
*/
export declare const isValidDateTimeDurationUnit: (unit: string) => unit is DateTimeDurationUnit;