@lou.codes/cron
Version:
⏲️ Cron Quartz and Cron UNIX expression parser
23 lines (22 loc) • 670 B
TypeScript
import type { Maybe } from "@lou.codes/types";
import type { RangeField } from "./RangeField.js";
/**
* Parses a cron range into an object.
*
* @category Cron String
* @example
* ```typescript
* parseRange("1-13"); // { from: 1, to: 13 }
* parseRange("13-13"); // 13 (normalized)
* parseRange("13-1"); // undefined
* ```
* @see {@link isRangeString}
* @see {@link zipRangeNames}
* @see {@link parseNumberMap}
*
* @param value String that might be a range.
* @returns Parsed ranged of `undefined` if it isn't a range string.
*/
export declare const parseRange: <Predicated extends number>(
value: string,
) => Maybe<Predicated | RangeField<Predicated>>;