Class CronService`Abstract`

Hierarchy (View Summary)

CronService
- AppService
- DdnsService

Implements

OnModuleDestroy

Index

Constructors

Properties

loggerService stateCron

Accessors

ExecutionFrequencySeconds ServiceName

Methods

job onModuleDestroy start stop

Constructors

constructor

new CronService(loggerService: ConsoleLoggerService): CronService
Parameters
- loggerService: ConsoleLoggerService
Returns CronService
- Defined in src/cron/cron.service.ts:19

Properties

`Protected`loggerService

loggerService: ConsoleLoggerService

`Protected`stateCron

stateCron: State = State.Stopped

Accessors

`Abstract`ExecutionFrequencySeconds

get ExecutionFrequencySeconds(): number
Returns how frequently the job will be executed in seconds

Returns number
- Defined in src/cron/cron.service.ts:26

`Abstract`ServiceName

get ServiceName(): string
The service name which will appear in log messages

Returns string
- Defined in src/cron/cron.service.ts:31

Methods

`Abstract`job

job(): Promise<void>
The job which will be executed by the cron job. Must be implemented by the derived class

Returns Promise<void>
- Defined in src/cron/cron.service.ts:37

onModuleDestroy

onModuleDestroy(): void
Lifecycle event hook for NestJs: https://docs.nestjs.com/fundamentals/lifecycle-events

Stops the cron job service if the application is shutting down.

Returns void
Implementation of OnModuleDestroy.onModuleDestroy
- Defined in src/cron/cron.service.ts:84

start

start(): Promise<void>
Starts the CRON Job executing. Will execute "synchronise" immediately on invocation and then every x seconds as distated by the environment variable EXECUTION_FREQUENCY_SECONDS.

Returns Promise<void>
Throws
If service is already started
- Defined in src/cron/cron.service.ts:45

stop

stop(): void
Stops the CronJob executing.

Returns void
Throws
if CRON job is not running.
- Defined in src/cron/cron.service.ts:68