batch-cluster
    Preparing search index...

    Interface BatchClusterEvents

    This interface describes the BatchCluster's event names as fields. The type of the field describes the event data payload.

    See BatchClusterEmitter for more details.

    interface BatchClusterEvents {
        beforeEnd: () => void;
        childEnd: (childProcess: BatchProcess, reason: ChildEndReason) => void;
        childStart: (childProcess: BatchProcess) => void;
        end: () => void;
        endError: (error: Error, proc?: BatchProcess) => void;
        healthCheckError: (error: Error, proc: BatchProcess) => void;
        internalError: (error: Error) => void;
        noTaskData: (
            stdoutData: string | Buffer<ArrayBufferLike> | null,
            stderrData: string | Buffer<ArrayBufferLike> | null,
            proc: BatchProcess,
        ) => void;
        startError: (error: Error, childProcess?: BatchProcess) => void;
        taskData: (
            data: string | Buffer<ArrayBufferLike>,
            task: Task<unknown> | undefined,
            proc: BatchProcess,
        ) => void;
        taskError: (error: Error, task: Task<unknown>, proc: BatchProcess) => void;
        taskResolved: (task: Task<unknown>, proc: BatchProcess) => void;
        taskTimeout: (
            timeoutMs: number,
            task: Task<unknown>,
            proc: BatchProcess,
        ) => void;
    }
    Index
    beforeEnd childEnd childStart end endError healthCheckError internalError noTaskData startError taskData taskError taskResolved taskTimeout
    beforeEnd: () => void

    Emitted when this instance is in the process of ending.

    childEnd: (childProcess: BatchProcess, reason: ChildEndReason) => void

    Emitted when a child process has ended, or when termination failed to make it exit (see endError). Check proc.exited to tell them apart.

    bc.on("childEnd", (proc, reason) => {
      // Check if this was an unexpected exit (crash, error, timeout)
      if (proc.unexpectedExit && proc.exitCode !== 0) {
        logger.error(`Process crashed: ${reason}`, {
          exitCode: proc.exitCode,
          exitSignal: proc.exitSignal
        });
      }
    });
    childStart: (childProcess: BatchProcess) => void

    Emitted when a child process has started

    end: () => void

    Emitted when this instance has ended. No child processes should remain at this point.

    endError: (error: Error, proc?: BatchProcess) => void

    Emitted when a child process has an error during shutdown, including when it is still running 5 seconds after termination.

    healthCheckError: (error: Error, proc: BatchProcess) => void

    Emitted when a process fails health checks

    internalError: (error: Error) => void

    Emitted when an internal consistency check fails

    noTaskData: (
        stdoutData: string | Buffer<ArrayBufferLike> | null,
        stderrData: string | Buffer<ArrayBufferLike> | null,
        proc: BatchProcess,
    ) => void

    Emitted when child processes write to stdout or stderr without a current task

    startError: (error: Error, childProcess?: BatchProcess) => void

    Emitted when a child process fails to spin up and run the BatchProcessOptions.versionCommand successfully within BatchClusterOptions.spawnTimeoutMillis.

    Type Declaration

    taskData: (
        data: string | Buffer<ArrayBufferLike>,
        task: Task<unknown> | undefined,
        proc: BatchProcess,
    ) => void

    Emitted when tasks receive data, which may be partial chunks from the task stream.

    taskError: (error: Error, task: Task<unknown>, proc: BatchProcess) => void

    Emitted when a task has an error

    taskResolved: (task: Task<unknown>, proc: BatchProcess) => void

    Emitted when a task has been resolved

    taskTimeout: (
        timeoutMs: number,
        task: Task<unknown>,
        proc: BatchProcess,
    ) => void

    Emitted when a task times out. Note that a taskError event always succeeds these events.

    By then the task has been rejected with a TaskTimeoutError and proc is ending, so proc.end() returns that same termination.

    Settings
    Member Visibility

    On This Page
    Properties