mongo-job-scheduler 0.1.5 → 0.1.7

package/README.md

@@ -21,7 +21,7 @@ Designed for distributed systems that need:
 - **Interval jobs**
 - **Resume on restart**
 - **Stale lock recovery**
-- **Automatic Lock Renewal** (Heartbeats): Long-running jobs automatically extend their lock.
+- **Automatic Lock Renewal** (Heartbeats): Long-running jobs automatically extend their lock. Default lock timeout is 10 minutes.
 - **Sharding-safe design**
 
 ## Distributed Systems
@@ -62,19 +62,39 @@ const scheduler = new Scheduler({
 await scheduler.start();
 ```
 
+## Retries
+
+You can configure retries using a simple number (for attempts with instant retry) or a detailed object:
+
+```typescript
+// Shorthand: 3 max attempts, 0 delay
+await scheduler.schedule({
+  name: "email",
+  retry: 3,
+});
+
+// Full configuration
+await scheduler.schedule({
+  name: "webhook",
+  retry: {
+    maxAttempts: 5,
+    delay: 1000, // 1 second fixed delay
+    // delay: (attempt) => attempt * 1000 // or dynamic backoff
+  },
+});
+```
+
 ## Cron with Timezone
 
 ```typescript
-await scheduler.schedule(
-  "daily-report",
-  { type: "report" }, // payload
-  {
-    repeat: {
-      cron: "0 9 * * *",
-      timezone: "Asia/Kolkata", // default is UTC
-    },
-  }
-);
+await scheduler.schedule({
+  name: "daily-report",
+  // data: { type: "report" }, // optional payload
+  repeat: {
+    cron: "0 9 * * *",
+    timezone: "Asia/Kolkata", // default is UTC
+  },
+});
 ```
 
 ## Interval Scheduling

package/dist/core/scheduler.js

@@ -13,7 +13,7 @@ class Scheduler {
         this.handler = options.handler;
         this.workerCount = options.workers ?? 1;
         this.pollInterval = options.pollIntervalMs ?? 500;
-        this.lockTimeout = options.lockTimeoutMs ?? 30000;
+        this.lockTimeout = options.lockTimeoutMs ?? 10 * 60 * 1000; // default 10 minutes
         this.defaultTimezone = options.defaultTimezone;
     }
     on(event, listener) {

package/dist/types/job.d.ts

@@ -4,7 +4,7 @@ import { RepeatOptions } from "./repeat";
 export interface Job<Data = unknown> {
     _id?: unknown;
     name: string;
-    data: Data;
+    data?: Data;
     status: JobStatus;
     nextRunAt: Date;
     lastRunAt?: Date;
@@ -13,7 +13,7 @@ export interface Job<Data = unknown> {
     lockedBy?: string;
     attempts: number;
     lastError?: string;
-    retry?: RetryOptions;
+    retry?: RetryOptions | number;
     repeat?: RepeatOptions;
     dedupeKey?: string;
     createdAt: Date;

package/dist/types/schedule.d.ts

@@ -2,7 +2,7 @@ import { RetryOptions } from "./retry";
 import { RepeatOptions } from "./repeat";
 export interface ScheduleOptions<T = unknown> {
     name: string;
-    data: T;
+    data?: T;
     /**
      * When the job should first run.
      * Defaults to now.
@@ -11,7 +11,7 @@ export interface ScheduleOptions<T = unknown> {
     /**
      * Retry configuration
      */
-    retry?: RetryOptions;
+    retry?: RetryOptions | number;
     /**
      * Repeat configuration (cron or every)
      */

package/dist/worker/worker.js

@@ -10,7 +10,7 @@ class Worker {
         this.handler = handler;
         this.running = false;
         this.pollInterval = options.pollIntervalMs ?? 500;
-        this.lockTimeout = options.lockTimeoutMs ?? 30000;
+        this.lockTimeout = options.lockTimeoutMs ?? 10 * 60 * 1000; // default 10 minutes
         this.workerId =
             options.workerId ?? `worker-${Math.random().toString(36).slice(2)}`;
         this.defaultTimezone = options.defaultTimezone;
@@ -128,7 +128,10 @@ class Worker {
         catch (err) {
             const error = err instanceof Error ? err : new Error(String(err));
             const attempts = (job.attempts ?? 0) + 1;
-            const retry = job.retry;
+            let retry = job.retry;
+            if (typeof retry === "number") {
+                retry = { maxAttempts: retry, delay: 0 };
+            }
             if (retry && attempts < retry.maxAttempts) {
                 const nextRunAt = new Date(Date.now() + (0, retry_1.getRetryDelay)(retry, attempts));
                 await this.store.reschedule(job._id, nextRunAt, { attempts });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mongo-job-scheduler",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "Production-grade MongoDB-backed job scheduler with retries, cron, timezone support, and crash recovery",
   "license": "MIT",
   "author": "Darshan Bhut",