Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BatchClusterEmitter

Hierarchy

Index

Properties

Methods

Properties

emitter

emitter: EventEmitter = new EventEmitter()

Methods

on

  • on(event: "startError", listener: function): void
  • on(event: "taskData", listener: function): void
  • on(event: "taskError", listener: function): void
  • on(event: "endError", listener: function): void
  • on(event: "beforeEnd", listener: function): void
  • on(event: "end", listener: function): void
  • Emitted when a child process has an error when spawning

    Parameters

    • event: "startError"
    • listener: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

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

    Parameters

    • event: "taskData"
    • listener: function
        • (data: Buffer | string, task: Task<any> | undefined): void
        • Parameters

          • data: Buffer | string
          • task: Task<any> | undefined

          Returns void

    Returns void

  • Emitted when a task has an error

    Parameters

    • event: "taskError"
    • listener: function
        • (err: Error, task: Task<any>): void
        • Parameters

          • err: Error
          • task: Task<any>

          Returns void

    Returns void

  • Emitted when a child process has an error during shutdown

    Parameters

    • event: "endError"
    • listener: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

  • Emitted when this instance is in the process of ending.

    Parameters

    • event: "beforeEnd"
    • listener: function
        • (): void
        • Returns void

    Returns void

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

    Parameters

    • event: "end"
    • listener: function
        • (): void
        • Returns void

    Returns void

Generated using TypeDoc