@shrub/queue 0.5.54 → 0.5.57

package/dist/queue.d.ts

@@ -1,5 +1,5 @@
 import { IEvent } from "@sprig/event-emitter";
-export declare type ProcessJobCallback = (job: IJob) => Promise<void | any>;
+export declare type WorkerCallback<TData = any> = (job: IJob<TData>) => Promise<void | any>;
 /** Defines the API for a queue. */
 export interface IQueue {
     /** An event that is raised when a job has become active. */
@@ -11,11 +11,11 @@ export interface IQueue {
     /** An event that is raised when a job has reported progress. */
     readonly onJobProgress: IEvent<IJobProgressEventArgs>;
     /** Adds a job to the queue. */
-    add(options: IJobOptions): Promise<IJob>;
+    add<TData = any>(options: IJobOptions<TData>): Promise<IJob<TData>>;
     /** Closes the queue and all workers associated with the queue. */
     close(): Promise<void>;
-    /** Registers a callback for handling/processing jobs. */
-    process(optionsOrCallback: IProcessOptions | ProcessJobCallback): IWorker;
+    /** Creates a new worker for handling/processing jobs. */
+    createWorker<TData = any>(optionsOrCallback: IWorkerOptions<TData> | WorkerCallback<TData>): IWorker;
 }
 /** Responsible for providing access to a queue. */
 export interface IQueueAdapter {
@@ -23,18 +23,20 @@ export interface IQueueAdapter {
     getQueue(name: string): IQueue | undefined;
 }
 /** Represents a specific instance of a job in the queue. */
-export interface IJob {
+export interface IJob<TData = any> {
     readonly id: string;
-    readonly data: any;
+    readonly name: string;
+    readonly data: TData;
     readonly progress: number | object;
     updateProgress(progress: number | object): Promise<void>;
+    waitUntilFinished(): Promise<any>;
 }
 /** Defines options for creating jobs. */
-export interface IJobOptions {
+export interface IJobOptions<TData = any> {
     /** A name for the job. */
     readonly name?: string;
     /** Data to pass to the job. */
-    readonly data?: any;
+    readonly data?: TData;
     /** The amount of time (in milliseconds) to delay before the job can be processed; if not defined, the job can be processed immediately. */
     readonly delay?: number;
     /** Options for repeatable jobs. */
@@ -48,9 +50,9 @@ export interface IJobRepeatOptions {
     readonly immediate?: boolean;
 }
 /** Defines options for registering a process for handling jobs. */
-export interface IProcessOptions {
+export interface IWorkerOptions<TData = any> {
     /** A callback for handling jobs. */
-    readonly callback: ProcessJobCallback;
+    readonly callback: WorkerCallback<TData>;
     /** Optionally specifies the maximum number of parallel jobs that can be processed at once; if not specified, the underlying queue's default will be used. */
     readonly concurrency?: number;
 }
@@ -81,5 +83,5 @@ export declare abstract class QueueAdapter implements IQueueAdapter {
     addQueueNamePatterns(queueNamePatterns: string[]): void;
     getQueue(name: string): IQueue | undefined;
     protected abstract getQueueInstance(name: string): IQueue;
-    protected getProcessOptions(optionsOrCallback: IProcessOptions | ProcessJobCallback): IProcessOptions;
+    protected getWorkerOptions(optionsOrCallback: IWorkerOptions | WorkerCallback): IWorkerOptions;
 }

package/dist/queue.js

@@ -13,9 +13,9 @@ class QueueAdapter {
     getQueue(name) {
         return this.whitelist.isQueueSupported(name) ? this.getQueueInstance(name) : undefined;
     }
-    getProcessOptions(optionsOrCallback) {
+    getWorkerOptions(optionsOrCallback) {
         return typeof optionsOrCallback === "function" ? { callback: optionsOrCallback } : optionsOrCallback;
     }
 }
 exports.QueueAdapter = QueueAdapter;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicXVldWUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvcXVldWUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQ0EsMkNBQW9EO0FBeUZwRCxzSEFBc0g7QUFDdEgsTUFBc0IsWUFBWTtJQUc5QixZQUFZLGlCQUEyQjtRQUNuQyxJQUFJLENBQUMsU0FBUyxHQUFHLElBQUksaUNBQXFCLENBQUMsaUJBQWlCLENBQUMsQ0FBQztJQUNsRSxDQUFDO0lBRUQsb0JBQW9CLENBQUMsaUJBQTJCO1FBQzVDLGlCQUFpQixDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsRUFBRSxDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsR0FBRyxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUM7SUFDdEUsQ0FBQztJQUVELFFBQVEsQ0FBQyxJQUFZO1FBQ2pCLE9BQU8sSUFBSSxDQUFDLFNBQVMsQ0FBQyxnQkFBZ0IsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLGdCQUFnQixDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUM7SUFDM0YsQ0FBQztJQUlTLGlCQUFpQixDQUFDLGlCQUF1RDtRQUMvRSxPQUFPLE9BQU8saUJBQWlCLEtBQUssVUFBVSxDQUFDLENBQUMsQ0FBQyxFQUFFLFFBQVEsRUFBRSxpQkFBaUIsRUFBRSxDQUFDLENBQUMsQ0FBQyxpQkFBaUIsQ0FBQztJQUN6RyxDQUFDO0NBQ0o7QUFwQkQsb0NBb0JDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicXVldWUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvcXVldWUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQ0EsMkNBQW9EO0FBMkZwRCxzSEFBc0g7QUFDdEgsTUFBc0IsWUFBWTtJQUc5QixZQUFZLGlCQUEyQjtRQUNuQyxJQUFJLENBQUMsU0FBUyxHQUFHLElBQUksaUNBQXFCLENBQUMsaUJBQWlCLENBQUMsQ0FBQztJQUNsRSxDQUFDO0lBRUQsb0JBQW9CLENBQUMsaUJBQTJCO1FBQzVDLGlCQUFpQixDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsRUFBRSxDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsR0FBRyxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUM7SUFDdEUsQ0FBQztJQUVELFFBQVEsQ0FBQyxJQUFZO1FBQ2pCLE9BQU8sSUFBSSxDQUFDLFNBQVMsQ0FBQyxnQkFBZ0IsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLGdCQUFnQixDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUM7SUFDM0YsQ0FBQztJQUlTLGdCQUFnQixDQUFDLGlCQUFrRDtRQUN6RSxPQUFPLE9BQU8saUJBQWlCLEtBQUssVUFBVSxDQUFDLENBQUMsQ0FBQyxFQUFFLFFBQVEsRUFBRSxpQkFBaUIsRUFBRSxDQUFDLENBQUMsQ0FBQyxpQkFBaUIsQ0FBQztJQUN6RyxDQUFDO0NBQ0o7QUFwQkQsb0NBb0JDIn0=

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@shrub/queue",
     "description": "Provides a basic abstraction and support for job/task queues.",
-    "version": "0.5.54",
+    "version": "0.5.57",
     "license": "MIT",
     "repository": {
         "type": "git",
@@ -25,9 +25,9 @@
         "test": "jest"
     },
     "dependencies": {
-        "@shrub/core": "0.5.54",
-        "@shrub/logging": "0.5.54",
+        "@shrub/core": "0.5.57",
+        "@shrub/logging": "0.5.57",
         "@sprig/event-emitter": "^0.2.0"
     },
-    "gitHead": "53e4be36d5c2044e4249088151cb2aadff2f2830"
+    "gitHead": "c70ed65dc59fafe57717abae0f3775cdc491e929"
 }