middleware-io / Composer
A simple middleware compose builder
| Name | Type |
|---|---|
T |
extends UnknownObject |
R |
T |
- after
- before
- branch
- caught
- clone
- compose
- concurrency
- enforce
- filter
- fork
- lazy
- optional
- tap
- use
- builder
• new Composer<T, R>(): Composer<T, R>
| Name | Type |
|---|---|
T |
extends UnknownObject |
R |
T |
Composer<T, R>
• Protected middlewares: Middleware<R>[] = []
• get length(): number
The number of middleware installed in Composer
number
▸ after<V>(middleware, afterMiddleware): Composer<T & V, R>
Runs the second middleware after the main
| Name | Type |
|---|---|
V |
UnknownObject |
| Name | Type |
|---|---|
middleware |
Middleware<T & V> |
afterMiddleware |
Middleware<T & V> |
Composer<T & V, R>
▸ before<V>(beforeMiddleware, middleware): Composer<T & V, R>
Runs the second middleware before the main
| Name | Type |
|---|---|
V |
UnknownObject |
| Name | Type |
|---|---|
beforeMiddleware |
Middleware<T & V> |
middleware |
Middleware<T & V> |
Composer<T & V, R>
▸ branch<V>(condition, trueMiddleware, falseMiddleware): Composer<T & V, R>
By condition splits the middleware
| Name | Type |
|---|---|
V |
UnknownObject |
| Name | Type |
|---|---|
condition |
BranchMiddlewareCondition<T & V> |
trueMiddleware |
Middleware<T & V> |
falseMiddleware |
Middleware<T & V> |
Composer<T & V, R>
▸ caught<V>(errorHandler): Composer<T & V, R>
Catches errors in the middleware chain
| Name | Type |
|---|---|
V |
UnknownObject |
| Name | Type |
|---|---|
errorHandler |
CaughtMiddlewareHandler<T & V> |
Composer<T & V, R>
▸ clone(): Composer<T, R>
Clones a composer object
Composer<T, R>
▸ compose(): Middleware<R>
Compose middleware handlers into a single handler
Middleware<R>
▸ concurrency<V>(middlewares): Composer<T & V, R>
Concurrently launches middleware,
the chain will continue if next() is called in all middlewares
| Name | Type |
|---|---|
V |
UnknownObject |
| Name | Type |
|---|---|
middlewares |
Middleware<T & V>[] |
Composer<T & V, R>
▸ enforce<V>(beforeMiddleware, middleware, afterMiddleware): Composer<T & V, R>
Runs middleware before and after the main
| Name | Type |
|---|---|
V |
UnknownObject |
| Name | Type |
|---|---|
beforeMiddleware |
Middleware<T & V> |
middleware |
Middleware<T & V> |
afterMiddleware |
Middleware<T & V> |
Composer<T & V, R>
▸ filter<V>(condition, filterMiddleware): Composer<T & V, R>
Conditionally runs middleware or stops the chain
| Name | Type |
|---|---|
V |
UnknownObject |
| Name | Type |
|---|---|
condition |
BranchMiddlewareCondition<T & V> |
filterMiddleware |
Middleware<T & V> |
Composer<T & V, R>
▸ fork<V>(middleware): Composer<T & V, R>
Runs the middleware at the next event loop and force call next()
| Name | Type |
|---|---|
V |
UnknownObject |
| Name | Type |
|---|---|
middleware |
Middleware<T & V> |
Composer<T & V, R>
▸ lazy<V>(factory): Composer<T & V, R>
Lazily asynchronously gets middleware
| Name | Type |
|---|---|
V |
UnknownObject |
| Name | Type |
|---|---|
factory |
LazyMiddlewareFactory<T & V> |
Composer<T & V, R>
▸ optional<V>(condition, optionalMiddleware): Composer<T & V, R>
Conditionally runs optional middleware or skips middleware
| Name | Type |
|---|---|
V |
UnknownObject |
| Name | Type |
|---|---|
condition |
BranchMiddlewareCondition<T & V> |
optionalMiddleware |
Middleware<T & V> |
Composer<T & V, R>
▸ tap<V>(middleware): Composer<T & V, R>
Runs the middleware and force call next()
| Name | Type |
|---|---|
V |
UnknownObject |
| Name | Type |
|---|---|
middleware |
Middleware<T & V> |
Composer<T & V, R>
▸ use<V>(middleware): Composer<T & V, R>
Adds middleware to the chain
| Name | Type |
|---|---|
V |
UnknownObject |
| Name | Type |
|---|---|
middleware |
Middleware<T & V> |
Composer<T & V, R>
▸ builder<Context>(): Composer<Context, Context>
Invokes a new instance of the Composer class
| Name | Type |
|---|---|
Context |
extends UnknownObject |
Composer<Context, Context>