@wisemen/pgboss-nestjs-job 3.0.0 → 3.0.1

package/README.md

@@ -17,6 +17,9 @@ Make sure that the env variable `DATABASE_URI` is defined.
       fetchRefreshThreshold, // Refresh threshold to fetch jobs
       pollInterval, // The interval (in milliseconds) to poll for new jobs
       bouncerModule  // An optional bouncer which will prevent jobs from being fetched
+      databaseOptions: {
+        // ...
+      }
     })
   ]
 })
@@ -35,7 +38,7 @@ const _worker = new Worker()
 
 ```ts
 export interface MyJobData extends BaseJobData {
-  uuid: string
+  uuid: string;
   // other data here
 }
 ```
@@ -43,7 +46,7 @@ export interface MyJobData extends BaseJobData {
 3. Create a job definition
 
 ```ts
-@PgBossJob('queue-name')
+@PgBossJob("queue-name")
 export class MyJob extends BaseJob<MyJobData> {}
 ```
 
@@ -53,14 +56,14 @@ export class MyJob extends BaseJob<MyJobData> {}
 @Injectable()
 @PgBossJobHandler(MyJob)
 export class MyJobHandler extends JobHandler<MyJob> {
-  public async run (data: MyJobData): Promise<void> {
+  public async run(data: MyJobData): Promise<void> {
     // Do stuff
   }
 }
 ```
 
-
 ## QueueBouncer
+
 Some workers / queues only need to run when some external service is online. The `QueueBouncer` base class is used by workers to determine wether they should poll for jobs or not by calling the `canProceed` method on the bouncer. This method typically performs the health check on an external service.
 
 The queuebouncer is provided to the worker by creating and exportin a provider for the `QueueBouncer` class. An example module can be:
@@ -81,43 +84,41 @@ export class CuoptWorkerBouncerModule {}
 When no bouncer is set, the package will default to `AllowBouncer` which never blocks a worker / queue from polling for jobs.
 
 An example of a bouncer for an external cuopt system.
+
 ```typescript
 @Injectable()
 export class CuoptWorkerBouncer extends QueueBouncer {
-  private isCuoptRunning: boolean
-  private lastPolledAt: Date
-  private pollPromise: Promise<boolean> | undefined
-
-  constructor (
-    private cuopt: CuoptClient
-  ) {
-    super()
+  private isCuoptRunning: boolean;
+  private lastPolledAt: Date;
+  private pollPromise: Promise<boolean> | undefined;
+
+  constructor(private cuopt: CuoptClient) {
+    super();
   }
 
-  async canProceed (): Promise<boolean> {
-    if (dayjs().diff(this.lastPolledAt, 'seconds') > 2) {
-      await this.pollCuopt()
+  async canProceed(): Promise<boolean> {
+    if (dayjs().diff(this.lastPolledAt, "seconds") > 2) {
+      await this.pollCuopt();
     }
 
-    return this.isCuoptRunning
+    return this.isCuoptRunning;
   }
 
-  private async pollCuopt () {
+  private async pollCuopt() {
     if (this.pollPromise !== undefined) {
-      await this.pollPromise
-      return
+      await this.pollPromise;
+      return;
     }
 
-    this.pollPromise = this.cuopt.isReady()
+    this.pollPromise = this.cuopt.isReady();
 
     try {
-      this.isCuoptRunning = await this.pollPromise
+      this.isCuoptRunning = await this.pollPromise;
     } catch {
-      this.isCuoptRunning = false
+      this.isCuoptRunning = false;
     } finally {
-      this.lastPolledAt = new Date()
+      this.lastPolledAt = new Date();
     }
   }
 }
-
-```
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wisemen/pgboss-nestjs-job",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "type": "module",