Class Composer<T, R>

A simple middleware compose builder

Type Parameters

T extends UnknownObject
R = T

Index

Constructors

Properties

Accessors

Methods

after before branch caught clone compose concurrency enforce filter fork lazy optional tap use builder

Constructors

constructor

new Composer<T, R>(): Composer<T, R>
Type Parameters
- T extends UnknownObject
- R = T
Returns Composer<T, R>

Properties

`Protected` middlewares

middlewares: Middleware<R>[]

Accessors

length

get length(): number
The number of middleware installed in Composer

Returns number
- Defined in node_modules/middleware-io/lib/composer.d.ts:14

Methods

after

after<V>(middleware, afterMiddleware): Composer<T & V, R>
Runs the second middleware after the main
Type Parameters
- V = UnknownObject
Parameters
- middleware: Middleware<T & V>
- afterMiddleware: Middleware<T & V>
Returns Composer<T & V, R>
- Defined in node_modules/middleware-io/lib/composer.d.ts:54

before

before<V>(beforeMiddleware, middleware): Composer<T & V, R>
Runs the second middleware before the main
Type Parameters
- V = UnknownObject
Parameters
- beforeMiddleware: Middleware<T & V>
- middleware: Middleware<T & V>
Returns Composer<T & V, R>
- Defined in node_modules/middleware-io/lib/composer.d.ts:50

branch

branch<V>(condition, trueMiddleware, falseMiddleware): Composer<T & V, R>
By condition splits the middleware
Type Parameters
- V = UnknownObject
Parameters
- condition: BranchMiddlewareCondition<T & V>
- trueMiddleware: Middleware<T & V>
- falseMiddleware: Middleware<T & V>
Returns Composer<T & V, R>
- Defined in node_modules/middleware-io/lib/composer.d.ts:38

caught

caught<V>(errorHandler): Composer<T & V, R>
Catches errors in the middleware chain
Type Parameters
- V = UnknownObject
Parameters
- errorHandler: CaughtMiddlewareHandler<T & V>
Returns Composer<T & V, R>
- Defined in node_modules/middleware-io/lib/composer.d.ts:62

clone

clone(): Composer<T, R>
Clones a composer object

Returns Composer<T, R>
- Defined in node_modules/middleware-io/lib/composer.d.ts:18

compose

compose(): Middleware<R>
Compose middleware handlers into a single handler

Returns Middleware<R>
- Defined in node_modules/middleware-io/lib/composer.d.ts:71

concurrency

concurrency<V>(middlewares): Composer<T & V, R>
Concurrently launches middleware, the chain will continue if next() is called in all middlewares
Type Parameters
- V = UnknownObject
Parameters
- middlewares: Middleware<T & V>[]
Returns Composer<T & V, R>
- Defined in node_modules/middleware-io/lib/composer.d.ts:67

enforce

enforce<V>(beforeMiddleware, middleware, afterMiddleware): Composer<T & V, R>
Runs middleware before and after the main
Type Parameters
- V = UnknownObject
Parameters
- beforeMiddleware: Middleware<T & V>
- middleware: Middleware<T & V>
- afterMiddleware: Middleware<T & V>
Returns Composer<T & V, R>
- Defined in node_modules/middleware-io/lib/composer.d.ts:58

filter

filter<V>(condition, filterMiddleware): Composer<T & V, R>
Conditionally runs middleware or stops the chain
Type Parameters
- V = UnknownObject
Parameters
- condition: BranchMiddlewareCondition<T & V>
- filterMiddleware: Middleware<T & V>
Returns Composer<T & V, R>
- Defined in node_modules/middleware-io/lib/composer.d.ts:46

fork

fork<V>(middleware): Composer<T & V, R>
Runs the middleware at the next event loop and force call next()
Type Parameters
- V = UnknownObject
Parameters
- middleware: Middleware<T & V>
Returns Composer<T & V, R>
- Defined in node_modules/middleware-io/lib/composer.d.ts:34

lazy

lazy<V>(factory): Composer<T & V, R>
Lazily asynchronously gets middleware
Type Parameters
- V = UnknownObject
Parameters
- factory: LazyMiddlewareFactory<T & V>
Returns Composer<T & V, R>
- Defined in node_modules/middleware-io/lib/composer.d.ts:26

optional

optional<V>(condition, optionalMiddleware): Composer<T & V, R>
Conditionally runs optional middleware or skips middleware
Type Parameters
- V = UnknownObject
Parameters
- condition: BranchMiddlewareCondition<T & V>
- optionalMiddleware: Middleware<T & V>
Returns Composer<T & V, R>
- Defined in node_modules/middleware-io/lib/composer.d.ts:42

tap

tap<V>(middleware): Composer<T & V, R>
Runs the middleware and force call next()
Type Parameters
- V = UnknownObject
Parameters
- middleware: Middleware<T & V>
Returns Composer<T & V, R>
- Defined in node_modules/middleware-io/lib/composer.d.ts:30

use

use<V>(middleware): Composer<T & V, R>
Adds middleware to the chain
Type Parameters
- V = UnknownObject
Parameters
- middleware: Middleware<T & V>
Returns Composer<T & V, R>
- Defined in node_modules/middleware-io/lib/composer.d.ts:22

`Static` builder

builder<Context>(): Composer<Context, Context>
Invokes a new instance of the Composer class
Type Parameters
- Context extends UnknownObject
Returns Composer<Context, Context>
- Defined in node_modules/middleware-io/lib/composer.d.ts:10

Generated using TypeDoc