API reference / @node-ts/bus-core / MiddlewareDispatcher

Class: MiddlewareDispatcher<T>

Defined in: packages/bus-core/src/util/middleware.ts:19

A middleware container and invoker

Type Parameters

Type Parameter
T

Constructors

Constructor

new MiddlewareDispatcher<T>(finalMiddlewares?): MiddlewareDispatcher<T>;

Defined in: packages/bus-core/src/util/middleware.ts:22

Parameters

Parameter	Type	Default value
finalMiddlewares	Middleware<T>[]	[]

Returns

MiddlewareDispatcher<T>

Properties

Property	Modifier	Type	Default value	Defined in
finalMiddlewares	readonly	Middleware<T>[]	[]	packages/bus-core/src/util/middleware.ts:22
middlewares	public	Middleware<T>[]	[]	packages/bus-core/src/util/middleware.ts:20

Methods

dispatch()

dispatch(context): Promise<void>;

Defined in: packages/bus-core/src/util/middleware.ts:45

Execute the chain of middlewares, in the order they were added on a given Context.

Parameters

Parameter	Type
context	T

Returns

Promise<void>

---

use()

use(...middlewares): void;

Defined in: packages/bus-core/src/util/middleware.ts:27

Add a middleware function.

Parameters

Parameter	Type
...middlewares	Middleware<T>[]

Returns

void

---

useFinal()

useFinal(...middlewares): void;

Defined in: packages/bus-core/src/util/middleware.ts:37

Add 'final' middlewares that will be added to the end of the regular middlewares. This allows for finer control when exposing the

Parameters

Parameter	Type
...middlewares	Middleware<T>[]

Returns

void

See

use functionality to consumers but wanting to ensure that your final middleware is last to run