NestJS cron Module
More NestJS libs on alariblog.ru
NestJS cron package allows you easily setup cron for your controllers or services.
npm i nestjs-cron
To use cron, decorate your class with @Scheduled()
and method with @Cron()
.
Your class has to be a provider or a controller that is declared in any module.
; @@ @ async { //... }
'* * * * * *'
- is a standart cron notation. In this example it will be triggered every second.
Additionaly you can use options:
@
- launchOnInit - Launch job one time right after start.
- delay - Delay before start in ms if launchOnInit is true.
- sync - Wait for method to finish before launching next tick if your function takes more time then cron.
Cron Intercepter
To intercept cron you can use @CronIntercepter
decorator. You pass class that implements CronIntercepterClass
as a parameter. It has one intercept
method that returns Promise<boolean>
.
implements CronIntercepterClass async { return false; }
Usage example:
@@ @ @ { console; }
If intercept
method returns true
your cron will run as planned. If false method run will be skipped.