@reactor/jobs — jobsclient
@reactor/jobs / JobsClient
Class: JobsClient
Section titled “Class: JobsClient”Defined in: index.ts:58
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new JobsClient(
ctx):JobsClient
Defined in: index.ts:59
Parameters
Section titled “Parameters”RequestContext
Returns
Section titled “Returns”JobsClient
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get dlq():
object
Defined in: index.ts:126
Dead letter queue management
Returns
Section titled “Returns”object
list: (
options?) =>Promise<Result<DlqEntry[]>>
Parameters
Section titled “Parameters”options?
Section titled “options?”limit?
Section titled “limit?”number
offset?
Section titled “offset?”number
Returns
Section titled “Returns”Promise<Result<DlqEntry[]>>
remove
Section titled “remove”remove: (
entryId) =>Promise<Result<void>>
Parameters
Section titled “Parameters”entryId
Section titled “entryId”string
Returns
Section titled “Returns”Promise<Result<void>>
retry: (
entryId) =>Promise<Result<{runId:string; }>>
Parameters
Section titled “Parameters”entryId
Section titled “entryId”string
Returns
Section titled “Returns”Promise<Result<{ runId: string; }>>
Get Signature
Section titled “Get Signature”get runs():
object
Defined in: index.ts:79
Job runs management
Returns
Section titled “Returns”object
cancel
Section titled “cancel”cancel: (
runId) =>Promise<Result<void>>
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Result<void>>
get: (
runId) =>Promise<Result<JobRun>>
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Result<JobRun>>
list: (
options?) =>Promise<Result<JobRun[]>>
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<Result<JobRun[]>>
wait: (
runId,options?) =>Promise<Result<JobRun>>
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Result<JobRun>>
triggers
Section titled “triggers”Get Signature
Section titled “Get Signature”get triggers():
object
Defined in: index.ts:144
Trigger management (admin)
Returns
Section titled “Returns”object
create
Section titled “create”create: (
jobName,config) =>Promise<Result<JobTrigger>>
Parameters
Section titled “Parameters”jobName
Section titled “jobName”string
config
Section titled “config”string
webhook?
Section titled “webhook?”boolean
Returns
Section titled “Returns”Promise<Result<JobTrigger>>
delete
Section titled “delete”delete: (
triggerId) =>Promise<Result<void>>
Parameters
Section titled “Parameters”triggerId
Section titled “triggerId”string
Returns
Section titled “Returns”Promise<Result<void>>
list: (
jobName?) =>Promise<Result<JobTrigger[]>>
Parameters
Section titled “Parameters”jobName?
Section titled “jobName?”string
Returns
Section titled “Returns”Promise<Result<JobTrigger[]>>
Methods
Section titled “Methods”trigger()
Section titled “trigger()”trigger(
name,options?):Promise<Result<{runId:string; }>>
Defined in: index.ts:64
Trigger a job run.
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Result<{ runId: string; }>>