job/scheduler

Documentation

• source: job/scheduler.ts

Overview

Classes

Scheduler

getJobs()

Retrieves all job definitions currently configured in the system.

static getJobs(): void;

Returns

• Type: void
• Description: An array of Job objects.

getJob()

Retrieves a specific job definition by its unique name.

static getJob(name: string): Job;

Parameter	Type	Description
name	string	The name of the job.

Returns

• Type: Job
• Description: A Job object corresponding to the provided name.

enable()

Enables a job, allowing it to be executed according to its schedule (cron expression).

static enable(name: string): void;

Parameter	Type	Description
name	string	The name of the job to enable.

Returns

• Type: void
• Description:

disable()

Disables a job, preventing it from executing on its schedule.

static disable(name: string): void;

Parameter	Type	Description
name	string	The name of the job to disable.

Returns

• Type: void
• Description:

trigger()

Triggers the immediate execution of a job.

static trigger(name: string, parameters: any): void;

Parameter	Type	Description
name	string	The name of the job to trigger.
parameters	any	Optional key-value object of parameters to pass to the job execution.

Returns

• Type: void
• Description:

log()

Logs a message at the standard log level for a specific job instance. This is useful when the log context needs to be associated with a running job.

static log(name: string, message: string): void;

Parameter	Type	Description
name	string	The name of the job to associate the log with.
message	string	The log message content.

Returns

• Type: void
• Description:

error()

Logs an error message for a specific job instance.

static error(name: string, message: string): void;

Parameter	Type	Description
name	string	The name of the job.
message	string	The error message content.

Returns

• Type: void
• Description:

warn()

Logs a warning message for a specific job instance.

static warn(name: string, message: string): void;

Parameter	Type	Description
name	string	The name of the job.
message	string	The warning message content.

Returns

• Type: void
• Description:

info()

Logs an informational message for a specific job instance.

static info(name: string, message: string): void;

Parameter	Type	Description
name	string	The name of the job.
message	string	The information message content.

Returns

• Type: void
• Description: