@shrub/queue 0.5.50 → 0.5.53
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 +7 -1
- package/dist/queue.js +4 -1
- package/package.json +4 -4
package/dist/queue.d.ts
CHANGED
|
@@ -2,6 +2,8 @@ import { IEvent } from "@sprig/event-emitter";
|
|
|
2
2
|
export declare type ProcessJobCallback = (job: IJob) => Promise<void | any>;
|
|
3
3
|
/** Defines the API for a queue. */
|
|
4
4
|
export interface IQueue {
|
|
5
|
+
/** An event that is raised when a job has become active. */
|
|
6
|
+
readonly onJobActive: IEvent<IJobActiveEventArgs>;
|
|
5
7
|
/** An event that is raised when a job has completed. */
|
|
6
8
|
readonly onJobCompleted: IEvent<IJobCompletedEventArgs>;
|
|
7
9
|
/** An event that is raised when a job has failed. */
|
|
@@ -11,7 +13,7 @@ export interface IQueue {
|
|
|
11
13
|
/** Adds a job to the queue. */
|
|
12
14
|
add(options: IJobOptions): Promise<IJob>;
|
|
13
15
|
/** Registers a callback for handling/processing jobs. */
|
|
14
|
-
process(
|
|
16
|
+
process(optionsOrCallback: IProcessOptions | ProcessJobCallback): IWorker;
|
|
15
17
|
}
|
|
16
18
|
/** Responsible for providing access to a queue. */
|
|
17
19
|
export interface IQueueAdapter {
|
|
@@ -55,6 +57,9 @@ export interface IWorker {
|
|
|
55
57
|
/** Closes the worker and all underlying connections. */
|
|
56
58
|
close(): Promise<void>;
|
|
57
59
|
}
|
|
60
|
+
export interface IJobActiveEventArgs {
|
|
61
|
+
readonly job: IJob;
|
|
62
|
+
}
|
|
58
63
|
export interface IJobCompletedEventArgs {
|
|
59
64
|
readonly job: IJob;
|
|
60
65
|
readonly returnValue: any;
|
|
@@ -74,4 +79,5 @@ export declare abstract class QueueAdapter implements IQueueAdapter {
|
|
|
74
79
|
addQueueNamePatterns(queueNamePatterns: string[]): void;
|
|
75
80
|
getQueue(name: string): IQueue | undefined;
|
|
76
81
|
protected abstract getQueueInstance(name: string): IQueue;
|
|
82
|
+
protected getProcessOptions(optionsOrCallback: IProcessOptions | ProcessJobCallback): IProcessOptions;
|
|
77
83
|
}
|
package/dist/queue.js
CHANGED
|
@@ -13,6 +13,9 @@ class QueueAdapter {
|
|
|
13
13
|
getQueue(name) {
|
|
14
14
|
return this.whitelist.isQueueSupported(name) ? this.getQueueInstance(name) : undefined;
|
|
15
15
|
}
|
|
16
|
+
getProcessOptions(optionsOrCallback) {
|
|
17
|
+
return typeof optionsOrCallback === "function" ? { callback: optionsOrCallback } : optionsOrCallback;
|
|
18
|
+
}
|
|
16
19
|
}
|
|
17
20
|
exports.QueueAdapter = QueueAdapter;
|
|
18
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
21
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicXVldWUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvcXVldWUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQ0EsMkNBQW9EO0FBdUZwRCxzSEFBc0g7QUFDdEgsTUFBc0IsWUFBWTtJQUc5QixZQUFZLGlCQUEyQjtRQUNuQyxJQUFJLENBQUMsU0FBUyxHQUFHLElBQUksaUNBQXFCLENBQUMsaUJBQWlCLENBQUMsQ0FBQztJQUNsRSxDQUFDO0lBRUQsb0JBQW9CLENBQUMsaUJBQTJCO1FBQzVDLGlCQUFpQixDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsRUFBRSxDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsR0FBRyxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUM7SUFDdEUsQ0FBQztJQUVELFFBQVEsQ0FBQyxJQUFZO1FBQ2pCLE9BQU8sSUFBSSxDQUFDLFNBQVMsQ0FBQyxnQkFBZ0IsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLGdCQUFnQixDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUM7SUFDM0YsQ0FBQztJQUlTLGlCQUFpQixDQUFDLGlCQUF1RDtRQUMvRSxPQUFPLE9BQU8saUJBQWlCLEtBQUssVUFBVSxDQUFDLENBQUMsQ0FBQyxFQUFFLFFBQVEsRUFBRSxpQkFBaUIsRUFBRSxDQUFDLENBQUMsQ0FBQyxpQkFBaUIsQ0FBQztJQUN6RyxDQUFDO0NBQ0o7QUFwQkQsb0NBb0JDIn0=
|
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.53",
|
|
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.53",
|
|
29
|
+
"@shrub/logging": "0.5.53",
|
|
30
30
|
"@sprig/event-emitter": "^0.2.0"
|
|
31
31
|
},
|
|
32
|
-
"gitHead": "
|
|
32
|
+
"gitHead": "dfb47977e62c20866a630b4a32ff93d4199bc496"
|
|
33
33
|
}
|