nestjs-agenda

Agenda module for Nestjs

Agenda version is ^3.1.0

Installation

``
npm install nestjs-agenda
`

Usage

1. Import AgendaModule:

Sync register:
`TypeScript
import { AgendaModule } from 'nestjs-agenda';

@Module({
imports: [AgendaModule.register({ db: { address: 'mongodb://xxxxx' }})], // Same as configuring an agenda
providers: [...],
})
export class FooModule {}
`
Async register:
`TypeScript
import { AgendaModule } from 'nestjs-agenda';

@Module({
imports: [
AgendaModule.registerAsync({
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 'nestjs-agenda';

@Injectable()
export class FooService {
constructor(private readonly agenda: AgendaService) {
// define a job, more details: Agenda documentation
this.agenda.define('TEST_JOB', { lockLifetime: 10000 }, this.testJob.bind(this));
// schedule a job
this.agenda.schedule('10 seconds from now', 'TEST_JOB', {});
}

private async testJob(job: any, done: any): Promise {
console.log('a job');
await job.remove();
done();
}
}
``