croner 9.0.0-dev.1 → 9.0.0-dev.3

package/README.md

@@ -26,21 +26,21 @@ Quick examples:
 
 ```javascript
 // Basic: Run a function at the interval defined by a cron expression
-const job = Cron('*/5 * * * * *', () => {
+const job = new Cron('*/5 * * * * *', () => {
 	console.log('This will run every fifth second');
 });
 
 // Enumeration: What dates do the next 100 sundays occur on?
-const nextSundays = Cron('0 0 0 * * 7').nextRuns(100);
+const nextSundays = new Cron('0 0 0 * * 7').nextRuns(100);
 console.log(nextSundays);
 
 // Days left to a specific date
-const msLeft = Cron('59 59 23 24 DEC *').nextRun() - new Date();
+const msLeft = new Cron('59 59 23 24 DEC *').nextRun() - new Date();
 console.log(Math.floor(msLeft/1000/3600/24) + " days left to next christmas eve");
 
 // Run a function at a specific date/time using a non-local timezone (time is ISO 8601 local time)
 // This will run 2024-01-23 00:00:00 according to the time in Asia/Kolkata
-Cron('2024-01-23T00:00:00', { timezone: 'Asia/Kolkata' }, () => { console.log('Yay!') });
+new Cron('2024-01-23T00:00:00', { timezone: 'Asia/Kolkata' }, () => { console.log('Yay!') });
 
 ```
 
@@ -96,13 +96,13 @@ Cron takes three arguments
 // - First: Cron pattern, js date object (fire once), or ISO 8601 time string (fire once)
 // - Second: Options (optional)
 // - Third: Function run trigger (optional)
-const job = Cron("* * * * * *", { maxRuns: 1 }, () => {} );
+const job = new Cron("* * * * * *", { maxRuns: 1 }, () => {} );
 
 // If function is omitted in constructor, it can be scheduled later
 job.schedule(job, /* optional */ context) => {});
 ```
 
-The job will be sceduled to run at next matching time unless you supply option `{ paused: true }`. The `Cron(...)` constructor will return a Cron instance, later called `job`, which have a couple of methods and properties listed below.
+The job will be sceduled to run at next matching time unless you supply option `{ paused: true }`. The `new Cron(...)` constructor will return a Cron instance, later called `job`, which have a couple of methods and properties listed below.
 
 #### Status
 

package/dist/croner.cjs

@@ -145,7 +145,7 @@ var CronPattern = class {
    * @private
    */
   parse() {
-    if (!(typeof this.pattern === "string")) {
+    if (!(typeof this.pattern === "string" || this.pattern instanceof String)) {
       throw new TypeError("CronPattern: Pattern has to be of type string.");
     }
     if (this.pattern.indexOf("@") >= 0) this.pattern = this.handleNicknames(this.pattern).trim();
@@ -371,6 +371,9 @@ var CronPattern = class {
     if (split.length !== 2) {
       throw new TypeError("CronPattern: Syntax error, illegal stepping: '" + conf + "'");
     }
+    if (split[0] === "") {
+      split[0] = "*";
+    }
     let start = 0;
     if (split[0] !== "*") {
       start = parseInt(split[0], 10) + valueIndexOffset;
@@ -1092,6 +1095,12 @@ var Cron = class {
   async trigger() {
     await this._trigger();
   }
+  /**
+   * Returns number of runs left, undefined = unlimited
+   */
+  runsLeft() {
+    return this._states.maxRuns;
+  }
   /**
    * Called when it's time to trigger.
    * Checks if all conditions are currently met,

package/dist/croner.d.cts

@@ -240,7 +240,7 @@ declare module "date" {
          * Current full year, in local time or target timezone specified by `this.tz`
          */
         year: number;
-        constructor(d?: CronDate | Date | string, tz?: string | number);
+        constructor(d?: CronDate | Date | string | null, tz?: string | number);
         /**
          * Check if the given date is the nth occurrence of a weekday in its month.
          *
@@ -334,33 +334,6 @@ declare module "croner" {
      * An array containing all named cron jobs.
      */
     const scheduledJobs: Cron[];
-    /**
-     * Encapsulate all internal states in the Cron instance.
-     * Duplicate all options that can change to internal states, for example maxRuns and paused.
-     */
-    type CronState = {
-        kill: boolean;
-        blocking: boolean;
-        /**
-         * Start time of previous trigger, updated after each trigger
-         *
-         * Stored to use as the actual previous run, even while a new trigger
-         * is started. Used by the public funtion `.previousRun()`
-         */
-        previousRun: CronDate | undefined;
-        /**
-         * Start time of current trigger, this is updated just before triggering
-         *
-         * This is used internally as "previous run", as we mostly want to know
-         * when the previous run _started_
-         */
-        currentRun: CronDate | undefined;
-        once: CronDate | undefined;
-        currentTimeout: NodeJS.Timer | number | undefined;
-        maxRuns: number | undefined;
-        paused: boolean | undefined;
-        pattern: CronPattern;
-    };
     /**
      * Cron entrypoint
      *
@@ -372,8 +345,8 @@ declare module "croner" {
     class Cron {
         name: string | undefined;
         options: CronOptions;
-        _states: CronState;
-        fn?: Function;
+        private _states;
+        private fn?;
         constructor(pattern: string | Date, fnOrOptions1?: CronOptions | Function, fnOrOptions2?: CronOptions | Function);
         /**
          * Find next runtime, based on supplied date. Strips milliseconds.
@@ -381,7 +354,7 @@ declare module "croner" {
          * @param prev - Date to start from
          * @returns  Next run time
          */
-        nextRun(prev?: CronDate | Date | string): Date | null;
+        nextRun(prev?: CronDate | Date | string | null): Date | null;
         /**
          * Find next n runs, based on supplied date. Strips milliseconds.
          *
@@ -389,7 +362,7 @@ declare module "croner" {
          * @param previous - Date to start from
          * @returns - Next n run times
          */
-        nextRuns(n: number, previous: Date | string): Date[];
+        nextRuns(n: number, previous?: Date | string): Date[];
         /**
          * Return the original pattern, if there was one
          *
@@ -465,6 +438,10 @@ declare module "croner" {
          * Trigger a run manually
          */
         trigger(): Promise<void>;
+        /**
+         * Returns number of runs left, undefined = unlimited
+         */
+        runsLeft(): number | undefined;
         /**
          * Called when it's time to trigger.
          * Checks if all conditions are currently met,
@@ -483,5 +460,5 @@ declare module "croner" {
         private _calculatePreviousRun;
     }
     export default Cron;
-    export { Cron, CronOptions, CronDate, CronPattern, scheduledJobs };
+    export { Cron, CronDate, CronOptions, CronPattern, scheduledJobs };
 }

package/dist/croner.d.ts

@@ -240,7 +240,7 @@ declare module "date" {
          * Current full year, in local time or target timezone specified by `this.tz`
          */
         year: number;
-        constructor(d?: CronDate | Date | string, tz?: string | number);
+        constructor(d?: CronDate | Date | string | null, tz?: string | number);
         /**
          * Check if the given date is the nth occurrence of a weekday in its month.
          *
@@ -334,33 +334,6 @@ declare module "croner" {
      * An array containing all named cron jobs.
      */
     const scheduledJobs: Cron[];
-    /**
-     * Encapsulate all internal states in the Cron instance.
-     * Duplicate all options that can change to internal states, for example maxRuns and paused.
-     */
-    type CronState = {
-        kill: boolean;
-        blocking: boolean;
-        /**
-         * Start time of previous trigger, updated after each trigger
-         *
-         * Stored to use as the actual previous run, even while a new trigger
-         * is started. Used by the public funtion `.previousRun()`
-         */
-        previousRun: CronDate | undefined;
-        /**
-         * Start time of current trigger, this is updated just before triggering
-         *
-         * This is used internally as "previous run", as we mostly want to know
-         * when the previous run _started_
-         */
-        currentRun: CronDate | undefined;
-        once: CronDate | undefined;
-        currentTimeout: NodeJS.Timer | number | undefined;
-        maxRuns: number | undefined;
-        paused: boolean | undefined;
-        pattern: CronPattern;
-    };
     /**
      * Cron entrypoint
      *
@@ -372,8 +345,8 @@ declare module "croner" {
     class Cron {
         name: string | undefined;
         options: CronOptions;
-        _states: CronState;
-        fn?: Function;
+        private _states;
+        private fn?;
         constructor(pattern: string | Date, fnOrOptions1?: CronOptions | Function, fnOrOptions2?: CronOptions | Function);
         /**
          * Find next runtime, based on supplied date. Strips milliseconds.
@@ -381,7 +354,7 @@ declare module "croner" {
          * @param prev - Date to start from
          * @returns  Next run time
          */
-        nextRun(prev?: CronDate | Date | string): Date | null;
+        nextRun(prev?: CronDate | Date | string | null): Date | null;
         /**
          * Find next n runs, based on supplied date. Strips milliseconds.
          *
@@ -389,7 +362,7 @@ declare module "croner" {
          * @param previous - Date to start from
          * @returns - Next n run times
          */
-        nextRuns(n: number, previous: Date | string): Date[];
+        nextRuns(n: number, previous?: Date | string): Date[];
         /**
          * Return the original pattern, if there was one
          *
@@ -465,6 +438,10 @@ declare module "croner" {
          * Trigger a run manually
          */
         trigger(): Promise<void>;
+        /**
+         * Returns number of runs left, undefined = unlimited
+         */
+        runsLeft(): number | undefined;
         /**
          * Called when it's time to trigger.
          * Checks if all conditions are currently met,
@@ -483,5 +460,5 @@ declare module "croner" {
         private _calculatePreviousRun;
     }
     export default Cron;
-    export { Cron, CronOptions, CronDate, CronPattern, scheduledJobs };
+    export { Cron, CronDate, CronOptions, CronPattern, scheduledJobs };
 }

package/dist/croner.js

@@ -115,7 +115,7 @@ var CronPattern = class {
    * @private
    */
   parse() {
-    if (!(typeof this.pattern === "string")) {
+    if (!(typeof this.pattern === "string" || this.pattern instanceof String)) {
       throw new TypeError("CronPattern: Pattern has to be of type string.");
     }
     if (this.pattern.indexOf("@") >= 0) this.pattern = this.handleNicknames(this.pattern).trim();
@@ -341,6 +341,9 @@ var CronPattern = class {
     if (split.length !== 2) {
       throw new TypeError("CronPattern: Syntax error, illegal stepping: '" + conf + "'");
     }
+    if (split[0] === "") {
+      split[0] = "*";
+    }
     let start = 0;
     if (split[0] !== "*") {
       start = parseInt(split[0], 10) + valueIndexOffset;
@@ -1062,6 +1065,12 @@ var Cron = class {
   async trigger() {
     await this._trigger();
   }
+  /**
+   * Returns number of runs left, undefined = unlimited
+   */
+  runsLeft() {
+    return this._states.maxRuns;
+  }
   /**
    * Called when it's time to trigger.
    * Checks if all conditions are currently met,

package/dist/croner.umd.js

@@ -145,7 +145,7 @@ var base64 = (() => {
      * @private
      */
     parse() {
-      if (!(typeof this.pattern === "string")) {
+      if (!(typeof this.pattern === "string" || this.pattern instanceof String)) {
         throw new TypeError("CronPattern: Pattern has to be of type string.");
       }
       if (this.pattern.indexOf("@") >= 0) this.pattern = this.handleNicknames(this.pattern).trim();
@@ -371,6 +371,9 @@ var base64 = (() => {
       if (split.length !== 2) {
         throw new TypeError("CronPattern: Syntax error, illegal stepping: '" + conf + "'");
       }
+      if (split[0] === "") {
+        split[0] = "*";
+      }
       let start = 0;
       if (split[0] !== "*") {
         start = parseInt(split[0], 10) + valueIndexOffset;
@@ -1092,6 +1095,12 @@ var base64 = (() => {
     async trigger() {
       await this._trigger();
     }
+    /**
+     * Returns number of runs left, undefined = unlimited
+     */
+    runsLeft() {
+      return this._states.maxRuns;
+    }
     /**
      * Called when it's time to trigger.
      * Checks if all conditions are currently met,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "croner",
-  "version": "9.0.0-dev.1",
+  "version": "9.0.0-dev.3",
   "description": "Trigger functions and/or evaluate cron expressions in JavaScript. No dependencies. Most features. All environments.",
   "author": "Hexagon <github.com/hexagon>",
   "homepage": "https://croner.56k.guru",