Class Job

Hierarchy

Job

Index

Constructors

Methods

destroy getNumIterations isStarted run shouldRun start stop

Constructors

constructor

new Job(parent, name, config): Job
Constructor.
Parameters
- parent: Cron
  
  Parent cron instance.
- name: string
  
  Job name.
- config: JobConfig
  
  Job configuration.
Returns Job
- Defined in index.ts:113

Methods

destroy

destroy(): void
Destroy the job.

This will stop the job if it is running and remove it from the parent cron instance.

Returns void
- Defined in index.ts:199

getNumIterations

getNumIterations(): number
Get the number of iterations this job has run.

Returns number
number of iterations.
- Defined in index.ts:155

isStarted

isStarted(): boolean
Returns boolean
- Defined in index.ts:137

run

run(): Promise<void>
Run the job.

Returns Promise<void>
- Defined in index.ts:162

shouldRun

shouldRun(d): boolean
Check if the job should run at the given time.
Parameters
- d: Date
  
  Date to check.
Returns boolean
true if the job should run, false otherwise.
- Defined in index.ts:147

start

start(): void
Start/restart the job.

Returns void
- Defined in index.ts:125

stop

stop(): void
Stop the job.

Returns void
- Defined in index.ts:132

Generated using TypeDoc