Class Cron

A cron instance.

Hierarchy

Cron

Index

Constructors

Methods

createJob deleteAllJobs deleteJob getAllJobs getJob shutdown

Constructors

constructor

new Cron(): Cron
Returns Cron

Methods

createJob

createJob(name, job): Job
Create a new job.
Parameters
- name: string
  
  Unique job name.
- job: JobConfig
  
  Job configuration.
Returns Job
Job object.
- Defined in index.ts:220

deleteAllJobs

deleteAllJobs(): void
Delete all jobs.

Returns void
- Defined in index.ts:268

deleteJob

deleteJob(name): void
Delete a job by name.
Parameters
- name: string
  
  Job name.
Returns void
- Defined in index.ts:256

getAllJobs

getAllJobs(): Job[]
Get all jobs.

Returns Job[]
Array of all jobs.
- Defined in index.ts:248

getJob

getJob(name): undefined | Job
Get a job by name.
Parameters
- name: string
  
  Job name.
Returns undefined | Job
Job object.
- Defined in index.ts:240

shutdown

shutdown(): void
Shutdown the cron instance.

Returns void
- Defined in index.ts:278

Generated using TypeDoc