croner 10.0.0 → 10.0.2-dev.0

package/dist/options.d.ts

@@ -1,131 +0,0 @@
-import { CronDate } from "./date.ts";
-import type { CronMode } from "./pattern.ts";
-import type { Cron } from "./croner.ts";
-type CatchCallbackFn = (e: unknown, job: Cron) => void;
-type ProtectCallbackFn = (job: Cron) => void;
-/**
- * Options for configuring cron jobs.
- *
- * @interface
- */
-interface CronOptions<T = undefined> {
-    /**
-     * The name of the cron job. If provided, the job will be added to the
-     * `scheduledJobs` array, allowing it to be accessed by name.
-     */
-    name?: string;
-    /**
-     * If true, the job will be paused initially.
-     * @default false
-     */
-    paused?: boolean;
-    /**
-     * If true, the job will be stopped permanently.
-     * @default false
-     */
-    kill?: boolean;
-    /**
-     * If true, errors thrown by the job function will be caught.
-     * If a function is provided, it will be called with the error and the job instance.
-     * @default false
-     */
-    catch?: boolean | CatchCallbackFn;
-    /**
-     * If true, the underlying timer will be unreferenced, allowing the Node.js
-     * process to exit even if the job is still running.
-     * @default false
-     */
-    unref?: boolean;
-    /**
-     * The maximum number of times the job will run.
-     * @default Infinity
-     */
-    maxRuns?: number;
-    /**
-     * The minimum interval between job executions, in seconds.
-     * @default 1
-     */
-    interval?: number;
-    /**
-     * If true, prevents the job from running if the previous execution is still in progress.
-     * If a function is provided, it will be called if the job is blocked.
-     * @default false
-     */
-    protect?: boolean | ProtectCallbackFn;
-    /**
-     * The date and time at which the job should start running.
-     */
-    startAt?: string | Date | CronDate<T>;
-    /**
-     * The date and time at which the job should stop running.
-     */
-    stopAt?: string | Date | CronDate<T>;
-    /**
-     * The timezone for the cron job.
-     */
-    timezone?: string;
-    /**
-     * The UTC offset for the cron job, in minutes.
-     */
-    utcOffset?: number;
-    /**
-     * If true, uses AND logic when combining day-of-month and day-of-week.
-     * If false, uses OR logic for combining day-of-month and day-of-week (legacy behavior).
-     * @default false
-     */
-    domAndDow?: boolean;
-    /**
-     * @deprecated Use domAndDow instead. This option will be removed in a future version.
-     * If true, enables legacy mode (OR logic) for compatibility with older cron implementations.
-     * Offset the scheduled date by a number of days.
-     * Positive values shift the date forward, negative values shift it backward.
-     * For example, dayOffset: -1 schedules the job one day before the pattern match.
-     * @default 0
-     */
-    dayOffset?: number;
-    /**
-     * If true, enables legacy mode for compatibility with older cron implementations.
-     * @default true
-     */
-    legacyMode?: boolean;
-    /**
-     * Specifies the cron pattern mode to use for parsing and execution.
-     *
-     * - "auto": Automatically detect pattern format (default behavior)
-     * - "5-part": Traditional 5-field cron (minute-level precision, seconds forced to 0, years wildcarded)
-     * - "6-part": Extended 6-field cron (second-level precision, years wildcarded)
-     * - "7-part": Full 7-field cron (second-level and year-specific precision)
-     * - "5-or-6-parts": Accept 5 or 6 field patterns (years wildcarded)
-     * - "6-or-7-parts": Accept 6 or 7 field patterns (no additional constraints)
-     *
-     * @default "auto"
-     */
-    mode?: CronMode;
-    /**
-     * An optional context object that will be passed to the job function.
-     */
-    context?: T;
-    /**
-     * If true, enables alternative weekday numbering (Quartz mode).
-     * In standard mode (false): Sunday=0, Monday=1, ..., Saturday=6
-     * In Quartz mode (true): Sunday=1, Monday=2, ..., Saturday=7
-     * @default false
-     */
-    alternativeWeekdays?: boolean;
-    /**
-     * If true, allows non-standard stepping formats for backward compatibility.
-     * When false (default), only wildcard (*\/step) or range (min-max\/step) formats are allowed.
-     * When true, allows numeric prefix formats like /10, 5/5, 30/30.
-     * @default false
-     */
-    sloppyRanges?: boolean;
-}
-/**
- * Processes and validates cron options.
- *
- * @param options The cron options to handle.
- * @returns The processed and validated cron options.
- * @throws {Error} If any of the options are invalid.
- */
-declare function CronOptionsHandler<T = undefined>(options?: CronOptions<T>): CronOptions<T>;
-export { type CronOptions, CronOptionsHandler };

package/dist/pattern.d.ts

@@ -1,163 +0,0 @@
-/**
- * Cron pattern mode for controlling precision level
- */
-type CronMode = "auto" | "5-part" | "6-part" | "7-part" | "5-or-6-parts" | "6-or-7-parts";
-/**
- * Constants to represent different occurrences of a weekday in its month.
- * - `LAST_OCCURRENCE`: The last occurrence of a weekday.
- * - `ANY_OCCURRENCE`: Combines all individual weekday occurrence bitmasks, including the last.
- * - `OCCURRENCE_BITMASKS`: An array of bitmasks, with each index representing the respective occurrence of a weekday (0-indexed).
- */
-export declare const LAST_OCCURRENCE = 32;
-export declare const ANY_OCCURRENCE: number;
-export declare const OCCURRENCE_BITMASKS: number[];
-/**
- * Create a CronPattern instance from pattern string ('* * * * * *')
- * @constructor
- * @param {string} pattern - Input pattern
- * @param {string} timezone - Input timezone, used for '?'-substitution
- * @param {object} options - Cron options including mode
- */
-declare class CronPattern {
-    pattern: string;
-    timezone?: string;
-    mode: CronMode;
-    alternativeWeekdays: boolean;
-    sloppyRanges: boolean;
-    second: number[];
-    minute: number[];
-    hour: number[];
-    day: number[];
-    month: number[];
-    dayOfWeek: number[];
-    year: number[];
-    lastDayOfMonth: boolean;
-    lastWeekday: boolean;
-    nearestWeekdays: number[];
-    starDOM: boolean;
-    starDOW: boolean;
-    starYear: boolean;
-    useAndLogic: boolean;
-    constructor(pattern: string, timezone?: string, options?: {
-        mode?: CronMode;
-        alternativeWeekdays?: boolean;
-        sloppyRanges?: boolean;
-    });
-    /**
-     * Parse current pattern, will throw on any type of failure
-     * @private
-     */
-    private parse;
-    /**
-     * Convert current part (seconds/minutes etc) to an array of 1 or 0 depending on if the part is about to trigger a run or not.
-     */
-    private partToArray;
-    /**
-     * After converting JAN-DEC, SUN-SAT only 0-9 * , / - are allowed, throw if anything else pops up
-     * @throws On error
-     */
-    private throwAtIllegalCharacters;
-    /**
-     * Nothing but a number, potentially with a modifier, left - handle that
-     *
-     * @param conf Current part, expected to be a number, as a string
-     * @param type One of "seconds", "minutes" etc
-     * @param valueIndexOffset -1 for day of month, and month, as they start at 1. 0 for seconds, hours, minutes
-     */
-    private handleNumber;
-    /**
-     * Set a specific value for a specific part of the CronPattern.
-     *
-     * @param part The specific part of the CronPattern, e.g., "second", "minute", etc.
-     * @param index The index to modify.
-     * @param value The value to set, typically 0 or 1, in case of "nth weekday" it will be the weekday number used for further processing
-     */
-    private setPart;
-    /**
-     * Validates that a parsed number is not NaN.
-     * Throws a TypeError with a descriptive message if the value is NaN.
-     *
-     * @param value - The value to validate
-     * @param errorMessage - The error message to throw if validation fails
-     * @throws {TypeError} If the value is NaN
-     * @private
-     */
-    private validateNotNaN;
-    /**
-     * Validates that a range is valid (lower <= upper) and that steps are valid (> 0 and <= array length).
-     *
-     * @param lower - Lower bound of range
-     * @param upper - Upper bound of range
-     * @param steps - Optional step value to validate
-     * @param type - The type of pattern part being validated
-     * @param conf - The original configuration string for error messages
-     * @throws {TypeError} If validation fails
-     * @private
-     */
-    private validateRange;
-    /**
-     * Take care of ranges with stepping (e.g. 3-23/5)
-     *
-     * @param conf Current part, expected to be a string like 3-23/5
-     * @param type One of "seconds", "minutes" etc
-     * @param valueIndexOffset -1 for day of month, and month, as they start at 1. 0 for seconds, hours, minutes
-     */
-    private handleRangeWithStepping;
-    private extractNth;
-    /**
-     * Take care of ranges (e.g. 1-20)
-     *
-     * @param conf - Current part, expected to be a string like 1-20, can contain L for last
-     * @param type - One of "seconds", "minutes" etc
-     * @param valueIndexOffset - -1 for day of month, and month, as they start at 1. 0 for seconds, hours, minutes
-     */
-    private handleRange;
-    /**
-     * Handle stepping (e.g. * / 14)
-     *
-     * @param conf Current part, expected to be a string like * /20 (without the space)
-     * @param type One of "seconds", "minutes" etc
-     */
-    private handleStepping;
-    /**
-     * Replace day name with day numbers
-     *
-     * @param conf Current part, expected to be a string that might contain sun,mon etc.
-     *
-     * @returns Conf with 0 instead of sun etc.
-     */
-    private replaceAlphaDays;
-    /**
-     * Replace day name with day numbers (Quartz mode)
-     * In Quartz mode: Sunday=1, Monday=2, ..., Saturday=7
-     *
-     * @param conf Current part, expected to be a string that might contain sun,mon etc.
-     *
-     * @returns Conf with Quartz-style numbering
-     */
-    private replaceAlphaDaysQuartz;
-    /**
-     * Replace month name with month numbers
-     *
-     * @param conf Current part, expected to be a string that might contain jan,feb etc.
-     *
-     * @returns conf with 0 instead of sun etc.
-     */
-    private replaceAlphaMonths;
-    /**
-     * Replace nicknames with actual cron patterns
-     *
-     * @param pattern Pattern, may contain nicknames, or not
-     *
-     * @returns Pattern, with cron expression insted of nicknames
-     */
-    private handleNicknames;
-    /**
-     * Handle the nth weekday of the month logic using hash sign (e.g. FRI#2 for the second Friday of the month)
-     *
-     * @param index Weekday, example: 5 for friday
-     * @param nthWeekday bitmask, 2 (0x00010) for 2nd friday, 31 (ANY_OCCURRENCE, 0b100000) for any day
-     */
-    private setNthWeekdayOfMonth;
-}
-export { type CronMode, CronPattern };

package/dist/utils.d.ts

@@ -1,25 +0,0 @@
-import type { CronCallback } from "./croner.ts";
-/**
- * Helper function to check if a variable is a function.
- *
- * @param v The variable to check.
- * @returns True if the variable is a function, false otherwise.
- * @private
- */
-declare function isFunction(v: unknown): boolean;
-/**
- * Type guard to check if a variable is a valid CronCallback function.
- *
- * @param v The variable to check.
- * @returns Type predicate indicating if the variable is a CronCallback.
- * @private
- */
-export declare function isCronCallback(v: unknown): v is CronCallback;
-/**
- * Helper function to unref a timer in both Deno and Node.js.
- *
- * @param timer The timer to unref.
- * @private
- */
-declare function unrefTimer(timer: NodeJS.Timeout | number): void;
-export { isFunction, unrefTimer };