@arkstack/queue 0.19.1 → 0.19.3

package/README.md

@@ -18,7 +18,7 @@ Queue module for Arkstack, providing a driver based queue transport and worker f
 
 ```ts
 // src/config/queue.ts
-import type { QueueConfig } from '@arkstack/queue';
+import type { QueueConfig } from '@arkstack/queue'
 
 export default (): QueueConfig => ({
   default: env('QUEUE_CONNECTION', 'sync'),
@@ -31,19 +31,19 @@ export default (): QueueConfig => ({
       port: env('REDIS_PORT', 6379),
     },
   },
-});
+})
 ```
 
 ## Usage
 
 ```ts
-import { Queue } from '@arkstack/queue';
+import { Queue } from '@arkstack/queue'
 
-await Queue.push(new SendWelcomeEmail(user)); // onto the default connection
-await Queue.later(60, new ChargeInvoice(invoiceId)); // after 60 seconds
-await Queue.connection('redis').push(job, 'emails'); // a specific connection/queue
-await Queue.size('emails');
-await Queue.clear('emails');
+await Queue.push(new SendWelcomeEmail(user)) // onto the default connection
+await Queue.later(60, new ChargeInvoice(invoiceId)) // after 60 seconds
+await Queue.connection('redis').push(job, 'emails') // a specific connection/queue
+await Queue.size('emails')
+await Queue.clear('emails')
 ```
 
 ## Workers
@@ -58,10 +58,10 @@ ark queue:clear redis --queue=emails
 Programmatically:
 
 ```ts
-import { Queue } from '@arkstack/queue';
+import { Queue } from '@arkstack/queue'
 
-const worker = Queue.worker('database');
-await worker.daemon({ queue: 'default', sleep: 3 });
+const worker = Queue.worker('database')
+await worker.daemon({ queue: 'default', sleep: 3 })
 ```
 
 A job is **deleted** on success, **released** for another attempt on failure, and **marked failed** (invoking its `failed` hook) once it exhausts `tries`.
@@ -73,10 +73,8 @@ instances in the worker. `@arkstack/jobs` registers these strategies for you; to
 do it manually:
 
 ```ts
-import { Queue } from '@arkstack/queue';
+import { Queue } from '@arkstack/queue'
 
-Queue.serializeUsing((job) => ({
-  /* JobPayload */
-}));
-Queue.resolveJobsUsing((payload) => rebuildJob(payload));
+Queue.serializeUsing((job) => ({/* JobPayload */}))
+Queue.resolveJobsUsing((payload) => rebuildJob(payload))
 ```

package/dist/{QueueManager-Dm9FLISk.js → QueueManager--4wZ8gJz.js}

@@ -66,52 +66,52 @@ var Job = class {
 	}
 	/**
 	* The unique job id.
-	* 
-	* @returns 
+	*
+	* @returns
 	*/
 	id() {
 		return this.payload.id;
 	}
-	/** 
-	* The job's display name (used to resolve the job class). 
+	/**
+	* The job's display name (used to resolve the job class).
 	*/
 	name() {
 		return this.payload.displayName;
 	}
-	/** 
-	* How many times this job has been attempted (including the current run). 
+	/**
+	* How many times this job has been attempted (including the current run).
 	*/
 	attempts() {
 		return this.payload.attempts;
 	}
-	/** 
-	* The maximum number of attempts, or `null` for unlimited. 
+	/**
+	* The maximum number of attempts, or `null` for unlimited.
 	*/
 	maxTries() {
 		return this.payload.maxTries;
 	}
 	/**
-	* Seconds to wait before a released job becomes available again. 
+	* Seconds to wait before a released job becomes available again.
 	*/
 	backoff() {
 		return this.payload.backoff;
 	}
 	/**
-	* Acknowledge the job as done and remove it from the queue. 
+	* Acknowledge the job as done and remove it from the queue.
 	*/
 	async delete() {
 		this.deleted = true;
 		await this.handlers.delete();
 	}
 	/**
-	* Release the job back onto the queue, optionally after a delay. 
+	* Release the job back onto the queue, optionally after a delay.
 	*/
 	async release(delay = 0) {
 		this.released = true;
 		await this.handlers.release(delay);
 	}
 	/**
-	* Mark the job as having failed permanently. 
+	* Mark the job as having failed permanently.
 	*/
 	markAsFailed() {
 		this.failed = true;
@@ -246,10 +246,10 @@ var DatabaseQueue = class extends QueueContract {
 	/**
 	* Due, unreserved jobs on the given queue, oldest first. Released jobs become
 	* unreserved with a future `available_at`, so they naturally wait their turn.
-	* 
-	* @param db 
-	* @param queue 
-	* @returns 
+	*
+	* @param db
+	* @param queue
+	* @returns
 	*/
 	availableQuery(db, queue) {
 		return db.table(this.options.table).where({ queue }).whereNull("reserved_at").whereRaw("available_at <= " + now$1());
@@ -405,8 +405,8 @@ var SyncQueue = class extends QueueContract {
 	/**
 	* Run a job, invoking its `failed` hook and rethrowing on error so the
 	* caller (e.g. a dispatch) observes the failure synchronously.
-	* 
-	* @param job 
+	*
+	* @param job
 	*/
 	async execute(job) {
 		try {
@@ -542,9 +542,9 @@ var Queue = class {
 	static customDrivers = {};
 	/**
 	* Resolve a queue connection by name (or the default when omitted).
-	* 
-	* @param name 
-	* @returns 
+	*
+	* @param name
+	* @returns
 	*/
 	static connection(name) {
 		const key = name ?? configure("default", "sync");
@@ -553,9 +553,9 @@ var Queue = class {
 	}
 	/**
 	* Register a custom connection driver factory.
-	* 
-	* @param name 
-	* @returns 
+	*
+	* @param name
+	* @returns
 	*/
 	static extend(driver, factory) {
 		this.customDrivers[driver] = factory;
@@ -563,9 +563,9 @@ var Queue = class {
 	}
 	/**
 	* Register how jobs are reconstructed from a payload (used by workers).
-	* 
-	* @param name 
-	* @returns 
+	*
+	* @param name
+	* @returns
 	*/
 	static resolveJobsUsing(resolver) {
 		setResolver(resolver);
@@ -573,9 +573,9 @@ var Queue = class {
 	}
 	/**
 	* Register how job instances are serialized for storage.
-	* 
-	* @param serializer 
-	* @returns 
+	*
+	* @param serializer
+	* @returns
 	*/
 	static serializeUsing(serializer) {
 		setSerializer(serializer);
@@ -583,18 +583,18 @@ var Queue = class {
 	}
 	/**
 	* Clear memoized connections. Intended for tests or runtime reconfiguration.
-	* 
-	* @param serializer 
-	* @returns 
+	*
+	* @param serializer
+	* @returns
 	*/
 	static clearResolved() {
 		this.connections = {};
 	}
 	/**
 	* Create a worker bound to the given (or default) connection.
-	* 
-	* @param serializer 
-	* @returns 
+	*
+	* @param serializer
+	* @returns
 	*/
 	static worker(name) {
 		return new Worker(this.connection(name));

package/dist/commands/QueueClearCommand.js

@@ -1,4 +1,4 @@
-import { t as Queue } from "../QueueManager-Dm9FLISk.js";
+import { t as Queue } from "../QueueManager--4wZ8gJz.js";
 import { Command } from "@h3ravel/musket";
 import { bootArkorm } from "@arkstack/database";
 //#region src/commands/QueueClearCommand.ts

package/dist/commands/QueueWorkCommand.js

@@ -1,4 +1,4 @@
-import { r as Worker, t as Queue } from "../QueueManager-Dm9FLISk.js";
+import { r as Worker, t as Queue } from "../QueueManager--4wZ8gJz.js";
 import { Command } from "@h3ravel/musket";
 import { bootArkorm } from "@arkstack/database";
 //#region src/commands/QueueWorkCommand.ts

package/dist/index.js

@@ -1,2 +1,2 @@
-import { a as RedisQueue, c as Job, d as serializeJob, f as setResolver, i as SyncQueue, l as resetSerialization, n as configure, o as DatabaseQueue, p as setSerializer, r as Worker, s as QueueContract, t as Queue, u as resolveJob } from "./QueueManager-Dm9FLISk.js";
+import { a as RedisQueue, c as Job, d as serializeJob, f as setResolver, i as SyncQueue, l as resetSerialization, n as configure, o as DatabaseQueue, p as setSerializer, r as Worker, s as QueueContract, t as Queue, u as resolveJob } from "./QueueManager--4wZ8gJz.js";
 export { DatabaseQueue, Job, Queue, QueueContract, RedisQueue, SyncQueue, Worker, configure, resetSerialization, resolveJob, serializeJob, setResolver, setSerializer };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/queue",
-  "version": "0.19.1",
+  "version": "0.19.3",
   "type": "module",
   "description": "Queue module for Arkstack, providing a driver based queue transport and worker for background processing.",
   "homepage": "https://arkstack.toneflix.net/guide/queue",
@@ -34,13 +34,13 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@arkstack/common": "^0.19.1"
+    "@arkstack/common": "^0.19.3"
   },
   "peerDependencies": {
     "@h3ravel/musket": "^2.2.13",
     "ioredis": "^5.4.1",
-    "@arkstack/contract": "^0.19.1",
-    "@arkstack/database": "^0.19.1"
+    "@arkstack/contract": "^0.19.3",
+    "@arkstack/database": "^0.19.3"
   },
   "peerDependenciesMeta": {
     "@arkstack/database": {