Home > @idealeap/pipeline > PipelineOptions
PipelineOptions interface
Options for configuring a pipeline.
Signature:
typescript
export interface PipelineOptionsexport interface PipelineOptionsProperties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| destroyProcess? | () => void | (Optional) An optional function to clean up resources when the pipeline is destroyed. | |
| emitter? | EventEmitter | (Optional) An optional custom event emitter to use for the pipeline. | |
| errProcess? | (error: any, context: PipelineContext) => MaybePromise<boolean> | (Optional) An optional function to handle errors that occur during the execution of the pipeline. | |
| globalParams? | Record<string, any> | (Optional) Optional global parameters to be used by all steps in the pipeline which will be inserted to pipe's context self_params | |
| onProgress? | (completed: number, total: number) => void | (Optional) An optional callback function that gets called during the pipeline's execution to report progress. |