0.2.1 • Published 4 years ago
nest-task-module v0.2.1
Description
Task Module for NestJS using Cron
Installation
$ npm install nest-task-module
Import task module to AppModule
import { Module } from '@nestjs/common';
import { TaskModule } from 'nest-task-module';
import { TaskName } from './tasks';
@Module({
imports: [
TaskModule.register({
controller: true,
tasks: [ TaskName ],
}),
],
})
export class AppModule {}
API
TaskModule
register
controller
- enable controllertasks
- REQUIRED array of tasks implementingCronJobParameter
instanceble
- provider to determine the master instance
registerAsync
CronJobParameter
import { CronJobParameters } from 'cron';
interface CronJobParameter extends CronJobParameters {
name: string;
}
Task
class Task extends CronJob {
public name: string;
get isRunning(): boolean;
get cronSourceTime(): string;
get cronTimeZone(): string;
get nextRunDate(): Date;
get lastRunDate(): Date;
constructor(task: CronJobParameter);
}