ESM + Typescript

.gitignore

@@ -3,4 +3,6 @@ node_modules
 .vscode
 *.tgz
 *.log
-coverage
+coverage
+
+dist

README.md

@@ -6,7 +6,7 @@ Queueing jobs in Postgres from Node.js like a boss.
 
 ```js
 async function readme() {
-  const PgBoss = require('pg-boss');
+  const { PgBoss } = require('pg-boss');
   const boss = new PgBoss('postgres://user:pass@host/database');
 
   boss.on('error', console.error)
@@ -53,7 +53,7 @@ This will likely cater the most to teams already familiar with the simplicity of
 * Multi-master compatible (for example, in a Kubernetes ReplicaSet)
 
 ## Requirements
-* Node 22 or higher
+* Node 22.12 or higher for CommonJS's require(esm)
 * PostgreSQL 13 or higher
 
 ## Installation

docker-compose.yaml

@@ -10,6 +10,7 @@ services:
       - POSTGRES_NAME=pgboss
       - POSTGRES_USER=postgres
       - POSTGRES_PASSWORD=postgres
+    command: -c 'max_connections=400'
 
 volumes:
   db_volume:

docs/README.md

@@ -6,7 +6,7 @@ Queueing jobs in Postgres from Node.js like a boss.
 
 ```js
 async function readme() {
-  const PgBoss = require('pg-boss');
+  const { PgBoss } = require('pg-boss');
   const boss = new PgBoss('postgres://user:pass@host/database');
 
   boss.on('error', console.error)
@@ -53,7 +53,7 @@ This will likely cater the most to teams already familiar with the simplicity of
 * Multi-master compatible (for example, in a Kubernetes ReplicaSet)
 
 ## Requirements
-* Node 22 or higher
+* Node 22.12 or higher for CommonJS's require(esm)
 * PostgreSQL 13 or higher
 
 ## Installation

docs/install.md

@@ -6,7 +6,7 @@ pg-boss will automatically create a dedicated schema (`pgboss` is the default na
 GRANT CREATE ON DATABASE db1 TO leastprivuser;
 ```
 
-If the CREATE privilege is not available or desired, you can use the included [static functions](#static-functions) to export the SQL commands to manually create or upgrade the required database schema.  **This means you will also need to monitor future releases for schema changes** (the schema property in [version.json](../version.json)) so they can be applied manually.
+If the CREATE privilege is not available or desired, you can use the included [static functions](#static-functions) to export the SQL commands to manually create or upgrade the required database schema.  **This means you will also need to monitor future releases for schema changes**.
 
 NOTE: Using an existing schema is supported for advanced use cases **but discouraged**, as this opens up the possibility that creation will fail on an object name collision, and it will add more steps to the uninstallation process.
 

eslint.config.ts

@@ -0,0 +1,15 @@
+import neostandard from 'neostandard'
+import { defineConfig } from 'eslint/config'
+
+const config = neostandard({
+  ts: true,
+  env: ['mocha'],
+  ignores: neostandard.resolveIgnoresFromGitignore(),
+  noJsx: true,
+})
+
+export default defineConfig(config, {
+  languageOptions: {
+    ecmaVersion: 2025,
+  },
+})

examples/load/index.js → examples/load/index.ts

@@ -1,6 +1,6 @@
-const helper = require('../../test/testHelper')
-const { delay } = require('../../src/tools')
-const PgBoss = require('../../src')
+import { PgBoss } from '../../dist/index.mjs'
+import * as helper from '../../test/testHelper.js'
+import { delay } from '../../src/tools.ts'
 
 const SCHEMA_COUNT = 60
 const QUEUE_COUNT = 200
@@ -19,7 +19,7 @@ async function loadTest () {
   }
 }
 
-async function init (schema) {
+async function init (schema: string) {
   const config = helper.getConfig()
   const boss = new PgBoss({ ...config, schema, supervise: false, schedule: false })
 
@@ -34,7 +34,7 @@ async function init (schema) {
   for (const queue of queues) {
     console.log(`creating queue ${schema}.${queue}`)
     await boss.createQueue(queue)
-    await boss.work(queue, () => {})
+    await boss.work(queue, async () => {})
   }
 
   console.log('created queues')

examples/readme.js → examples/readme.cjs

@@ -1,8 +1,7 @@
-const helper = require('../test/testHelper')
+const { PgBoss } = require('../')
 
 async function readme () {
-  const PgBoss = require('../src')
-  const boss = new PgBoss(helper.getConnectionString())
+  const boss = new PgBoss('postgres://postgres:postgres@localhost/pgboss')
 
   boss.on('error', console.error)
 

examples/readme.mjs

@@ -0,0 +1,27 @@
+import { PgBoss } from '../dist/index.mjs'
+
+async function readme () {
+  const boss = new PgBoss('postgres://postgres:postgres@localhost/pgboss')
+
+  boss.on('error', console.error)
+
+  await boss.start()
+
+  const queue = 'readme-queue'
+
+  await boss.createQueue(queue)
+
+  const id = await boss.send(queue, { arg1: 'read me' })
+
+  console.log(`created job ${id} in queue ${queue}`)
+
+  await boss.work(queue, async ([job]) => {
+    console.log(`received job ${job.id} with data ${JSON.stringify(job.data)}`)
+  })
+}
+
+readme()
+  .catch(err => {
+    console.log(err)
+    process.exit(1)
+  })

examples/schedule.js

@@ -1,7 +1,7 @@
-const helper = require('../test/testHelper')
+import { PgBoss } from '../dist/index.mjs'
+import * as helper from '../test/testHelper.js'
 
 async function schedule () {
-  const PgBoss = require('../src')
   const boss = new PgBoss(helper.getConnectionString())
 
   boss.on('error', console.error)