tryError Documentation

Class: MiddlewarePipeline\<T, E\>
Class

Defined in: [middleware.ts:46](https://github.com/oconnorjohnson/try-error/blob/e3ae0308069a4fba073f4543d527ad76373db795/src/middleware.ts#L46) Middleware pipeline for composing multiple middleware

tryError API Documentation v0.0.1-alpha.1


tryError API Documentation / MiddlewarePipeline

Class: MiddlewarePipeline<T, E>

Defined in: middleware.ts:46

Middleware pipeline for composing multiple middleware

Type Parameters

T

T = any

E

E extends TryError = TryError

Constructors

Constructor

new MiddlewarePipeline<T, E>(): MiddlewarePipeline<T, E>;

Returns

MiddlewarePipeline<T, E>

Accessors

length

Get Signature

get length(): number;

Defined in: middleware.ts:102

Get the number of middleware in the pipeline

Returns

number

Methods

clone()

clone(): MiddlewarePipeline<T, E>;

Defined in: middleware.ts:93

Clone the pipeline

Returns

MiddlewarePipeline<T, E>


execute()

execute(initialResult, finalHandler?): TryResult<T, E>;

Defined in: middleware.ts:60

Execute the middleware pipeline

Parameters

initialResult

TryResult<T, E>

finalHandler?

() => TryResult<T, E>

Returns

TryResult<T, E>


use()

use(middleware): this;

Defined in: middleware.ts:52

Add middleware to the pipeline

Parameters

middleware

ErrorMiddleware<T, E>

Returns

this


wrap()

wrap<Args>(fn): (...args) => TryResult<T, E>;

Defined in: middleware.ts:81

Create a wrapped function that applies the middleware pipeline

Type Parameters

Args

Args extends any[]

Parameters

fn

(...args) => TryResult<T, E>

Returns

(...args): TryResult<T, E>;
Parameters
args

...Args

Returns

TryResult<T, E>