Nestjs-PULSE

The modern MongoDB-powered scheduling library for NestJS

Overview

Pulse module for NestJS, working with nestjs v9.x, v10.x and v11.x.

---

Getting Started

$3

``console
npm install --save @pulsecron/nestjs-pulse @pulsecron/pulse
`

#### Example

##### app.module.ts

`typescript
// src/app.module.ts

import { Module } from '@nestjs/common';
import { PulseModule } from '@pulsecron/nestjs-pulse';
import { NotificationsModule } from './notification/notification.module';

@Module({
imports: [
PulseModule.forRoot({
db: {
address: 'mongodb://localhost:27017/pulse',
},
}),
NotificationsModule,
],
providers: [],
})
export class AppModule {}

`

##### notification.module.ts

`typescript
// src/notification/notification.module.ts

import { Module } from '@nestjs/common';
import { PulseModule } from '@pulsecron/nestjs-pulse';
import { NotificationsQueue } from './notification.processor';

@Module({
imports: [
PulseModule.registerQueue('notifications', {
processEvery: '1 minutes',
autoStart: false, // default: true
}),
],
providers: [NotificationsQueue],
exports: [],
})
export class NotificationsModule {}

`

##### notification.processor.ts

`typescript
// src/notification/notification.processor.ts

import { Job } from '@pulsecron/pulse';
import { Every, Queue, Define, Schedule } from '@pulsecron/nestjs-pulse';

@Queue('notifications')
export class NotificationsQueue {
@Every({ name: 'send notifications', interval: '1 minutes' })
async sendNotifications(job: Job) {
console.log('Sending notifications[1]');
}

@Schedule({ name: 'send notifications', when: 'tomorrow at noon' })
async sendNotifications(job: Job) {
console.log('Sending notifications[2]');
}

@Now()
async sendNotifications(job: Job) {
console.log('Sending notifications[3]');
}

@Define({ name: 'emailJob' })
async test(job: Job) {
console.log('Sending email to:', job.data.to);
}
}

`

##### notification.service.ts

`typescript

import { Inject, Injectable } from '@nestjs/common';
import { Pulse } from '@pulsecron/pulse';

@Injectable()
export class NotificationService {
constructor(@Inject('notifications') private pulse: Pulse) {}

async scheduleEmail(email: string) {
const emailJob = this.pulse.create('emailJob', { to: email });
emailJob.unique(
{
'data.to': email,
},
{
insertOnly: true,
}
);
emailJob.schedule('5 seconds').save();
}
}


`

---





Development

$3

If you encounter an error when running npm ci in CI/CD that mentions missing platform-specific packages (e.g., @swc/core-linux-x64-gnu), this is a known npm issue where the package-lock.json was generated on a different platform than your CI environment.

The Problem:
- When package-lock.json is generated on macOS, it only includes macOS-specific optional dependencies
- When CI runs on Linux, those Linux packages are missing from the lock file
- npm ci fails because it requires exact synchronization between package.json and package-lock.json

The Solution:
Regenerate your package-lock.json on the same platform as your CI environment (Linux). You can do this using Docker:

`bash
docker run --rm -v "$(pwd):/workspace" -w /workspace node:lts npm install --package-lock-only
`

This will regenerate the lock file with all platform-specific optional dependencies included, making it compatible with both your local development environment and CI.

Alternative: If you have access to a Linux machine or VM, you can simply run npm install there and commit the updated package-lock.json.

---

Contributing

Contributions are welcome! Here are several ways you can contribute:

- Report Issues: Submit bugs found or log feature requests for the pulse project.
- Submit Pull Requests: Review open PRs, and submit your own PRs.
- Join the Discussions: Share your insights, provide feedback, or ask questions.

---

License

This project is protected under the MIT License. For more details, refer to the LICENSE file.

---