pg-boss 10.0.0-beta20 → 10.0.0-beta21

package/README.md

@@ -27,20 +27,21 @@ async function readme() {
 
 pg-boss is a job queue built in Node.js on top of PostgreSQL in order to provide background processing and reliable asynchronous execution to Node.js applications.
 
-pg-boss relies on [SKIP LOCKED](https://www.2ndquadrant.com/en/blog/what-is-select-skip-locked-for-in-postgresql-9-5/), a feature added to postgres specifically for message queues to resolve record locking challenges inherent with relational databases. This provides exactly-once delivery, and the safety of guaranteed atomic commits of a relational database to asynchronous job processing.
+pg-boss relies on [SKIP LOCKED](https://www.2ndquadrant.com/en/blog/what-is-select-skip-locked-for-in-postgresql-9-5/), a feature built specifically for message queues to resolve record locking challenges inherent with relational databases. This provides exactly-once delivery and the safety of guaranteed atomic commits to asynchronous job processing.
 
 This will likely cater the most to teams already familiar with the simplicity of relational database semantics and operations (SQL, querying, and backups). It will be especially useful to those already relying on PostgreSQL that want to limit how many systems are required to monitor and support in their architecture.
 
 
-## Features
+## Summary
 * Exactly-once job delivery
 * Backpressure-compatible polling workers
 * Cron scheduling
+* Queue storage policies to support a variety of rate limiting, debouncing, and concurrency use cases
+* Priority queues, dead letter queues, job deferral, automatic retries with exponential backoff
 * Pub/sub API for fan-out queue relationships
-* Priority queues, deferral, retries (with exponential backoff), rate limiting, debouncing
-* Table operations via SQL for bulk loads via COPY or INSERT
+* Raw SQL support for non-Node.js runtimes via INSERT or COPY
+* Serverless function compatible
 * Multi-master compatible (for example, in a Kubernetes ReplicaSet)
-* Dead letter queues
 
 ## Requirements
 * Node 20 or higher

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-boss",
-  "version": "10.0.0-beta20",
+  "version": "10.0.0-beta21",
   "description": "Queueing jobs in Postgres from Node.js like a boss",
   "main": "./src/index.js",
   "engines": {

package/src/index.js

@@ -149,7 +149,7 @@ class PgBoss extends EventEmitter {
       return
     }
 
-    let { destroy = false, graceful = true, timeout = 30000, wait = true } = options
+    let { close = true, graceful = true, timeout = 30000, wait = true } = options
 
     timeout = Math.max(timeout, 1000)
 
@@ -168,7 +168,7 @@ class PgBoss extends EventEmitter {
 
           await this.#manager.failWip()
 
-          if (this.#db.isOurs && this.#db.opened && destroy) {
+          if (this.#db.isOurs && this.#db.opened && close) {
             await this.#db.close()
           }
 

package/src/plans.js

@@ -400,7 +400,7 @@ function getQueues (schema) {
       dead_letter as "deadLetter",
       created_on as "createdOn",
       updated_on as "updatedOn"
-    FROM ${schema}.queue    
+    FROM ${schema}.queue
    `
 }
 

package/types.d.ts

@@ -242,7 +242,7 @@ declare namespace PgBoss {
   }
 
   interface StopOptions {
-    destroy?: boolean,
+    close?: boolean,
     graceful?: boolean,
     timeout?: number,
     wait?: boolean
@@ -343,15 +343,15 @@ declare class PgBoss extends EventEmitter {
   fail(name: string, id: string, data: object, options?: PgBoss.ConnectionOptions): Promise<void>;
   fail(name: string, ids: string[], options?: PgBoss.ConnectionOptions): Promise<void>;
 
-  getQueueSize(name: string, options?: object): Promise<number>;
   getJobById(name: string, id: string, options?: PgBoss.ConnectionOptions & { includeArchive: bool }): Promise<PgBoss.JobWithMetadata | null>;
-
+  
   createQueue(name: string, options?: PgBoss.Queue): Promise<void>;
-  getQueue(name: string): Promise<PgBoss.Queue | null>;
-  getQueues(): Promise<PgBoss.QueueResult[]>;
   updateQueue(name: string, options?: PgBoss.Queue): Promise<void>;
   deleteQueue(name: string): Promise<void>;
   purgeQueue(name: string): Promise<void>;
+  getQueues(): Promise<PgBoss.QueueResult[]>;
+  getQueue(name: string): Promise<PgBoss.QueueResult | null>;
+  getQueueSize(name: string, options?: { before: 'retry' | 'active' | 'completed' | 'cancelled' | 'failed' }): Promise<number>;
 
   clearStorage(): Promise<void>;
   archive(): Promise<void>;