Interface Pipe<Context>

A pipe that runs a series of steps in order.

interface Pipe<Context> {
    steps: readonly Step<Context>[];
    add(...stepsAoAdd: Step<Context>[]): this;
    run(ctx: Context): Promise<Context>;
}

Type Parameters

Context
The context type.

Index

Properties

Methods

Properties

`Readonly`steps

steps: readonly Step<Context>[]

The steps in the pipe.

Methods

add

add(...stepsAoAdd): this
Adds one or more steps to the pipe.
Parameters
- Rest...stepsAoAdd: Step<Context>[]
  The steps to add.
Returns this
- Defined in src/pipeline.ts:19

run

run(ctx): Promise<Context>
Executes the pipe.
Parameters
- ctx: Context
  The context.
Returns Promise<Context>
- Defined in src/pipeline.ts:25