![Seneca][Logo]

seneca-web-adapter-express

[![npm version][npm-badge]][npm-url]
[![Build Status][travis-badge]][travis-url]
[![Coverage Status][coveralls-badge]][coveralls-url]
[![Dependency Status][david-badge]][david-url]

This is an adapter for seneca-web using express.

Installation

A peer dependency has been specified for seneca-web
And of course express must be present for this to work at all.

``npm install --save express npm install --save seneca-web npm install --save seneca-web-adapter-express`

`Usage`

Please refer to the seneca-web documentation on how to load routes.

You can require this module as the adapter when using the SenecaWeb plugin

`js const Seneca = require('seneca') const SenecaWeb = require('seneca-web') const Express = require('express') const seneca = Seneca() seneca.use(SenecaWeb, { context: Express(), adapter: require('seneca-web-adapter-express'), // defaults -- options: { parseBody: true, includeRequest: true, includeResponse: true } }) seneca.ready(() => { const app = seneca.export('web/context')() app.listen(3000) })`

`Additional Options`

* parseBody attempt to parse request body into req.body*includeRequest include request$with payload (req) *includeResponse include response$` with payload (res)

Contributing

The [Senecajs org][] encourage open participation. If you feel you can help in any way,
be it with documentation, examples, extra testing, or new features please get in touch.

License

[Sponsor]: http://nearform.com
[Logo]: http://senecajs.org/files/assets/seneca-logo.png
[npm-badge]: https://badge.fury.io/js/seneca-web-adapter-express.svg
[npm-url]: https://badge.fury.io/js/seneca-web-adapter-express
[travis-badge]: https://travis-ci.org/senecajs/seneca-web-adapter-express.svg?branch=master
[travis-url]: https://travis-ci.org/senecajs/seneca-web-adapter-express
[coveralls-badge]: https://coveralls.io/repos/github/senecajs/seneca-web-adapter-express/badge.svg?branch=master
[coveralls-url]: https://coveralls.io/github/senecajs/seneca-web-adapter-express?branch=master
[david-badge]: https://david-dm.org/senecajs/seneca-web-adapter-express.svg
[david-url]: https://david-dm.org/senecajs/seneca-web-adapter-express
[Senecajs org]: https://github.com/senecajs/
[MIT]: ./LICENSE

Usage

Please refer to the seneca-web documentation on how to load routes.

You can require this module as the adapter when using the SenecaWeb plugin

js
const Seneca = require('seneca')
const SenecaWeb = require('seneca-web')
const Express = require('express')
const seneca = Seneca()
seneca.use(SenecaWeb, {
  context: Express(),
  adapter: require('seneca-web-adapter-express'),
  // defaults --
  options: {
    parseBody: true,
    includeRequest: true,
    includeResponse: true
  }
})
seneca.ready(() => {
  const app = seneca.export('web/context')()
  app.listen(3000)
})

License