Interface CronServiceInterface

Interface for a cron service.

interface CronServiceInterface {
    changeCron: (name: string, cron: string) => Promise<void>;
    cronJobs: CronJob[];
    disable: (name: string) => Promise<void>;
    enable: (name: string) => Promise<void>;
    init: (cronJobs: Newable<CronJob>[]) => Promise<void>;
    schedule: (cronJob: CronJob) => Promise<void>;
    update: (name: string, data: Partial) => Promise<void>;
}

Implemented by

Properties

changeCron cronJobs disable enable init schedule update

Properties

changeCron

changeCron: (name: string, cron: string) => Promise<void>

Changes the cron expression of the cron job with the given name.

ReadonlycronJobs

cronJobs: CronJob[]

The cron jobs that are registered.

disable

disable: (name: string) => Promise<void>

Disables the cron job with the given name.

enable

enable: (name: string) => Promise<void>

Enables the cron job with the given name.

init

init: (cronJobs: Newable<CronJob>[]) => Promise<void>

Initializes all cron jobs.

schedule

schedule: (cronJob: CronJob) => Promise<void>

Schedules the given cron job.

update

update: (name: string, data: Partial) => Promise<void>

Updates the cron job with the given name.

Settings

Member Visibility

On This Page

Properties