nestjs-agenda

This repo base on nestjs-agenda and wrap decorator agenda job defined
Agenda module for Nestjs

Agenda version is ^4.1.3

Installation

``
npm i @sigmaott/nestjs-agenda
`

Dependencies

Thank for @golevelup build the easy way to implement Dynamic Module and Discovery Module

Usage

1. Import AgendaModule:

_Sync register_:

`TypeScript
import { AgendaModule } from '@sigmaott/nestjs-agenda';

@Module({
imports: [AgendaModule.forRoot(AgendaModule, { db: { address: 'mongodb://xxxxx' }})], // Same as configuring an agenda
providers: [...],
})
export class FooModule {}
`

_Async register_:

`TypeScript
import { AgendaModule } from '@sigmaott/nestjs-agenda';

@Module({
imports: [
AgendaModule.forRootAsync(AgendaModule, {
imports: [ConfigModule],
useFactory: async (config: ConfigService) => ({
db: { address: config.get('MONGODB_URI') },
}),
inject: [ConfigService],
}),
],
providers: [...],
})
export class FooModule {}
`

2. Inject AgendaService (AgendaService is a instance of Agenda):

`TypeScript
import { Injectable } from '@nestjs/common';
import { AgendaService } from '@sigmaott/nestjs-agenda;

@Injectable()
export class FooService {
constructor(private readonly agenda: AgendaService) {
// schedule a job
this.agenda.schedule('10 seconds from now', 'TEST_JOB', {});
}

@AgendaHandler({
name: 'TEST_JOB',
lockLifetime: 10000
})
private async testJob(job: any, done: any): Promise {
console.log('a job');
await job.remove();
done();
}
}
``