@shrub/queue 0.5.61 → 0.5.62
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/dist/queue.d.ts +6 -0
- package/dist/queue.js +1 -1
- package/package.json +4 -4
package/dist/queue.d.ts
CHANGED
|
@@ -2,12 +2,16 @@ import { IEvent } from "@sprig/event-emitter";
|
|
|
2
2
|
export declare type WorkerCallback<TData = any> = (job: IJob<TData>) => Promise<void | any>;
|
|
3
3
|
/** Defines the API for a queue. */
|
|
4
4
|
export interface IQueue {
|
|
5
|
+
/** The name of the queue. */
|
|
6
|
+
readonly name: string;
|
|
5
7
|
/** Adds a job to the queue. */
|
|
6
8
|
add<TData = any>(options: IJobOptions<TData>): Promise<IJob<TData>>;
|
|
7
9
|
/** Closes the queue and all workers associated with the queue. */
|
|
8
10
|
close(): Promise<void>;
|
|
9
11
|
/** Creates a new worker for handling/processing jobs. */
|
|
10
12
|
createWorker<TData = any>(optionsOrCallback: IWorkerOptions<TData> | WorkerCallback<TData>): IWorker;
|
|
13
|
+
/** Waits until the queue is ready for processing. */
|
|
14
|
+
waitUntilReady(): Promise<void>;
|
|
11
15
|
}
|
|
12
16
|
/** Responsible for providing access to a queue. */
|
|
13
17
|
export interface IQueueAdapter {
|
|
@@ -65,6 +69,8 @@ export interface IWorker {
|
|
|
65
69
|
readonly onJobProgress: IEvent<IJobProgressEventArgs>;
|
|
66
70
|
/** Closes the worker and all underlying connections. */
|
|
67
71
|
close(): Promise<void>;
|
|
72
|
+
/** Waits until the worker is ready for processing. */
|
|
73
|
+
waitUntilReady(): Promise<void>;
|
|
68
74
|
}
|
|
69
75
|
export interface IJobActiveEventArgs {
|
|
70
76
|
readonly job: IJob;
|
package/dist/queue.js
CHANGED
|
@@ -18,4 +18,4 @@ class QueueAdapter {
|
|
|
18
18
|
}
|
|
19
19
|
}
|
|
20
20
|
exports.QueueAdapter = QueueAdapter;
|
|
21
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
21
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicXVldWUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvcXVldWUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQ0EsMkNBQW9EO0FBc0dwRCxzSEFBc0g7QUFDdEgsTUFBc0IsWUFBWTtJQUc5QixZQUFZLGlCQUEyQjtRQUNuQyxJQUFJLENBQUMsU0FBUyxHQUFHLElBQUksaUNBQXFCLENBQUMsaUJBQWlCLENBQUMsQ0FBQztJQUNsRSxDQUFDO0lBRUQsb0JBQW9CLENBQUMsaUJBQTJCO1FBQzVDLGlCQUFpQixDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsRUFBRSxDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsR0FBRyxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUM7SUFDdEUsQ0FBQztJQUVELFFBQVEsQ0FBQyxJQUFZO1FBQ2pCLE9BQU8sSUFBSSxDQUFDLFNBQVMsQ0FBQyxnQkFBZ0IsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLGdCQUFnQixDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUM7SUFDM0YsQ0FBQztJQUlTLGdCQUFnQixDQUFDLGlCQUFrRDtRQUN6RSxPQUFPLE9BQU8saUJBQWlCLEtBQUssVUFBVSxDQUFDLENBQUMsQ0FBQyxFQUFFLFFBQVEsRUFBRSxpQkFBaUIsRUFBRSxDQUFDLENBQUMsQ0FBQyxpQkFBaUIsQ0FBQztJQUN6RyxDQUFDO0NBQ0o7QUFwQkQsb0NBb0JDIn0=
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@shrub/queue",
|
|
3
3
|
"description": "Provides a basic abstraction and support for job/task queues.",
|
|
4
|
-
"version": "0.5.
|
|
4
|
+
"version": "0.5.62",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
@@ -25,9 +25,9 @@
|
|
|
25
25
|
"test": "jest"
|
|
26
26
|
},
|
|
27
27
|
"dependencies": {
|
|
28
|
-
"@shrub/core": "0.5.
|
|
29
|
-
"@shrub/logging": "0.5.
|
|
28
|
+
"@shrub/core": "0.5.62",
|
|
29
|
+
"@shrub/logging": "0.5.62",
|
|
30
30
|
"@sprig/event-emitter": "^0.2.0"
|
|
31
31
|
},
|
|
32
|
-
"gitHead": "
|
|
32
|
+
"gitHead": "6f71a2e83f1609ac912e5bcda23cfe2ad41cb90e"
|
|
33
33
|
}
|