Interface PipelineStage<T>

A step in a pipeline. Data can be consumed in a pull-based or push-bashed fashion.

author: Thomas Minier

Type parameters

T

Hierarchy

PipelineStage

Implemented by

VectorStage

Index

Methods

Methods

forEach

forEach(cb: function): void

- Defined in src/engine/pipeline/pipeline-engine.ts:80
Invoke a callback on each item produced by the stage

Parameters
- cb: function
  
  Function invoked on each item produced by the stage
  - - (value: T): void
    - Parameters
      - value: T
      Returns void
Returns void

subscribe

subscribe(onData: function, onError: function, onEnd: function): void

- Defined in src/engine/pipeline/pipeline-engine.ts:74
Subscribes to the items emitted by the stage, in a push-based fashion

Parameters
- onData: function
  
  Function invoked on each item produced by the stage
  - - (value: T): void
    - Parameters
      - value: T
      Returns void
- onError: function
  
  Function invoked in cas of an error
  - - (err: any): void
    - Parameters
      - err: any
      Returns void
- onEnd: function
  
  Function invoked when the stage ends
  - - (): void
    - Returns void
Returns void

Generated using TypeDoc