Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coderaiser/node-serve-once
serve express middleware once
https://github.com/coderaiser/node-serve-once
expressjs http middleware nodejs serve server
Last synced: 28 days ago
JSON representation
serve express middleware once
- Host: GitHub
- URL: https://github.com/coderaiser/node-serve-once
- Owner: coderaiser
- License: mit
- Created: 2018-11-06T15:12:07.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-16T12:38:44.000Z (8 months ago)
- Last Synced: 2024-09-26T18:41:24.113Z (about 1 month ago)
- Topics: expressjs, http, middleware, nodejs, serve, server
- Language: JavaScript
- Size: 38.1 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog
- License: LICENSE
Awesome Lists containing this project
README
# Serve Once [![License][LicenseIMGURL]][LicenseURL] [![NPM version][NPMIMGURL]][NPMURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL] [![Coverage Status][CoverageIMGURL]][CoverageURL]
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](https://github.com/coderaiser/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
```js
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:
```js
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:
```js
// 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
[NPMIMGURL]: https://img.shields.io/npm/v/serve-once.svg?style=flat
[BuildStatusIMGURL]: https://img.shields.io/travis/coderaiser/node-serve-once/master.svg?style=flat
[LicenseIMGURL]: https://img.shields.io/badge/license-MIT-317BF9.svg?style=flat
[CoverageIMGURL]: https://coveralls.io/repos/coderaiser/node-serve-once/badge.svg?branch=master&service=github
[NPMURL]: https://npmjs.org/package/serve-once "npm"
[BuildStatusURL]: https://travis-ci.org/coderaiser/node-serve-once "Build Status"
[LicenseURL]: https://tldrlegal.com/license/mit-license "MIT License"
[CoverageURL]: https://coveralls.io/github/coderaiser/node-serve-once?branch=master