mongo-job-scheduler 0.1.10 → 0.1.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -9
- package/package.json +6 -4
package/README.md
CHANGED
|
@@ -23,12 +23,26 @@ A production-grade MongoDB-backed job scheduler for Node.js with distributed loc
|
|
|
23
23
|
|
|
24
24
|
## Quick Start
|
|
25
25
|
|
|
26
|
+
### Requirements
|
|
27
|
+
|
|
28
|
+
- Node.js >= 18.0.0
|
|
29
|
+
- MongoDB 5.0, 6.0, 7.0+
|
|
30
|
+
- The `mongodb` driver (v5, v6, or v7) must be installed as a peer dependency.
|
|
31
|
+
|
|
26
32
|
### Installation
|
|
27
33
|
|
|
28
34
|
```bash
|
|
29
35
|
npm install mongo-job-scheduler
|
|
30
36
|
```
|
|
31
37
|
|
|
38
|
+
### UI Dashboard (Optional)
|
|
39
|
+
|
|
40
|
+
For a visual web dashboard to manage and monitor your jobs, check out:
|
|
41
|
+
|
|
42
|
+
- **NPM**: [`mongo-scheduler-ui`](https://www.npmjs.com/package/mongo-scheduler-ui)
|
|
43
|
+
- **GitHub**: [mongo-scheduler-ui](https://github.com/darshanpatel14/mongo-job-scheduler-ui)
|
|
44
|
+
- **API Server**: [mongo-job-scheduler-api](https://github.com/darshanpatel14/mongo-job-scheduler-api)
|
|
45
|
+
|
|
32
46
|
### Basic Usage
|
|
33
47
|
|
|
34
48
|
```typescript
|
|
@@ -246,26 +260,18 @@ Run **multiple scheduler instances** (different servers, pods, or processes) con
|
|
|
246
260
|
- **Concurrency Control** — only one worker executes a job instance
|
|
247
261
|
- **Horizontally Scalable** — supports MongoDB sharding
|
|
248
262
|
|
|
249
|
-
|
|
263
|
+
- **Horizontally Scalable** — supports MongoDB sharding
|
|
250
264
|
|
|
251
265
|
---
|
|
252
266
|
|
|
253
267
|
## Documentation
|
|
254
268
|
|
|
255
|
-
- **`architecture.md`** — Internal design, MongoDB schema, sharding strategy, production checklist
|
|
256
269
|
- **Job lifecycle** — pending → running → completed/failed
|
|
257
270
|
- **Retry & repeat semantics** — at-most-once guarantees
|
|
258
271
|
- **Correctness guarantees** — what we ensure and what we don't
|
|
259
272
|
|
|
260
273
|
---
|
|
261
274
|
|
|
262
|
-
## Status
|
|
263
|
-
|
|
264
|
-
**Early-stage but production-tested.**
|
|
265
|
-
API may evolve before 1.0.0.
|
|
266
|
-
|
|
267
|
-
---
|
|
268
|
-
|
|
269
275
|
## License
|
|
270
276
|
|
|
271
277
|
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "mongo-job-scheduler",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.12",
|
|
4
4
|
"description": "Production-grade MongoDB-backed job scheduler with retries, cron, timezone support, and crash recovery",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Darshan Bhut",
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"dist"
|
|
19
19
|
],
|
|
20
20
|
"engines": {
|
|
21
|
-
"node": ">=
|
|
21
|
+
"node": ">=18.0.0"
|
|
22
22
|
},
|
|
23
23
|
"keywords": [
|
|
24
24
|
"job-scheduler",
|
|
@@ -47,8 +47,10 @@
|
|
|
47
47
|
"prepublishOnly": "npm run build && npm test"
|
|
48
48
|
},
|
|
49
49
|
"dependencies": {
|
|
50
|
-
"cron-parser": "^4.9.0"
|
|
51
|
-
|
|
50
|
+
"cron-parser": "^4.9.0"
|
|
51
|
+
},
|
|
52
|
+
"peerDependencies": {
|
|
53
|
+
"mongodb": "^5.0.0 || ^6.0.0 || ^7.0.0"
|
|
52
54
|
},
|
|
53
55
|
"devDependencies": {
|
|
54
56
|
"@types/jest": "^30.0.0",
|