Worker & executor signatures
The worker & executor signatures the Node.js SDK declares, straight from its own declarations.
The worker & executor signatures the Node.js SDK declares, straight from its own declarations.
Signatures, parameters, defaults and return types come straight from the declarations, so they cannot drift from the code. Prose, examples and gotchas live on the hand-written pages this section sits beside.
Generated from sdks/node/native/index.d.ts.
startExecutor()startExecutor(
callback: ((arg: JsTaskInvocation) => Promise<JsTaskOutcome>),
options: ExecutorOptions
): Promise<JsExecutor>executor.disabledMiddleware()executor.disabledMiddleware(jobId: string): Array<string>executor.executorIdexecutor.executorId: stringexecutor.isCancelRequested()executor.isCancelRequested(jobId: string): booleanexecutor.isRunning()executor.isRunning(): booleanexecutor.openStepSession()executor.openStepSession(
jobId: string,
attempt: number
): Promise<JsStepSession>executor.peerexecutor.peer: stringexecutor.reportProgress()executor.reportProgress(jobId: string, progress: number): voidexecutor.schedulerIdexecutor.schedulerId: stringexecutor.shutdown()executor.shutdown(): Promise<void>executor.stop()executor.stop(): voidexecutor.supportsSideChannel()executor.supportsSideChannel(): booleanexecutor.supportsSteps()executor.supportsSteps(): booleanexecutor.wait()executor.wait(): Promise<void>executor.writeTaskLog()executor.writeTaskLog(
jobId: string,
taskName: string,
level: string,
message: string,
extra?: string | undefined | null
): voidworker.eventSinkStats()worker.eventSinkStats(): Array<JsSinkStats>worker.idworker.id: stringworker.openStepSession()worker.openStepSession(
jobId: string,
attempt: number
): Promise<JsStepSession>worker.stop()worker.stop(): voidworker.waitEventDrain()worker.waitEventDrain(): Promise<void>