Adonis Middleware Base :triangular_ruler:

This repo contains the code to make middleware work with the HTTP and Websocket server. If you are looking for generic middleware library, try co-compose.

---

[![NPM Version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Appveyor][appveyor-image]][appveyor-url]
[![Coveralls][coveralls-image]][coveralls-url]

Usage

``
const MiddlewareBase = require('@adonisjs/middleware-base')

const middleware = MiddlewareBase('handle')

// register global middleware
middleware.registerGlobal(['App/Middleware/BodyParser'])

await middleware
.getGlobalAndNamed([])
.params([ctx])
.run()
`

Classes

MiddlewareBase

Functions

registerGlobal(middleware) ⇒ void

Register global middleware

use(middleware) ⇒ void

Register server type middleware

registerNamed(middleware) ⇒ void

Register an object of named middleware

composeServer() ⇒ Runner

Composes server level middleware

composeGlobalAndNamed(namedReference) ⇒ Runner

Composes global and named middleware together. Pass empty
array when no named middleware are supposed to be
executed.

MiddlewareBase

Kind: global class

$3

MiddlewareBase class is a simple abstraction written to
work just with AdonisJs middleware layer.

Adonis has global, named and server middleware with a slight
difference in each. So this class understands all and offers
a simple abstraction around them.

| Param | Type | Description |
| --- | --- | --- |
| middlewareFn | String | The function to be called on middleware class |
| [warnFn] | function | |

registerGlobal(middleware) ⇒ void

Register global middleware

Kind: global function
Throws:

- InvalidArgumentException If middleware is not an array

| Param | Type |
| --- | --- |
| middleware | Array |

Example
`js
middleware.registerGlobal([
'Adonis/Middleware/BodyParser',
'Adonis/Middleware/Session'
])
`


use(middleware) ⇒ void

Register server type middleware

Kind: global function
Throws:

- InvalidArgumentException If middleware is not an array

| Param | Type |
| --- | --- |
| middleware | Array |

Example
`js
middleware.use(['Adonis/Middleware/Static'])
`


registerNamed(middleware) ⇒ void

Register an object of named middleware

Kind: global function
Throws:

- InvalidArgumentException If middleware is not an object with key/value pair.

| Param | Type |
| --- | --- |
| middleware | Object |

Example
`js
middleware.registerNamed({
auth: 'Adonis/Middleware/Auth'
})
``

composeServer() ⇒ Runner

Composes server level middleware

Kind: global function

composeGlobalAndNamed(namedReference) ⇒ Runner

Composes global and named middleware together. Pass empty
array when no named middleware are supposed to be
executed.

Kind: global function

| Param | Type |
| --- | --- |
| namedReference | Array |

[appveyor-image]: https://img.shields.io/appveyor/ci/thetutlage/adonis-middleware-base/master.svg?style=flat-square
[appveyor-url]: https://ci.appveyor.com/project/thetutlage/adonis-middleware-base

[npm-image]: https://img.shields.io/npm/v/@adonisjs/middleware-base.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@adonisjs/middleware-base

[travis-image]: https://img.shields.io/travis/adonisjs/adonis-middleware-base/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/adonisjs/adonis-middleware-base

[coveralls-image]: https://img.shields.io/coveralls/adonisjs/adonis-middleware-base/develop.svg?style=flat-square
[coveralls-url]: https://coveralls.io/github/adonisjs/adonis-middleware-base