agenda-ts 1.6.9-beta.1 → 1.7.0

package/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <img src="./pulse.png" width="100" alt="project-logo">
+  <img src="./agenda.png" width="100" alt="project-logo">
 </p>
 <p align="center">
             <h1 align="center">AGENDA-TS</h1>
@@ -13,6 +13,7 @@
 	<img src="https://img.shields.io/github/languages/top/meabed/agenda-ts?style=default&color=24E0A4" alt="repo-top-language">
 	<img src="https://img.shields.io/github/languages/count/meabed/agenda-ts?style=default&color=24E0A4" alt="repo-language-count">
 <p>
+
 <p align="center">
 	<!-- default option, no dependency badges. -->
 </p>
@@ -46,9 +47,9 @@ Agenda-TS is a modern TypeScript fork of the [Agenda](https://github.com/agenda/
 
 <br/>
 
-#### Related Projects
-- [agenda-ts](https://github.com/meabed/agenda-ts) - Modern MongoDB-powered job scheduler for Node.js
-- [nestjs-agenda-ts](https://github.com/meabed/nestjs-agenda-ts) - official NestJS module for Agenda-TS.
+> This package is forked version from [pulse](https://github.com/pulsecron/pulse/)
+>
+> It has been updated, fixed few bugs, actively adding features and updated dependencies and codebase to the latest packages
 
 ---
 
@@ -56,9 +57,9 @@ Agenda-TS is a modern TypeScript fork of the [Agenda](https://github.com/agenda/
 <br/>
 
 
-##  Unique Features in Agenda-TS
+##  Unique Features in Agenda
 
-- **Latest MongoDB Driver Support**: Agenda-TS is fully compatible with the latest MongoDB driver, ensuring users can take advantage of the most current database features and enhancements.
+- **Latest MongoDB Driver Support**: Agenda is fully compatible with the latest MongoDB driver, ensuring users can take advantage of the most current database features and enhancements.
 - **Resume Incomplete Tasks After System Restart**: When the system restarts, Agenda-TS resumes incomplete tasks that were in progress or queued for execution, providing seamless continuation without manual intervention.
 - **Retry Failed Tasks**: Agenda-TS offers retry mechanisms using exponential and fixed backoff strategies with configurable attempts, ensuring efficient retries of failed tasks without overwhelming the system.
 - **Continuous Maintenance**: As an open-source project actively maintained, Agenda-TS is consistently improved, providing users with reliable updates and support.
@@ -71,7 +72,7 @@ Agenda-TS is a modern TypeScript fork of the [Agenda](https://github.com/agenda/
 ##  Repository Structure
 
 ```sh
-└── agenda-ts/
+└── agenda/
     ├── LICENSE
     ├── README.md
     ├── es.js
@@ -83,7 +84,7 @@ Agenda-TS is a modern TypeScript fork of the [Agenda](https://github.com/agenda/
     │   ├── cjs.ts
     │   ├── index.ts
     │   ├── job
-    │   ├── pulse
+    │   ├── agenda
     │   └── utils
     ├── tsconfig.eslint.json
     └── tsconfig.json
@@ -95,40 +96,40 @@ Agenda-TS is a modern TypeScript fork of the [Agenda](https://github.com/agenda/
 
 ##  Modules
 
-<details closed><summary>src.pulse</summary>
+<details closed><summary>src.agenda</summary>
 
 | File                                                                                                            | Summary                                                                                                                                                                                                                                                                                                                       |
 | ---                                                                                                             | ---                                                                                                                                                                                                                                                                                                                           |
-| [has-mongo-protocol.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/has-mongo-protocol.ts)         | HasMongoProtocol establishes a function that evaluates if a given URL string contains a valid MongoDB connection protocol, contributing to the repositorys ability to handle and verify database connections.                                                                                                                 |
-| [default-concurrency.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/default-concurrency.ts)       | Sets the default concurrency for each job within the Agendta-TS open-source project by modifying the internal state. It contributes to the task scheduling and management functionalities in the project.                                                                                                                          |
-| [name.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/name.ts)                                     | Sets the name of a queue within the Agendta object in the parent repositorys architecture. It utilizes debugging for traceability and maintains the flow architecture by returning the Agendta instance after the name assignment.                                                                                                |
-| [drain.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/drain.ts)                                   | Drain.ts serves a crucial role in the Agendta module, enabling the cancellation of ongoing job processes. It ensures that all running jobs get completed before terminating the processing interval, promoting an efficient and orderly execution flow in the application.                                                      |
-| [enable.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/enable.ts)                                 | Enables specific jobs within the Agendta module by toggling the disabled flag to false. Utilizes MongoDB queries to precisely select matching jobs, aspiring to enhance the flexibility and robustness of job execution. Returns the count of jobs successfully enabled, aiding in operational tracking.                        |
-| [schedule.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/schedule.ts)                             | Schedule.ts within the Agenda directory facilitates job scheduling for specific timings. Through this module, users can assign an array of job names to be executed at a specified time, along with associated data. Multiple jobs can be created at once, enhancing the efficiency of task management in the repository.      |
-| [default-lock-lifetime.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/default-lock-lifetime.ts)   | Establishes the default lock lifetime in an Agendta application. It allows setting the default lock time in milliseconds, providing flexibility in managing task execution timelines. This is a critical feature for handling concurrency control in Agendta's job processing system.                                               |
-| [db-init.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/db-init.ts)                               | Establishes and initializes the database collection for job management in the Agendta-TS open-source project. It also includes optional index creation functionality, providing efficient job searching within the database. Notifiers for success or errors make the process transparent and manageable.                          |
-| [process-every.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/process-every.ts)                   | ProcessEvery sets a default interval for an Agendta objects processing time. It leverages human-readable time intervals to determine the frequency of certain operations within the agenda directory of the repository. This function returns the updated Agendta object.                                                           |
-| [disable.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/disable.ts)                               | Disables selected jobs in the Agendta application by applying a MongoDB filter query. The function returns the number of successfully disabled job instances, providing enhanced control over task execution.                                                                                                                   |
-| [jobs.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/jobs.ts)                                     | Within the Agendta-TS repository, the jobs.ts script from the src/pulse directory performs a crucial task. It retrieves all jobs matching a certain query from a MongoDB collection, with options for sorting, limiting and skipping results, transforming these into job objects before returning.                                |
-| [start.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/start.ts)                                   | Start.ts initializes job processing for the Agendta module. It validates system readiness before periodically processing tasks using the processJobs method from the utils directory. The method ensures job execution regularity and guarantees uninterrupted operation, provided a database is set beforehand.                |
-| [every.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/every.ts)                                   | Within the agendta directory, every.ts establishes a regular job execution framework. It enables job scheduling at specified intervals, handling singular and multiple job names. Pertinent debugging information for scheduled job processes is also provided by this module.                                                  |
-| [max-concurrency.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/max-concurrency.ts)               | MaxConcurrency controls job execution in the Agendta system by globally setting the maximum concurrency value, thereby optimizing task management. It directly interacts with the core Agendta framework, ensuring that job execution does not exceed the defined threshold, enhancing overall process efficiency.                |
-| [purge.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/purge.ts)                                   | Purge.ts, within the agenda subdirectory, provides functionality to remove all jobs from the queue in the Agenda application. It exports an asynchronous function that cancels undefined jobs, ensuring only defined jobs remain. The function's outcome is confirmed with success or failure notifications.                    |
-| [now.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/now.ts)                                       | Establishes a function within the Agenda module, designed to create a job task instantly. This function, named now, accepts job details, schedules it for the current time, saves the job into the system, and handles potential creation errors.                                                                              |
-| [default-lock-limit.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/default-lock-limit.ts)         | Defines the maximum number of locks per job type in the Agenda system. It establishes a default limit, with each instance adjustable per user needs. The limit optimizes concurrent task handling, enhancing overall application performance.                                                                                  |
-| [stop.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/stop.ts)                                     | Stop.ts within the Agenda sub-directory is responsible for terminating the process of job execution. It achieves this by unlocking jobs that were locked for processing, allowing them to be re-run or accessed, and by clearing the job execution interval, effectively stopping further job processing.                      |
-| [database.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/database.ts)                             | Database.ts, located in the src/pulse directory, establishes a connection to a specified MongoDB server. It features the flexibility to use an existing MongoDB connection, customize collection names, and handle connection errors. Ultimately, this file integrates MongoDB into the broader Agenda architecture.           |
-| [sort.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/sort.ts)                                     | Sort.ts orchestrates the sorting functionality within the Agenda component, allowing users to customize their queries for job searches. It primarily manages the rules for prioritizing and scheduling jobs, with the default being jobs sorted by their next run time and priority.                                           |
-| [mongo.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/mongo.ts)                                   | Mongo.ts integrates MongoDB with the Agenda application, enabling the establishment of database connections. It provides a method to inject MongoClient instance, specify the collection, and handle database initialization errors through callbacks.                                                                         |
-| [cancel.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/cancel.ts)                                 | Cancel.ts facilitates the termination of specific Agenda jobs based on a provided MongoDB query, effectively removing them from the database. These cancellations can be initiated by the client code, the Agenda.purge() function, or the Job.remove() function.                                                               |
-| [index.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/index.ts)                                   | Agenda, the heart of the repository, manages a queue of jobs in a MongoDB collection. This task scheduling system facilitates job creation, scheduling, locking, and execution, handling concurrency defaults, lock limits, and durations. Moreover, it supports optional configuration and customization parameters.          |
-| [define.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/define.ts)                                 | Defines job parameters and execution procedures in the Agenda library. Users can configure concurrency, locking, priority, lifetime, and result persistence for a named job. Job definitions are stored and debugged for future execution within the Agendta system.                                                             |
-| [create.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/create.ts)                                 | Creates new jobs within the Agendta module of the repository. This piece of code initializes these jobs with given names and data, also setting specific attributes such as priority and whether to save results based on predefined definitions.                                                                               |
-| [find-and-lock-next-job.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/find-and-lock-next-job.ts) | Unlocks and processes queued jobs within the Agenda-TS repository. In the find-and-lock-next-job file, the function identifies a specific job based on its name, locks it for execution, and returns the job status. This operation ensures efficient management of tasks within the system.                                      |
-| [job-processing-queue.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/job-processing-queue.ts)     | JobProcessingQueue, as part of the larger Agenda-TS repository, manages job processing through an internal queue. It offers capabilities like job insertion in a specific order, popping jobs without concurrency checks, and identifying the next job eligible for processing whose execution isnt blocked by concurrency.       |
-| [lock-limit.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/lock-limit.ts)                         | LockLimit sets a global upper limit on the number of jobs that can be simultaneously locked within the Agenda system, ensuring efficient task execution without resource overstretching. Its essential for maintaining concurrency control in the broader repository architecture.                                             |
-| [close.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/close.ts)                                   | Agenda/close.ts secures the main functionality of closing database connections within the Agenda-TS project. It incorporates a provision for forcefully closing connections and handles exceptions that might arise during this process. The feature is specifically adapted for MongoDB databases that havent been preconfigured. |
-| [save-job.ts](https://github.com/meabed/agenda-ts/blob/master/src/pulse/save-job.ts)                             | <code>► INSERT-TEXT-HERE</code>                                                                                                                                                                                                                                                                                               |
+| [has-mongo-protocol.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/has-mongo-protocol.ts)         | HasMongoProtocol establishes a function that evaluates if a given URL string contains a valid MongoDB connection protocol, contributing to the repositorys ability to handle and verify database connections.                                                                                                                 |
+| [default-concurrency.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/default-concurrency.ts)       | Sets the default concurrency for each job within the Agendta-TS open-source project by modifying the internal state. It contributes to the task scheduling and management functionalities in the project.                                                                                                                          |
+| [name.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/name.ts)                                     | Sets the name of a queue within the Agendta object in the parent repositorys architecture. It utilizes debugging for traceability and maintains the flow architecture by returning the Agendta instance after the name assignment.                                                                                                |
+| [drain.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/drain.ts)                                   | Drain.ts serves a crucial role in the Agendta module, enabling the cancellation of ongoing job processes. It ensures that all running jobs get completed before terminating the processing interval, promoting an efficient and orderly execution flow in the application.                                                      |
+| [enable.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/enable.ts)                                 | Enables specific jobs within the Agendta module by toggling the disabled flag to false. Utilizes MongoDB queries to precisely select matching jobs, aspiring to enhance the flexibility and robustness of job execution. Returns the count of jobs successfully enabled, aiding in operational tracking.                        |
+| [schedule.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/schedule.ts)                             | Schedule.ts within the Agenda directory facilitates job scheduling for specific timings. Through this module, users can assign an array of job names to be executed at a specified time, along with associated data. Multiple jobs can be created at once, enhancing the efficiency of task management in the repository.      |
+| [default-lock-lifetime.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/default-lock-lifetime.ts)   | Establishes the default lock lifetime in an Agendta application. It allows setting the default lock time in milliseconds, providing flexibility in managing task execution timelines. This is a critical feature for handling concurrency control in Agendta's job processing system.                                               |
+| [db-init.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/db-init.ts)                               | Establishes and initializes the database collection for job management in the Agendta-TS open-source project. It also includes optional index creation functionality, providing efficient job searching within the database. Notifiers for success or errors make the process transparent and manageable.                          |
+| [process-every.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/process-every.ts)                   | ProcessEvery sets a default interval for an Agendta objects processing time. It leverages human-readable time intervals to determine the frequency of certain operations within the agenda directory of the repository. This function returns the updated Agendta object.                                                           |
+| [disable.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/disable.ts)                               | Disables selected jobs in the Agendta application by applying a MongoDB filter query. The function returns the number of successfully disabled job instances, providing enhanced control over task execution.                                                                                                                   |
+| [jobs.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/jobs.ts)                                     | Within the Agendta-TS repository, the jobs.ts script from the src/agenda directory performs a crucial task. It retrieves all jobs matching a certain query from a MongoDB collection, with options for sorting, limiting and skipping results, transforming these into job objects before returning.                                |
+| [start.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/start.ts)                                   | Start.ts initializes job processing for the Agendta module. It validates system readiness before periodically processing tasks using the processJobs method from the utils directory. The method ensures job execution regularity and guarantees uninterrupted operation, provided a database is set beforehand.                |
+| [every.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/every.ts)                                   | Within the agendta directory, every.ts establishes a regular job execution framework. It enables job scheduling at specified intervals, handling singular and multiple job names. Pertinent debugging information for scheduled job processes is also provided by this module.                                                  |
+| [max-concurrency.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/max-concurrency.ts)               | MaxConcurrency controls job execution in the Agendta system by globally setting the maximum concurrency value, thereby optimizing task management. It directly interacts with the core Agendta framework, ensuring that job execution does not exceed the defined threshold, enhancing overall process efficiency.                |
+| [purge.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/purge.ts)                                   | Purge.ts, within the agenda subdirectory, provides functionality to remove all jobs from the queue in the Agenda application. It exports an asynchronous function that cancels undefined jobs, ensuring only defined jobs remain. The function's outcome is confirmed with success or failure notifications.                    |
+| [now.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/now.ts)                                       | Establishes a function within the Agenda module, designed to create a job task instantly. This function, named now, accepts job details, schedules it for the current time, saves the job into the system, and handles potential creation errors.                                                                              |
+| [default-lock-limit.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/default-lock-limit.ts)         | Defines the maximum number of locks per job type in the Agenda system. It establishes a default limit, with each instance adjustable per user needs. The limit optimizes concurrent task handling, enhancing overall application performance.                                                                                  |
+| [stop.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/stop.ts)                                     | Stop.ts within the Agenda sub-directory is responsible for terminating the process of job execution. It achieves this by unlocking jobs that were locked for processing, allowing them to be re-run or accessed, and by clearing the job execution interval, effectively stopping further job processing.                      |
+| [database.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/database.ts)                             | Database.ts, located in the src/agenda directory, establishes a connection to a specified MongoDB server. It features the flexibility to use an existing MongoDB connection, customize collection names, and handle connection errors. Ultimately, this file integrates MongoDB into the broader Agenda architecture.           |
+| [sort.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/sort.ts)                                     | Sort.ts orchestrates the sorting functionality within the Agenda component, allowing users to customize their queries for job searches. It primarily manages the rules for prioritizing and scheduling jobs, with the default being jobs sorted by their next run time and priority.                                           |
+| [mongo.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/mongo.ts)                                   | Mongo.ts integrates MongoDB with the Agenda application, enabling the establishment of database connections. It provides a method to inject MongoClient instance, specify the collection, and handle database initialization errors through callbacks.                                                                         |
+| [cancel.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/cancel.ts)                                 | Cancel.ts facilitates the termination of specific Agenda jobs based on a provided MongoDB query, effectively removing them from the database. These cancellations can be initiated by the client code, the Agenda.purge() function, or the Job.remove() function.                                                               |
+| [index.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/index.ts)                                   | Agenda, the heart of the repository, manages a queue of jobs in a MongoDB collection. This task scheduling system facilitates job creation, scheduling, locking, and execution, handling concurrency defaults, lock limits, and durations. Moreover, it supports optional configuration and customization parameters.          |
+| [define.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/define.ts)                                 | Defines job parameters and execution procedures in the Agenda library. Users can configure concurrency, locking, priority, lifetime, and result persistence for a named job. Job definitions are stored and debugged for future execution within the Agendta system.                                                             |
+| [create.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/create.ts)                                 | Creates new jobs within the Agendta module of the repository. This piece of code initializes these jobs with given names and data, also setting specific attributes such as priority and whether to save results based on predefined definitions.                                                                               |
+| [find-and-lock-next-job.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/find-and-lock-next-job.ts) | Unlocks and processes queued jobs within the Agenda-TS repository. In the find-and-lock-next-job file, the function identifies a specific job based on its name, locks it for execution, and returns the job status. This operation ensures efficient management of tasks within the system.                                      |
+| [job-processing-queue.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/job-processing-queue.ts)     | JobProcessingQueue, as part of the larger Agenda-TS repository, manages job processing through an internal queue. It offers capabilities like job insertion in a specific order, popping jobs without concurrency checks, and identifying the next job eligible for processing whose execution isnt blocked by concurrency.       |
+| [lock-limit.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/lock-limit.ts)                         | LockLimit sets a global upper limit on the number of jobs that can be simultaneously locked within the Agenda system, ensuring efficient task execution without resource overstretching. Its essential for maintaining concurrency control in the broader repository architecture.                                             |
+| [close.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/close.ts)                                   | Agenda/close.ts secures the main functionality of closing database connections within the Agenda-TS project. It incorporates a provision for forcefully closing connections and handles exceptions that might arise during this process. The feature is specifically adapted for MongoDB databases that havent been preconfigured. |
+| [save-job.ts](https://github.com/meabed/agenda-ts/blob/master/src/agenda/save-job.ts)                             | <code>► INSERT-TEXT-HERE</code>                                                                                                                                                                                                                                                                                               |
 
 </details>
 
@@ -230,7 +231,7 @@ agenda.define('delete old users', async (job) => {
 /**
  * Example of defining a job with options
  */
-pulse.define(
+agenda.define(
   'send email report',
   async (job) => {
     const { to } = job.attrs.data;
@@ -286,7 +287,7 @@ function time() {
 
 - [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.
 - [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.
-- [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 Pulse by identifying and addressing past challenges.
+- [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.
 - [ ] **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.
 - [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.
 ---
@@ -343,11 +344,3 @@ Contributions are welcome! Here are several ways you can contribute:
 ##  License
 
 This project is protected under the [MIT](https://github.com/meabed/agenda-ts?tab=MIT-1-ov-file#readme) License. For more details, refer to the [LICENSE](https://github.com/meabed/agenda-ts?tab=MIT-1-ov-file#readme) file.
-
----
-<br/>
-<br/>
-
-
-##  Acknowledgments
-- Agenda-TS is maintained by [Mohamed Meabed](https://github.com/meabed) and was forked from the [Agenda](https://github.com/agenda/agenda) project.

package/dist/agenda/cancel.d.ts

@@ -0,0 +1,3 @@
+import { Document, Filter } from 'mongodb';
+export type CancelMethod = (query: Filter<Document>) => Promise<number | undefined>;
+export declare const cancel: CancelMethod;

package/dist/agenda/cancel.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cancel = void 0;
+const tslib_1 = require("tslib");
+const debug_1 = tslib_1.__importDefault(require("debug"));
+const debug = (0, debug_1.default)('agenda:cancel');
+const cancel = async function (query) {
+    debug('attempting to cancel all Agenda jobs', query);
+    try {
+        const { deletedCount } = await this._collection.deleteMany(query);
+        this.emit('cancel', deletedCount);
+        debug('%s jobs cancelled', deletedCount);
+        return deletedCount;
+    }
+    catch (error) {
+        debug('error trying to delete jobs from MongoDB');
+        throw error;
+    }
+};
+exports.cancel = cancel;
+//# sourceMappingURL=cancel.js.map

package/dist/agenda/cancel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cancel.js","sourceRoot":"","sources":["../../src/agenda/cancel.ts"],"names":[],"mappings":";;;;AAAA,0DAAmC;AAInC,MAAM,KAAK,GAAG,IAAA,eAAc,EAAC,eAAe,CAAC,CAAC;AAWvC,MAAM,MAAM,GAAiB,KAAK,WAAyB,KAAK;IACrE,KAAK,CAAC,sCAAsC,EAAE,KAAK,CAAC,CAAC;IACrD,IAAI,CAAC;QACH,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAClE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAElC,KAAK,CAAC,mBAAmB,EAAE,YAAY,CAAC,CAAC;QACzC,OAAO,YAAY,CAAC;IACtB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAClD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAZW,QAAA,MAAM,UAYjB"}

package/dist/agenda/close.d.ts

@@ -0,0 +1,5 @@
+import { Agenda } from '.';
+export type CloseMethod = (option?: {
+    force: boolean;
+}) => Promise<Agenda>;
+export declare const close: CloseMethod;

package/dist/agenda/close.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.close = void 0;
+const tslib_1 = require("tslib");
+const debug_1 = tslib_1.__importDefault(require("debug"));
+const debug = (0, debug_1.default)('agenda:close');
+const close = async function (option) {
+    debug('close db connection for this agenda instance');
+    const closeOptions = {
+        force: false,
+        ...option,
+    };
+    try {
+        if (this._db) {
+            await this._db.close(closeOptions.force);
+        }
+        return this;
+    }
+    catch (error) {
+        debug('error trying to close db connection to');
+        throw error;
+    }
+};
+exports.close = close;
+//# sourceMappingURL=close.js.map

package/dist/agenda/close.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"close.js","sourceRoot":"","sources":["../../src/agenda/close.ts"],"names":[],"mappings":";;;;AAAA,0DAAmC;AAGnC,MAAM,KAAK,GAAG,IAAA,eAAc,EAAC,cAAc,CAAC,CAAC;AAgBtC,MAAM,KAAK,GAAgB,KAAK,WAAyB,MAAO;IACrE,KAAK,CAAC,8CAA8C,CAAC,CAAC;IACtD,MAAM,YAAY,GAAG;QACnB,KAAK,EAAE,KAAK;QACZ,GAAG,MAAM;KACV,CAAC;IACF,IAAI,CAAC;QACH,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAC3C,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAChD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAhBW,QAAA,KAAK,SAgBhB"}

package/dist/agenda/count-jobs.d.ts

@@ -0,0 +1,5 @@
+import { CountDocumentsOptions, Filter } from 'mongodb';
+import { Agenda } from '.';
+export declare const countJobsRepo: (this: Agenda, query?: {}, options?: {}) => Promise<number>;
+export type CountJobsMethod = (query?: Filter<any>, options?: CountDocumentsOptions | undefined) => Promise<number>;
+export declare const countJobs: (this: Agenda, query?: {}, options?: {}) => Promise<number>;

package/dist/agenda/count-jobs.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.countJobs = exports.countJobsRepo = void 0;
+const countJobsRepo = async function (query = {}, options = {}) {
+    return await this._collection.countDocuments(query, options);
+};
+exports.countJobsRepo = countJobsRepo;
+const countJobs = async function (query = {}, options = {}) {
+    return await this._collection.countDocuments(query, options);
+};
+exports.countJobs = countJobs;
+//# sourceMappingURL=count-jobs.js.map

package/dist/agenda/count-jobs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"count-jobs.js","sourceRoot":"","sources":["../../src/agenda/count-jobs.ts"],"names":[],"mappings":";;;AAGO,MAAM,aAAa,GAAG,KAAK,WAAyB,KAAK,GAAG,EAAE,EAAE,OAAO,GAAG,EAAE;IACjF,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AAC/D,CAAC,CAAC;AAFW,QAAA,aAAa,iBAExB;AAWK,MAAM,SAAS,GAAG,KAAK,WAAyB,KAAK,GAAG,EAAE,EAAE,OAAO,GAAG,EAAE;IAC7E,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AAC/D,CAAC,CAAC;AAFW,QAAA,SAAS,aAEpB"}

package/dist/agenda/create.d.ts

@@ -0,0 +1,3 @@
+import { Job, JobAttributesData } from '../job';
+export type CreateMethod = <T extends JobAttributesData>(name: string, data: T) => Job<T>;
+export declare const create: CreateMethod;

package/dist/agenda/create.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.create = void 0;
+const tslib_1 = require("tslib");
+const debug_1 = tslib_1.__importDefault(require("debug"));
+const job_1 = require("../job");
+const debug = (0, debug_1.default)('agenda:create');
+const create = function (name, data) {
+    debug('Agenda.create(%s, [Object])', name);
+    const priority = this._definitions[name] ? this._definitions[name].priority : 0;
+    const shouldSaveResult = this._definitions[name] ? this._definitions[name].shouldSaveResult || false : false;
+    const attempts = this._definitions[name] ? this._definitions[name].attempts || 0 : 0;
+    const backoff = attempts
+        ? this._definitions[name]
+            ? this._definitions[name].backoff || { type: 'exponential', delay: 1000 }
+            : { type: 'exponential', delay: 1000 }
+        : undefined;
+    const job = new job_1.Job({
+        name,
+        data,
+        type: 'normal',
+        priority,
+        shouldSaveResult,
+        attempts,
+        backoff,
+        agenda: this,
+    });
+    return job;
+};
+exports.create = create;
+//# sourceMappingURL=create.js.map

package/dist/agenda/create.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create.js","sourceRoot":"","sources":["../../src/agenda/create.ts"],"names":[],"mappings":";;;;AAAA,0DAAmC;AAEnC,gCAAgD;AAEhD,MAAM,KAAK,GAAG,IAAA,eAAc,EAAC,eAAe,CAAC,CAAC;AAUvC,MAAM,MAAM,GAAiB,UAAwB,IAAI,EAAE,IAAI;IACpE,KAAK,CAAC,6BAA6B,EAAE,IAAI,CAAC,CAAC;IAC3C,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAChF,MAAM,gBAAgB,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,gBAAgB,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC;IAC7G,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACrF,MAAM,OAAO,GAAG,QAAQ;QACtB,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;YACvB,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,OAAO,IAAI,EAAE,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,IAAI,EAAE;YACzE,CAAC,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,IAAI,EAAE;QACxC,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,GAAG,GAAG,IAAI,SAAG,CAAC;QAClB,IAAI;QACJ,IAAI;QACJ,IAAI,EAAE,QAAQ;QACd,QAAQ;QACR,gBAAgB;QAChB,QAAQ;QACR,OAAO;QACP,MAAM,EAAE,IAAI;KACb,CAAC,CAAC;IAEH,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAvBW,QAAA,MAAM,UAuBjB"}

package/dist/agenda/database.d.ts

@@ -0,0 +1,4 @@
+import { AnyError, Collection, MongoClientOptions } from 'mongodb';
+import { Agenda } from '.';
+export type DatabaseMethod = (this: Agenda, url: string, collection?: string, options?: MongoClientOptions, cb?: (error: AnyError | undefined, collection: Collection<any> | null) => void) => Promise<Agenda | void>;
+export declare const database: DatabaseMethod;

package/dist/agenda/database.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.database = void 0;
+const tslib_1 = require("tslib");
+const debug_1 = tslib_1.__importDefault(require("debug"));
+const mongodb_1 = require("mongodb");
+const utils_1 = require("../utils");
+const has_mongo_protocol_1 = require("./has-mongo-protocol");
+const debug = (0, debug_1.default)('agenda:database');
+const database = async function (url, collection, options = {}, cb) {
+    if (!(0, has_mongo_protocol_1.hasMongoProtocol)(url)) {
+        url = 'mongodb://' + url;
+    }
+    collection = collection || 'agendaJobs';
+    const client = await mongodb_1.MongoClient.connect(url, options).catch((error) => {
+        debug('error connecting to MongoDB using collection: [%s]', collection);
+        if (cb) {
+            cb(error, null);
+        }
+        else {
+            throw new utils_1.BaseError(error);
+        }
+    });
+    if (!client) {
+        throw new utils_1.BaseError('Mongo Client is undefined');
+    }
+    this._db = client;
+    this._mdb = client.db();
+    this.dbInit(collection, cb);
+    return this;
+};
+exports.database = database;
+//# sourceMappingURL=database.js.map

package/dist/agenda/database.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"database.js","sourceRoot":"","sources":["../../src/agenda/database.ts"],"names":[],"mappings":";;;;AAAA,0DAAmC;AACnC,qCAAgF;AAEhF,oCAAqC;AACrC,6DAAwD;AAExD,MAAM,KAAK,GAAG,IAAA,eAAc,EAAC,iBAAiB,CAAC,CAAC;AA0BzC,MAAM,QAAQ,GAAmB,KAAK,WAAyB,GAAG,EAAE,UAAW,EAAE,OAAO,GAAG,EAAE,EAAE,EAAG;IACvG,IAAI,CAAC,IAAA,qCAAgB,EAAC,GAAG,CAAC,EAAE,CAAC;QAC3B,GAAG,GAAG,YAAY,GAAG,GAAG,CAAC;IAC3B,CAAC;IAED,UAAU,GAAG,UAAU,IAAI,YAAY,CAAC;IAExC,MAAM,MAAM,GAAG,MAAM,qBAAW,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACrE,KAAK,CAAC,oDAAoD,EAAE,UAAU,CAAC,CAAC;QACxE,IAAI,EAAE,EAAE,CAAC;YACP,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAClB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,iBAAS,CAAC,KAAK,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,iBAAS,CAAC,2BAA2B,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC;IAClB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,EAAE,EAAE,CAAC;IACxB,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IAC5B,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAxBW,QAAA,QAAQ,YAwBnB"}

package/dist/agenda/db-init.d.ts

@@ -0,0 +1,3 @@
+import { AnyError, Collection } from 'mongodb';
+export type DbInitMethod = (collection?: string, cb?: (error: AnyError | undefined, collection: Collection<any> | null) => void) => void;
+export declare const dbInit: DbInitMethod;

package/dist/agenda/db-init.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dbInit = void 0;
+const tslib_1 = require("tslib");
+const debug_1 = tslib_1.__importDefault(require("debug"));
+const debug = (0, debug_1.default)('agenda:db_init');
+const dbInit = function (collection = 'agendaJobs', cb) {
+    debug('init database collection using name [%s]', collection);
+    this._collection = this._mdb.collection(collection);
+    if (this._resumeOnRestart) {
+        this.resumeOnRestart(this._resumeOnRestart);
+    }
+    if (this._disableAutoIndex) {
+        debug('skipping auto index creation');
+        this.emit('ready');
+        return;
+    }
+    debug('attempting index creation');
+    this._collection
+        .createIndex(this._indices, { name: 'findAndLockNextJobIndex' })
+        .then(() => {
+        debug('index creation success');
+        this.emit('ready');
+    })
+        .catch((error) => {
+        debug('index creation failed');
+        this.emit('error', error);
+        if (cb) {
+            cb(error, this._collection);
+        }
+    });
+};
+exports.dbInit = dbInit;
+//# sourceMappingURL=db-init.js.map

package/dist/agenda/db-init.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"db-init.js","sourceRoot":"","sources":["../../src/agenda/db-init.ts"],"names":[],"mappings":";;;;AAAA,0DAAmC;AAInC,MAAM,KAAK,GAAG,IAAA,eAAc,EAAC,gBAAgB,CAAC,CAAC;AAcxC,MAAM,MAAM,GAAiB,UAAwB,UAAU,GAAG,YAAY,EAAE,EAAG;IACxF,KAAK,CAAC,0CAA0C,EAAE,UAAU,CAAC,CAAC;IAC9D,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IAEpD,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC1B,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC9C,CAAC;IAED,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC3B,KAAK,CAAC,8BAA8B,CAAC,CAAC;QACtC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnB,OAAO;IACT,CAAC;IAED,KAAK,CAAC,2BAA2B,CAAC,CAAC;IACnC,IAAI,CAAC,WAAW;SACb,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,yBAAyB,EAAE,CAAC;SAC/D,IAAI,CAAC,GAAG,EAAE;QACT,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrB,CAAC,CAAC;SACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACf,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC/B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC1B,IAAI,EAAE,EAAE,CAAC;YACP,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AA5BW,QAAA,MAAM,UA4BjB"}

package/dist/agenda/default-concurrency.d.ts

@@ -0,0 +1,3 @@
+import { Agenda } from '.';
+export type DefaultConcurrencyMethod = (concurrency: number) => Agenda;
+export declare const defaultConcurrency: DefaultConcurrencyMethod;

package/dist/agenda/default-concurrency.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultConcurrency = void 0;
+const tslib_1 = require("tslib");
+const debug_1 = tslib_1.__importDefault(require("debug"));
+const debug = (0, debug_1.default)('agenda:defaultConcurrency');
+const defaultConcurrency = function (concurrency) {
+    debug('Agenda.defaultConcurrency(%d)', concurrency);
+    this._defaultConcurrency = concurrency;
+    return this;
+};
+exports.defaultConcurrency = defaultConcurrency;
+//# sourceMappingURL=default-concurrency.js.map

package/dist/agenda/default-concurrency.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-concurrency.js","sourceRoot":"","sources":["../../src/agenda/default-concurrency.ts"],"names":[],"mappings":";;;;AAAA,0DAAmC;AAGnC,MAAM,KAAK,GAAG,IAAA,eAAc,EAAC,2BAA2B,CAAC,CAAC;AASnD,MAAM,kBAAkB,GAA6B,UAAwB,WAAW;IAC7F,KAAK,CAAC,+BAA+B,EAAE,WAAW,CAAC,CAAC;IACpD,IAAI,CAAC,mBAAmB,GAAG,WAAW,CAAC;IACvC,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAJW,QAAA,kBAAkB,sBAI7B"}

package/dist/agenda/default-lock-lifetime.d.ts

@@ -0,0 +1,3 @@
+import { Agenda } from '.';
+export type DefaultLockLifetimeMethod = (ms: number) => Agenda;
+export declare const defaultLockLifetime: DefaultLockLifetimeMethod;

package/dist/agenda/default-lock-lifetime.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultLockLifetime = void 0;
+const tslib_1 = require("tslib");
+const debug_1 = tslib_1.__importDefault(require("debug"));
+const debug = (0, debug_1.default)('agenda:defaultLockLifetime');
+const defaultLockLifetime = function (ms) {
+    debug('Agenda.defaultLockLifetime(%d)', ms);
+    this._defaultLockLifetime = ms;
+    return this;
+};
+exports.defaultLockLifetime = defaultLockLifetime;
+//# sourceMappingURL=default-lock-lifetime.js.map

package/dist/agenda/default-lock-lifetime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-lock-lifetime.js","sourceRoot":"","sources":["../../src/agenda/default-lock-lifetime.ts"],"names":[],"mappings":";;;;AAAA,0DAAmC;AAGnC,MAAM,KAAK,GAAG,IAAA,eAAc,EAAC,4BAA4B,CAAC,CAAC;AAWpD,MAAM,mBAAmB,GAA8B,UAAwB,EAAE;IACtF,KAAK,CAAC,gCAAgC,EAAE,EAAE,CAAC,CAAC;IAC5C,IAAI,CAAC,oBAAoB,GAAG,EAAE,CAAC;IAC/B,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAJW,QAAA,mBAAmB,uBAI9B"}

package/dist/agenda/default-lock-limit.d.ts

@@ -0,0 +1,3 @@
+import { Agenda } from '.';
+export type DefaultLockLimitMethod = (times: number) => Agenda;
+export declare const defaultLockLimit: DefaultLockLimitMethod;

package/dist/agenda/default-lock-limit.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultLockLimit = void 0;
+const tslib_1 = require("tslib");
+const debug_1 = tslib_1.__importDefault(require("debug"));
+const debug = (0, debug_1.default)('agenda:defaultLockLimit');
+const defaultLockLimit = function (times) {
+    debug('Agenda.defaultLockLimit(%d)', times);
+    this._defaultLockLimit = times;
+    return this;
+};
+exports.defaultLockLimit = defaultLockLimit;
+//# sourceMappingURL=default-lock-limit.js.map

package/dist/agenda/default-lock-limit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-lock-limit.js","sourceRoot":"","sources":["../../src/agenda/default-lock-limit.ts"],"names":[],"mappings":";;;;AAAA,0DAAmC;AAGnC,MAAM,KAAK,GAAG,IAAA,eAAc,EAAC,yBAAyB,CAAC,CAAC;AAUjD,MAAM,gBAAgB,GAA2B,UAAwB,KAAK;IACnF,KAAK,CAAC,6BAA6B,EAAE,KAAK,CAAC,CAAC;IAC5C,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;IAC/B,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAJW,QAAA,gBAAgB,oBAI3B"}

package/dist/agenda/define.d.ts

@@ -0,0 +1,23 @@
+import { Job, JobAttributesData } from '../job';
+export declare enum JobPriority {
+    highest = 20,
+    high = 10,
+    normal = 0,
+    low = -10,
+    lowest = -20
+}
+export interface DefineOptions {
+    concurrency?: number;
+    lockLimit?: number;
+    lockLifetime?: number;
+    priority?: keyof typeof JobPriority;
+    shouldSaveResult?: boolean;
+    attempts?: number;
+    backoff?: {
+        type: 'exponential' | 'fixed';
+        delay: number;
+    };
+}
+export type Processor<T extends JobAttributesData> = (job: Job<T>, done: (error?: Error, result?: unknown) => void) => unknown | Promise<unknown>;
+export type DefineMethod = <T extends JobAttributesData>(name: string, processor: Processor<T>, options?: DefineOptions) => void;
+export declare const define: DefineMethod;

package/dist/agenda/define.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.define = exports.JobPriority = void 0;
+const tslib_1 = require("tslib");
+const debug_1 = tslib_1.__importDefault(require("debug"));
+const debug = (0, debug_1.default)('agenda:define');
+var JobPriority;
+(function (JobPriority) {
+    JobPriority[JobPriority["highest"] = 20] = "highest";
+    JobPriority[JobPriority["high"] = 10] = "high";
+    JobPriority[JobPriority["normal"] = 0] = "normal";
+    JobPriority[JobPriority["low"] = -10] = "low";
+    JobPriority[JobPriority["lowest"] = -20] = "lowest";
+})(JobPriority || (exports.JobPriority = JobPriority = {}));
+const define = function (name, processor, options) {
+    this._definitions[name] = {
+        fn: processor,
+        concurrency: options?.concurrency || this._defaultConcurrency,
+        lockLimit: options?.lockLimit || this._defaultLockLimit,
+        priority: options?.priority || JobPriority.normal,
+        lockLifetime: options?.lockLifetime || this._defaultLockLifetime,
+        running: 0,
+        locked: 0,
+        shouldSaveResult: options?.shouldSaveResult || false,
+        attempts: options?.attempts || 0,
+        backoff: options?.attempts && {
+            type: options?.backoff?.type || 'exponential',
+            delay: options?.backoff?.delay || 1000,
+        },
+    };
+    debug('job [%s] defined with following options: \n%O', name, this._definitions[name]);
+};
+exports.define = define;
+//# sourceMappingURL=define.js.map

package/dist/agenda/define.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"define.js","sourceRoot":"","sources":["../../src/agenda/define.ts"],"names":[],"mappings":";;;;AAAA,0DAAmC;AAInC,MAAM,KAAK,GAAG,IAAA,eAAc,EAAC,eAAe,CAAC,CAAC;AAE9C,IAAY,WAMX;AAND,WAAY,WAAW;IACrB,oDAAY,CAAA;IACZ,8CAAS,CAAA;IACT,iDAAU,CAAA;IACV,6CAAS,CAAA;IACT,mDAAY,CAAA;AACd,CAAC,EANW,WAAW,2BAAX,WAAW,QAMtB;AA2EM,MAAM,MAAM,GAAiB,UAAwB,IAAI,EAAE,SAAS,EAAE,OAAQ;IACnF,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG;QACxB,EAAE,EAAE,SAAS;QACb,WAAW,EAAE,OAAO,EAAE,WAAW,IAAI,IAAI,CAAC,mBAAmB;QAC7D,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,IAAI,CAAC,iBAAiB;QACvD,QAAQ,EAAE,OAAO,EAAE,QAAQ,IAAI,WAAW,CAAC,MAAM;QACjD,YAAY,EAAE,OAAO,EAAE,YAAY,IAAI,IAAI,CAAC,oBAAoB;QAChE,OAAO,EAAE,CAAC;QACV,MAAM,EAAE,CAAC;QACT,gBAAgB,EAAE,OAAO,EAAE,gBAAgB,IAAI,KAAK;QACpD,QAAQ,EAAE,OAAO,EAAE,QAAQ,IAAI,CAAC;QAChC,OAAO,EAAE,OAAO,EAAE,QAAQ,IAAI;YAC5B,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,IAAI,aAAa;YAC7C,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,IAAI,IAAI;SACvC;KACF,CAAC;IAEF,KAAK,CAAC,+CAA+C,EAAE,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;AACxF,CAAC,CAAC;AAlBW,QAAA,MAAM,UAkBjB"}

package/dist/agenda/disable.d.ts

@@ -0,0 +1,3 @@
+import { Filter } from 'mongodb';
+export type DisableMethod = (query?: Filter<unknown>) => Promise<number>;
+export declare const disable: DisableMethod;

package/dist/agenda/disable.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.disable = void 0;
+const tslib_1 = require("tslib");
+const debug_1 = tslib_1.__importDefault(require("debug"));
+const debug = (0, debug_1.default)('agenda:disable');
+const disable = async function (query = {}) {
+    debug('attempting to disable all jobs matching query', query);
+    try {
+        const { modifiedCount } = await this._collection.updateMany(query, {
+            $set: { disabled: true },
+        });
+        debug('%s jobs disabled');
+        return modifiedCount;
+    }
+    catch (error) {
+        debug('error trying to mark jobs as `disabled`');
+        throw error;
+    }
+};
+exports.disable = disable;
+//# sourceMappingURL=disable.js.map

package/dist/agenda/disable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"disable.js","sourceRoot":"","sources":["../../src/agenda/disable.ts"],"names":[],"mappings":";;;;AAAA,0DAAmC;AAGnC,MAAM,KAAK,GAAG,IAAA,eAAc,EAAC,gBAAgB,CAAC,CAAC;AAUxC,MAAM,OAAO,GAAkB,KAAK,WAAyB,KAAK,GAAG,EAAE;IAC5E,KAAK,CAAC,+CAA+C,EAAE,KAAK,CAAC,CAAC;IAC9D,IAAI,CAAC;QACH,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,KAAK,EAAE;YACjE,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;SACzB,CAAC,CAAC;QACH,KAAK,CAAC,kBAAkB,CAAC,CAAC;QAC1B,OAAO,aAAa,CAAC;IACvB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,KAAK,CAAC,yCAAyC,CAAC,CAAC;QACjD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAZW,QAAA,OAAO,WAYlB"}

package/dist/agenda/drain.d.ts

@@ -0,0 +1,2 @@
+export type DrainMethod = () => Promise<void>;
+export declare const drain: DrainMethod;