# nestjs-agenda-module
> Agenda module for NestJs
Latest version **2.0.0** (published 2023-07-31) · ISC license · 0 weekly downloads
## Install
```sh
npm install nestjs-agenda-module
pnpm add nestjs-agenda-module
yarn add nestjs-agenda-module
bun add nestjs-agenda-module
```
## Health
**Score 20/100 (F)** — status: abandoned.
Positive: has types; no vulnerabilities.
Warnings: low downloads; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 2.0.0 |
| Published | 2023-07-31 |
| First published | 2023-01-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 185.1 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | nikyoff |
| Maintainers | nikyoff |
| Keywords | nestjs, agenda |
## Links
- npm: https://www.npmjs.com/package/nestjs-agenda-module
- Repository: https://github.com/NikyOFF/nestjs-agenda
- Homepage: https://github.com/NikyOFF/nestjs-agenda#readme
- Issues: https://github.com/NikyOFF/nestjs-agenda/issues
- npm.io page: https://npm.io/package/nestjs-agenda-module
## Dependencies (3)
- [agenda](https://npm.io/package/agenda.md) ^5.0.0
- [@nestjs/core](https://npm.io/package/@nestjs/core.md) ^10.1.3
- [@nestjs/common](https://npm.io/package/@nestjs/common.md) ^10.1.3
## Alternatives
- [cron](https://npm.io/package/cron.md) — 4.9M weekly downloads
- [@vercel/queue](https://npm.io/package/@vercel/queue.md) — 731.6K weekly downloads
- [create-sonicjs](https://npm.io/package/create-sonicjs.md) — 1.6K weekly downloads
- [@exellix/jobs-api](https://npm.io/package/@exellix/jobs-api.md) — 941 weekly downloads
- [@forwardimpact/libskill](https://npm.io/package/@forwardimpact/libskill.md) — 575 weekly downloads
## Recent versions
- 2.0.0 (latest) — 2023-07-31
- 1.1.2 — 2023-01-14
- 1.1.1 — 2023-01-14
- 1.1.0 — 2023-01-14
## README
[travis-image]: https://api.travis-ci.org/nestjs/nest.svg?branch=master
[travis-url]: https://travis-ci.org/nestjs/nest
[linux-image]: https://img.shields.io/travis/nestjs/nest/master.svg?label=linux
[linux-url]: https://travis-ci.org/nestjs/nest
A progressive Node.js framework for building efficient and scalable server-side applications.
## Description
[Agenda](https://www.npmjs.com/package/agenda) module for [Nest](https://github.com/nestjs/nest).
## Installation
```bash
$ npm i --save nestjs-agenda-module agenda
```
Once the installation process is complete, we can import the AgendaModule into the root AppModule.
```ts
//app.module.ts
import { Module } from '@nestjs/common';
import { AgendaModule } from 'nestjs-agenda-module';
@Module({
imports: [
AgendaModule.forRoot({
db: { address: 'MONGO_CONNECTION_URI' },
}),
],
})
export class AppModule {}
```
## Defining processors
Before you can use a job, you must define its processing behavior.
For do this you need create `processors-definer`
```ts
//example.processors-definer.ts
import { ProcessorsDefiner } from 'nestjs-agenda-module';
@ProcessorsDefiner()
export class ExampleProcessorsDefiner {}
```
And then you can define `processor` with special decorator
**@Processor(jobName, [options])**
```ts
//example.processors-definer.ts
import { ProcessorsDefiner, Processor } from 'nestjs-agenda-module';
@ProcessorsDefiner()
export class ExampleProcessorsDefiner {
@Processor("EXAMPLE_JOB")
public async exampleJob() {}
}
```
Also you can get access to current `job` data or `done` function with `job context`
```ts
//example.processors-definer.ts
import { Job } from 'agenda';
import {
ProcessorsDefiner,
Processor,
Context,
JobContext
} from 'nestjs-agenda-module';
interface ExampleJobData {
message: string;
}
@ProcessorsDefiner()
export class ExampleProcessorsDefiner {
@Processor('EXAMPLE_JOB')
public async exampleJob(
@Context() context: JobContext,
) {
const job: Job = context.job;
const done: Function = context.done;
console.log(job.attrs.data.message);
done();
}
}
```
## Provide processors definer
```ts
//app.module.ts
import { Module } from '@nestjs/common';
import { AgendaModule } from 'nestjs-agenda-module';
import { ExampleProcessorsDefiner } from './example.processors-definer.ts';
@Module({
imports: [
AgendaModule.forRoot({
db: { address: 'MONGO_CONNECTION_URI' },
}),
],
providers: [ExampleProcessorsDefiner],
})
export class AppModule {}
```
## Create job
### default way
```ts
//example.service.ts
import { Inject, Injectable } from '@nestjs/common';
import { Agenda } from 'agenda';
import { InjectAgenda } from 'nestjs-agenda-module';
@Injectable()
export class ExampleService {
public constructor(
@InjectAgenda()
private readonly agenda: Agenda,
) {}
public async createJob(): Promise {
this.agenda.every('15 minutes', 'EXAMPLE_JOB', { message: 'text' }, { skipImmediate: true });
this.agenda.schedule('1 day', 'EXAMPLE_JOB', { message: 'text' });
this.agenda.now('EXAMPLE_JOB', { message: 'text' });
//etc
}
}
```
### special create decorators
You have `every` `schedule` and `now` decorators who provided default agenda behavior for create job. You can provide default data or job options like in default agenda. Just read [documentation](https://www.npmjs.com/package/agenda#creating-jobs)
```ts
//example.processors-definer.ts
import {
ProcessorsDefiner,
Processor,
Context,
JobContext,
Now,
Schedule,
Every,
} from 'nestjs-agenda-module';
@ProcessorsDefiner()
export class ExampleProcessorsDefiner {
@Processor('EXAMPLE_JOB_1')
@Every('15 minutes', { skipImmediate: true }, { message: 'test' })
public async exampleJob1(@Context() context: JobContext) {
done();
}
@Processor('EXAMPLE_JOB_2')
@Schedule('tomorrow at noon', { message: 'test' })
public async exampleJob2(@Context() context: JobContext) {
done();
}
@Processor('EXAMPLE_JOB_3')
@Now({ message: 'test' })
public async exampleJob3(@Context() context: JobContext) {
done();
}
}
```
---
_Source: https://npm.io/package/nestjs-agenda-module · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._