Class PipeBuilder<Input, Output>

A utility class for fluently composing a pipeline of functions, where each function receives the output of the previous function as its input. Call .then() to add steps, and .build() to generate the composed pipeline function.

Type Parameters

Input
The type of the pipeline's initial input value.
Output
The type of the pipeline's final output value.

Index

Constructors

Methods

Constructors

constructor

new PipeBuilder<Input, Output>(
fns?: PipeFunc<any, any>[],
): PipeBuilder<Input, Output>
Constructs a PipeBuilder with an initial list of functions.
Type Parameters
- Input
- Output
Parameters
- fns: PipeFunc<any, any>[] = []
  The list of pipe functions to be composed.
Returns PipeBuilder<Input, Output>
- Defined in pipe/pipeBuilder.ts:16

Methods

build

build(): PipeFunc<Input, Output>
Builds the composed pipeline function. When invoked, the returned function will pass its input through all steps in order.

Returns PipeFunc<Input, Output>
The composed function that applies all pipeline steps in sequence.
- Defined in pipe/pipeBuilder.ts:33

then

then<NextOutput>(
fn: PipeFunc<Output, NextOutput>,
): PipeBuilder<Input, NextOutput>
Adds another step to the function pipeline.
Type Parameters
- NextOutput
  The type of the output of the new function.
Parameters
- fn: PipeFunc<Output, NextOutput>
  The next function to apply to the pipeline output.
Returns PipeBuilder<Input, NextOutput>
A new PipeBuilder with the added function.
- Defined in pipe/pipeBuilder.ts:24