@burglekitt/gmt
Version:
Temporal-based date and time utilities with timezone support and polyfill integration
17 lines (16 loc) • 632 B
TypeScript
import type { DateDurationUnit } from "../../types/index.js";
/**
* Return true when `unit` is a valid DateDurationUnit.
*
* - Valid units are: "years", "months", "weeks", "days".
* - Uses type assertion to narrow the type.
*
* @param unit string candidate
* @returns boolean indicating whether the unit is valid
*
* @example isValidDateDurationUnit("days") // true
* @example isValidDateDurationUnit("months") // true
* @example isValidDateDurationUnit("years") // true
* @example isValidDateDurationUnit("invalid") // false
*/
export declare const isValidDateDurationUnit: (unit: string) => unit is DateDurationUnit;