@litert/xxl-job-integration

Appearance

Documents for @litert/xxl-job-integration / JobRunner/Bean / XxlJobBeanHandlerRunner

Class: XxlJobBeanHandlerRunner ​

Defined in: src/lib/JobRunner/Bean.ts:52

The job runner that handles job execution using registered bean handlers.

Implements ​

Constructors ​

Constructor ​

new XxlJobBeanHandlerRunner(): XxlJobBeanHandlerRunner

Returns ​

XxlJobBeanHandlerRunner

Properties ​

type ​

readonly type: EJobType = cL.EJobType.BEAN

Defined in: src/lib/JobRunner/Bean.ts:54

The type of the jobs that this runner can handle.

Implementation of ​

IJobRunner.type

Methods ​

add() ​

add(opts): void

Defined in: src/lib/JobRunner/Bean.ts:69

Parameters ​

opts ​

IHandlerOptions

Returns ​

void

prepare() ​

prepare(args): IRunnerPrepareResult | null

Defined in: src/lib/JobRunner/Bean.ts:58

Prepare to run the task with the given arguments.

Parameters ​

args ​

IRunTaskArgs

Returns ​

IRunnerPrepareResult | null

null if the task cannot be prepared, or an object containing settings for the task.

Implementation of ​

IJobRunner.prepare

remove() ​

remove(name): void

Defined in: src/lib/JobRunner/Bean.ts:83

Parameters ​

name ​

string

Returns ​

void

run() ​

run(ctx): Promise<void>

Defined in: src/lib/JobRunner/Bean.ts:88

Run the task with the given context.

Parameters ​

ctx ​

IContext

The context of the task to run, which contains the task data and task information.

Returns ​

Promise<void>

Implementation of ​

IJobRunner.run