croner 9.0.0-dev.0 → 9.0.0-dev.2

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

@@ -20,6 +20,9 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var croner_exports = {};
 __export(croner_exports, {
   Cron: () => Cron,
+  CronDate: () => CronDate,
+  CronOptions: () => CronOptions,
+  CronPattern: () => CronPattern,
   default: () => croner_default,
   scheduledJobs: () => scheduledJobs
 });
@@ -1170,5 +1173,8 @@ var croner_default = Cron;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   Cron,
+  CronDate,
+  CronOptions,
+  CronPattern,
   scheduledJobs
 });

package/dist/croner.d.cts

@@ -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,9 +345,9 @@ declare module "croner" {
     class Cron {
         name: string | undefined;
         options: CronOptions;
-        _states: CronState;
-        fn?: Function;
-        constructor(pattern: string | Date, fnOrOptions1: CronOptions | Function, fnOrOptions2: CronOptions | Function);
+        private _states;
+        private fn?;
+        constructor(pattern: string | Date, fnOrOptions1?: CronOptions | Function, fnOrOptions2?: CronOptions | Function);
         /**
          * Find next runtime, based on supplied date. Strips milliseconds.
          *
@@ -483,5 +456,5 @@ declare module "croner" {
         private _calculatePreviousRun;
     }
     export default Cron;
-    export { Cron, scheduledJobs };
+    export { Cron, CronDate, CronOptions, CronPattern, scheduledJobs };
 }

package/dist/croner.d.ts

@@ -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,9 +345,9 @@ declare module "croner" {
     class Cron {
         name: string | undefined;
         options: CronOptions;
-        _states: CronState;
-        fn?: Function;
-        constructor(pattern: string | Date, fnOrOptions1: CronOptions | Function, fnOrOptions2: CronOptions | Function);
+        private _states;
+        private fn?;
+        constructor(pattern: string | Date, fnOrOptions1?: CronOptions | Function, fnOrOptions2?: CronOptions | Function);
         /**
          * Find next runtime, based on supplied date. Strips milliseconds.
          *
@@ -483,5 +456,5 @@ declare module "croner" {
         private _calculatePreviousRun;
     }
     export default Cron;
-    export { Cron, scheduledJobs };
+    export { Cron, CronDate, CronOptions, CronPattern, scheduledJobs };
 }

package/dist/croner.js

@@ -1142,6 +1142,9 @@ var Cron = class {
 var croner_default = Cron;
 export {
   Cron,
+  CronDate,
+  CronOptions,
+  CronPattern,
   croner_default as default,
   scheduledJobs
 };

package/dist/croner.umd.js

@@ -21,6 +21,9 @@ var base64 = (() => {
   var croner_exports = {};
   __export(croner_exports, {
     Cron: () => Cron,
+    CronDate: () => CronDate,
+    CronOptions: () => CronOptions,
+    CronPattern: () => CronPattern,
     default: () => croner_default,
     scheduledJobs: () => scheduledJobs
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "croner",
-  "version": "9.0.0-dev.0",
+  "version": "9.0.0-dev.2",
   "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",