Interface JobConfig

Job configuration spec.

Hierarchy

  • JobConfig

Properties

cron dontAutoRun? log? onError? onTick

Properties

cron

cron: string

Job schedule in the Linux crontab syntax.

Optional dontAutoRun

dontAutoRun?: boolean

If true, the job will not be started automatically.

Default

false

Optional log

log?: CronLogger

Logger object to use for logging.

Optional onError

onError?: ((err) => void)

Type declaration

    • (err): void

    • Function to execute when an error occurs.

      Parameters

      • err: Error

        Error object.

      Returns void

onTick

onTick: ((job) => Promise<void>)

Type declaration

    • (job): Promise<void>

    • Function to execute each iteration of this job.

      Parameters

      • job: Job

        Job object.

      Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc