agenda-ts 1.7.0 → 1.7.1
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 +17 -23
- package/package.json +4 -2
package/README.md
CHANGED
|
@@ -2,17 +2,23 @@
|
|
|
2
2
|
<img src="./agenda.png" width="100" alt="project-logo">
|
|
3
3
|
</p>
|
|
4
4
|
<p align="center">
|
|
5
|
-
|
|
5
|
+
<h1 align="center">AGENDA-TS</h1>
|
|
6
6
|
</p>
|
|
7
7
|
<p align="center">
|
|
8
8
|
<em>The modern MongoDB-powered job scheduler library for Node.js</em>
|
|
9
9
|
</p>
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
10
|
+
|
|
11
|
+
<div align="center">
|
|
12
|
+
|
|
13
|
+
[](https://npm.im/agenda-ts)
|
|
14
|
+
[](https://github.com/meabed/agenda-ts/actions)
|
|
15
|
+
[](https://github.com/meabed/agenda-ts)
|
|
16
|
+
[](https://www.npmjs.com/package/agenda-ts)
|
|
17
|
+
[](https://github.com/meabed/agenda-ts/blob/master/LICENSE)
|
|
18
|
+
[](https://www.typescriptlang.org/)
|
|
19
|
+
[](https://nodejs.org)
|
|
20
|
+
|
|
21
|
+
</div>
|
|
16
22
|
|
|
17
23
|
<p align="center">
|
|
18
24
|
<!-- default option, no dependency badges. -->
|
|
@@ -27,14 +33,13 @@
|
|
|
27
33
|
<summary>Table of Contents</summary><br>
|
|
28
34
|
|
|
29
35
|
- [Overview](#overview)
|
|
30
|
-
|
|
36
|
+
- [Related Projects](#related-projects)
|
|
31
37
|
- [Unique Features in Agenda-TS](#unique-features-in-agenda-ts)
|
|
32
38
|
- [Repository Structure](#repository-structure)
|
|
33
39
|
- [Modules](#modules)
|
|
34
40
|
- [Getting Started](#getting-started)
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
- [Project Roadmap](#project-roadmap)
|
|
41
|
+
- [Installation](#installation)
|
|
42
|
+
- [Example](#example)
|
|
38
43
|
- [Contributing](#contributing)
|
|
39
44
|
- [License](#license)
|
|
40
45
|
- [Acknowledgments](#acknowledgments)
|
|
@@ -283,17 +288,6 @@ function time() {
|
|
|
283
288
|
<br/>
|
|
284
289
|
<br/>
|
|
285
290
|
|
|
286
|
-
## Project Roadmap
|
|
287
|
-
|
|
288
|
-
- [X] **Add Support for Latest Mongoose Version(8.x.x)**: Upgrade Agenda-TS to be fully compatible with the latest version of Mongoose. This will enable Agenda-TS to leverage the newest features and improvements in Mongoose, ensuring better performance, stability, and security for applications that rely on MongoDB through Mongoose.
|
|
289
|
-
- [X] **Refactoring to Modern TypeScript Syntax**: Undertake a comprehensive refactor of the codebase to utilize modern TypeScript features and syntax. This refactoring will improve code readability, maintainability, and make it easier for new contributors to understand and contribute to the project.
|
|
290
|
-
- [X] **Resolving Issues in Existing Agenda Projects**: Actively address and resolve outstanding issues within the original Agenda project. This initiative not only aids the community by improving the legacy codebase but also informs the development of Agenda by identifying and addressing past challenges.
|
|
291
|
-
- [ ] **Rewrite Test Code**: Revamp our testing suite to increase coverage and ensure tests are up-to-date with modern testing practices. This rewrite aims to enhance test reliability and efficiency, facilitating smoother development and deployment cycles.
|
|
292
|
-
- [X] **Rewrite Documentation**: Completely revise and update the documentation to reflect all new changes and features, ensure clarity of information, and improve navigation and readability for developers. This effort will include new getting started guides, API documentation, and use case examples to facilitate easier adoption and implementation by users.
|
|
293
|
-
---
|
|
294
|
-
<br/>
|
|
295
|
-
<br/>
|
|
296
|
-
|
|
297
291
|
## Contributing
|
|
298
292
|
|
|
299
293
|
Contributions are welcome! Here are several ways you can contribute:
|
|
@@ -343,4 +337,4 @@ Contributions are welcome! Here are several ways you can contribute:
|
|
|
343
337
|
|
|
344
338
|
## License
|
|
345
339
|
|
|
346
|
-
This project is protected under the [MIT](https://github.com/meabed/agenda-ts?tab=MIT-1-ov-file#readme) License.
|
|
340
|
+
This project is protected under the [MIT](https://github.com/meabed/agenda-ts?tab=MIT-1-ov-file#readme) License.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "agenda-ts",
|
|
3
|
-
"version": "1.7.
|
|
3
|
+
"version": "1.7.1",
|
|
4
4
|
"description": "The modern MongoDB-powered job scheduler library for Node.js",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"job",
|
|
@@ -49,6 +49,8 @@
|
|
|
49
49
|
"test": "jest --detectOpenHandles --forceExit",
|
|
50
50
|
"test:coverage": "jest --coverage",
|
|
51
51
|
"test:debug": "DEBUG=agenda:** jest",
|
|
52
|
+
"test-prev-vers-6": "yarn add mongodb@6 --dev --ignore-scripts && yarn test && git checkout HEAD -- package.json yarn.lock",
|
|
53
|
+
"test-prev-vers-7": "yarn add mongodb@7 --dev --ignore-scripts && yarn test && git checkout HEAD -- package.json yarn.lock",
|
|
52
54
|
"typecheck": "tsc --noEmit"
|
|
53
55
|
},
|
|
54
56
|
"config": {
|
|
@@ -63,7 +65,7 @@
|
|
|
63
65
|
"debug": "~4.4.3",
|
|
64
66
|
"human-interval": "~2.0.1",
|
|
65
67
|
"moment-timezone": "^0.6.0",
|
|
66
|
-
"mongodb": "^7
|
|
68
|
+
"mongodb": "^7 || ^6"
|
|
67
69
|
},
|
|
68
70
|
"devDependencies": {
|
|
69
71
|
"@istanbuljs/nyc-config-typescript": "^1.0.2",
|