serve express middleware once


Keywords
express, middleware, server, serve, once, http, get, put, post, delete, expressjs, nodejs
License
MIT
Install
npm install serve-once@3.0.2

Documentation

Serve Once License NPM version Build Status Coverage Status

Serve express middleware once.

  1. creates http server on a free port
  2. uses passed express middleware
  3. serve exectly 1 request
  4. closes http server
  5. pullout body of request stream
  6. resolves request promise with a response

Good for middleware logic testing.

Install

npm i serve-once

API

request(method, path[ {options, body, type = 'string'}])

  • method - http-method (get, put, post etc)
  • path - http-path
  • options - middleware options
  • body - http-request body
  • headers - http-request headers
  • type - type of return value, can be:
    • string
    • json
    • stream
    • buffer
const middleware = (options = 'hello') => (req, res) => {
    res.end(JSON.stringify(options));
};

const {request} = require('serve-once')(middleware);

await request('get', '/');
// returns
'hello';

await request.get('/', {
    options: 'any',
});

// returns
'any';

You can send body:

const pullout = require('pullout');
const putMiddleware = () => async (req, res) => {
    const body = await pullout(req);
    res.end(body);
};

const {request} = require('serve-once')(putMiddleware);

const {body} = await request.put('/', {
    body: [1, 2, 3],
});

console.log(JSON.parse(body));
// returns
[1, 2, 3];

You can use default options:

// default options
const middleware = (options) => (req, res) => {
    res.end(JSON.stringify(options));
};

const {request} = require('serve-once')(middleware, {
    a: 1,
});

const options = {
    b: 2,
};

const {body} = await request.get('/', {
    options,
});

JSON.parse(body);
// returns
({
    a: 1,
    b: 2,
});

License

MIT