Skip to content

Documents for @litert/xxl-job-integration / RegisterAgent / createRegisterAgent

Function: createRegisterAgent()

createRegisterAgent(appName, executorUrl, adminApiClient): IRegisterAgent

Defined in: src/lib/RegisterAgent.ts:254

Create a new register agent for the XXL-Job executor.

Parameters

appName

string

The name of the application, which must match the pattern /^[a-z][-0-9a-z]{0,63}$/i.

executorUrl

string

The URL of the executor, which should be accessible by the XXL-Job admin server.

adminApiClient

IAdminApiClient

The admin API client to communicate with the XXL-Job admin server.

Returns

IRegisterAgent

The created register agent.