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.

Hierarchy

  • BatchClusterEvents

Properties

beforeEnd: (() => void)

Type declaration

    • (): void
    • Emitted when this instance is in the process of ending.

      Returns void

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

Type declaration

childStart: ((childProcess: BatchProcess) => void)

Type declaration

    • (childProcess: BatchProcess): void
    • Emitted when a child process has started

      Parameters

      Returns void

end: (() => void)

Type declaration

    • (): void
    • Emitted when this instance has ended. No child processes should remain at this point.

      Returns void

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

Type declaration

    • (error: Error, proc?: BatchProcess): void
    • Emitted when a child process has an error during shutdown

      Parameters

      Returns void

fatalError: ((error: Error) => void)

Type declaration

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

Type declaration

    • (error: Error, proc: BatchProcess): void
    • Emitted when a process fails health checks

      Parameters

      Returns void

internalError: ((error: Error) => void)

Type declaration

    • (error: Error): void
    • Emitted when an internal consistency check fails

      Parameters

      • error: Error

      Returns void

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

Type declaration

    • (stdoutData: null | string | Buffer, stderrData: null | string | Buffer, proc: BatchProcess): void
    • Emitted when child processes write to stdout or stderr without a current task

      Parameters

      • stdoutData: null | string | Buffer
      • stderrData: null | string | Buffer
      • proc: BatchProcess

      Returns void

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

Type declaration

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

Type declaration

    • (data: string | Buffer, task: undefined | Task<any>, proc: BatchProcess): void
    • Emitted when tasks receive data, which may be partial chunks from the task stream.

      Parameters

      Returns void

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

Type declaration

    • (error: Error, task: Task<any>, proc: BatchProcess): void
    • Emitted when a task has an error

      Parameters

      Returns void

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

Type declaration

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

Type declaration

    • (timeoutMs: number, task: Task<any>, proc: BatchProcess): void
    • Emitted when a task times out. Note that a taskError event always succeeds these events.

      Parameters

      Returns void

Generated using TypeDoc