@vope/utils 1.6.1 → 1.6.2

package/dist/cron.d.ts

@@ -0,0 +1,177 @@
+interface Item {
+    key: string;
+    value: number;
+}
+declare class Dic {
+    private dics;
+    private keys;
+    private values;
+    constructor(dics: Item[]);
+    item(key: string): number;
+    at(value: number): string;
+    reduce<U>(callbackfn: (previousValue: U, currentValue: Item, currentIndex: number) => U, initialValue: U): U;
+}
+export declare const weekDic: Dic;
+interface Options {
+    /**
+     * 是否支持具名匹配
+     * @default true
+     */
+    enableSlot?: boolean;
+    /**
+     * 是否支持秒
+     * @default true
+     */
+    enableSecond?: boolean;
+    /**
+     * 是否支持年
+     * @default true
+     */
+    enableYear?: boolean;
+    /**
+     * 值是否匹配最大值
+     * @default true
+     */
+    enableMax?: boolean;
+    /**
+     * 增幅是否匹配最大值(如果enableMax等于false则该值也始终为false)
+     * @default true
+     */
+    enableIncrementMax?: boolean;
+    /**
+     * 日/周是否支持无效设置
+     * @default true
+     */
+    enableInvalid?: boolean;
+    /**
+     * 日期是否支持倒数值
+     * @default true
+     */
+    enableDayLast?: boolean;
+    /**
+     * 周是否支持倒数值
+     * @default true
+     */
+    enableWeekLast?: boolean;
+    /**
+     * 周是否支持7
+     * @default true
+     */
+    enableWeekSupport7?: boolean;
+    /**
+     * 周是否支持字典
+     * @default true
+     */
+    enableWeekSupportDic?: boolean;
+    /**
+     * 周字典是否支持大小写混写
+     * @default true
+     */
+    enableDicEnumSupportMixin?: boolean;
+    /**
+     * 数值是否支持前缀0
+     */
+    enablePrefixZero?: boolean;
+}
+export declare const default_max_second = 59;
+export declare const default_min_second = 0;
+export declare const default_max_minute = 59;
+export declare const default_min_minute = 0;
+export declare const default_max_hour = 23;
+export declare const default_min_hour = 0;
+export declare const default_max_day = 31;
+export declare const default_min_day = 1;
+export declare const default_max_month = 12;
+export declare const default_min_month = 1;
+export declare const default_max_week = 6;
+export declare const default_min_week = 0;
+export declare const createCronRegexText: (options?: Options) => {
+    regex: string;
+    enableSlot: boolean;
+    enableSecond: boolean;
+    enableYear: boolean;
+    enableDayLast: boolean;
+    enableWeekLast: boolean;
+    enableInvalid: boolean;
+};
+interface BasicValue {
+    text(): string;
+}
+export declare class InvalidValue implements BasicValue {
+    private isEnableInvalid;
+    constructor(isEnableInvalid: boolean);
+    text(): "?" | "*";
+}
+export declare const isInvalidValue: (value: unknown) => value is InvalidValue;
+declare abstract class LastValue implements BasicValue {
+    value: number;
+    constructor(value: number);
+    abstract text(): string;
+}
+export declare class DayLastValue extends LastValue {
+    text(): string;
+}
+export declare const isDayLastValue: (value: unknown) => value is DayLastValue;
+export declare class WeekLastValue extends LastValue {
+    text(): string;
+}
+export declare const isWeekLastValue: (value: unknown) => value is WeekLastValue;
+export declare class WildcardValue implements BasicValue {
+    text(): string;
+}
+export declare const isWildcardValue: (value: unknown) => value is WildcardValue;
+export declare class RangeValue implements BasicValue {
+    start: number;
+    stop: number;
+    constructor(start: number, stop: number);
+    text(): string;
+}
+export declare const isRangeValue: (value: unknown) => value is RangeValue;
+type IGroup = number | DayLastValue | WeekLastValue | RangeValue;
+type IValues = WildcardValue | IGroup[];
+export declare class DigitsValue implements BasicValue {
+    values: IValues;
+    increment?: number | undefined;
+    constructor(values: IValues, increment?: number | undefined);
+    text(): string;
+}
+export declare const isDigitsValue: (value: unknown) => value is DigitsValue;
+type Digits<T extends string = never> = '*' | number | T | (number | T | [number, number])[];
+type BasicDigits = Digits;
+type DayDigits = Digits<'L' | `L-${number}`>;
+type WeekDigits = Digits<`${number}L`>;
+declare class Parse {
+    cron: Cron;
+    second?: DigitsValue;
+    minute: DigitsValue;
+    hour: DigitsValue;
+    day: InvalidValue | DigitsValue;
+    month: DigitsValue;
+    week: InvalidValue | DigitsValue;
+    year?: DigitsValue;
+    constructor(second: string | undefined, minute: string, hour: string, day: string, month: string, week: string, year: string | undefined, cron: Cron);
+    parse(text: string): InvalidValue | DigitsValue;
+    setSecond(value: BasicDigits, increment?: number): boolean;
+    setMinute(value: BasicDigits, increment?: number): boolean;
+    setHour(value: BasicDigits, increment?: number): boolean;
+    setDayInvalid(): void;
+    setDay(value: '?'): boolean;
+    setDay(value: DayDigits, increment?: number): boolean;
+    setMonth(value: BasicDigits, increment?: number): boolean;
+    setWeekInvalid(): void;
+    setWeek(value: '?'): boolean;
+    setWeek(value: WeekDigits, increment?: number): boolean;
+    setYear(value: BasicDigits, increment?: number): boolean;
+    text(): string;
+}
+export declare class Cron {
+    #private;
+    get isEnableSecond(): boolean;
+    get isEnableYear(): boolean;
+    get isEnableDayLast(): boolean;
+    get isEnableWeekLast(): boolean;
+    get isEnableInvalid(): boolean;
+    constructor(options?: Options);
+    parse(text: string): Parse | undefined;
+}
+export {};