Use pg-boss in your Nest.js app!
- Decorator-based job handling — Use
@Job()and@CronJob()decorators to define workers directly on your service methods - Cron scheduling — Schedule recurring jobs with cron expressions and timezone support
- Automatic queue creation — Queues are created automatically before any job operation
- Parallel processing — Configure
teamSizeandteamConcurrencyfor parallel job workers - Connection retry logic — Built-in retry with configurable
retryLimitandretryDelayfor resilient startup - Graceful shutdown — PgBoss is automatically stopped when the NestJS application shuts down
- Full pg-boss access — Access the underlying PgBoss instance directly for advanced use cases
npm install pg-boss @wavezync/nestjs-pgbossyarn add pg-boss @wavezync/nestjs-pgbosspnpm add pg-boss @wavezync/nestjs-pgbossTo begin using @wavezync/nestjs-pgboss, initialize the root module:
import { PGBossModule } from "@wavezync/nestjs-pgboss";
// app.module.ts
@Module({
imports: [
PgBossModule.forRootAsync({
imports: [ConfigModule],
useFactory: async (configService: ConfigService) => ({
connectionString: configService.get<string>('DATABASE_URL'),
}),
inject: [ConfigService],
}),
],
})
export class AppModule {}import { Injectable } from '@nestjs/common';
import { PgBossService } from '@wavezync/nestjs-pgboss';
@Injectable()
export class JobSchedulerService {
constructor(private readonly pgBossService: PgBossService) {}
async scheduleJob() {
await this.pgBossService.scheduleJob('my-job', { key: 'value' });
}
}You can access the PgBoss instance directly via pgBossService.boss
import { Injectable, Logger } from '@nestjs/common';
import { Job } from '@wavezync/nestjs-pgboss';
import { JobWithMetadata } from 'pg-boss';
interface MyJobData {
id: number;
name: string;
}
@Injectable()
export class MyJobHandler {
private readonly logger = new Logger(MyJobHandler.name);
@Job('my-job')
async handleMyJob(jobs: JobWithMetadata<MyJobData>[]) {
this.logger.log(`Processing ${jobs.length} job(s)`);
}
}import { Injectable, Logger } from '@nestjs/common';
import { PgBossService, CronJob } from '@wavezync/nestjs-pgboss';
@Injectable()
export class MyCronJobService {
private readonly logger = new Logger(MyCronJobService.name);
@CronJob('my-cron-job', '0 * * * *', { priority: 1 })
async handleCron() {
this.logger.log('Executing cron job: my-cron-job');
}
}# unit tests
$ npm run test
@wavezync/nestjs-pgboss is MIT licensed