Class CronTester

A utility class for testing scheduled cronjobs using @Cron(...) annotation.

Hierarchy

CronTester

Index

Constructors

Properties

initialized jobs

Methods

Constructors

constructor

new CronTester(): CronTester
Returns CronTester

Properties

`Static` `Private` initialized

initialized: boolean = false

`Static` `Private` jobs

jobs: {
crontab: string;
func: Function;
}[] = []

Type declaration

crontab: string
func: Function

Methods

`Static` init

init(): void
Initializes the CronTester by mocking the cron.schedule method.

Returns void
- Defined in src/jest/cron/cron-tester.ts:14

`Static` test

test(crontab): Promise<any>
Tests if a cron job with the specified crontab exists and executes the associated function.
Parameters
- crontab: string
  
  The crontab schedule string.
Returns Promise<any>
A promise that resolves with the value returned by the executed function.

Throws
If the CronTester has not been initialized.
- Defined in src/jest/cron/cron-tester.ts:27

Generated using TypeDoc