Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hugojosefson/express-respond-simple
Creates simple express middleware for responding any status and body.
https://github.com/hugojosefson/express-respond-simple
Last synced: 29 days ago
JSON representation
Creates simple express middleware for responding any status and body.
- Host: GitHub
- URL: https://github.com/hugojosefson/express-respond-simple
- Owner: hugojosefson
- Created: 2016-01-05T01:32:50.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-06-22T08:04:06.000Z (over 2 years ago)
- Last Synced: 2024-11-14T00:43:51.930Z (about 2 months ago)
- Language: JavaScript
- Homepage: https://npmjs.com/package/express-respond-simple
- Size: 411 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# express-respond-simple
Simple helpers which create an [express](http://expressjs.com/) middleware, which responds `200 OK`, or any other valid
code. Optional response body as a string or object can be supplied.
[](https://travis-ci.org/hugojosefson/express-respond-simple)
## Install
```bash
npm install --save express-respond-simple
```
### Use
```javascript
import express from 'express';
import respond from 'express-respond-simple';
import {respond200, respond402} from 'express-respond-simple';
const app = express();
// status code by number:
app.get('/health', respond200({status: 'good'}));
app.get('/empty', respond200()); // Will actually respond '204 No Content' instead of '200 OK' if no body is given
app.get('/empty-force-200', respond200('', true)); // Will respond '200 OK' with an empty body
app.get('/paywall', respond402('Please add credits to your account and try again.'));
// equivalently, by name:
app.get('/health', respond.ok({status: 'good'}));
app.get('/empty', respond.ok()); // Will actually respond '204 No Content' instead of '200 OK' if no body is given
app.get('/empty-force-200', respond.ok('', true)); // Will respond '200 OK' with an empty body
app.get('/paywall', respond.paymentRequired('Please add credits to your account and try again.'));
app.listen(process.env.PORT || 3000);
```
```bash
$ curl --include http://localhost:3000/health
HTTP/1.1 200 OK
X-Powered-By: Express
Content-Type: application/json; charset=utf-8
Content-Length: 17
ETag: W/"11-sn4NhG2LGN3PiYCfMneoRg"
Date: Tue, 05 Jan 2016 01:38:39 GMT
Connection: keep-alive
{"status":"good"}
$ curl --include http://localhost:3000/empty
HTTP/1.1 204 No Content
X-Powered-By: Express
ETag: W/"a-oQDOV50e1MN2H/N8GYi+8w"
Date: Tue, 05 Jan 2016 01:39:45 GMT
Connection: keep-alive
$ curl --include http://localhost:3000/empty-force-200
HTTP/1.1 200 OK
X-Powered-By: Express
Content-Type: text/plain; charset=utf-8
Content-Length: 0
ETag: W/"0-1B2M2Y8AsgTpgAmY7PhCfg"
Date: Wed, 06 Jan 2016 06:59:56 GMT
Connection: keep-alive
$ curl --include http://localhost:3000/paywall
HTTP/1.1 402 Payment Required
X-Powered-By: Express
Content-Type: text/plain; charset=utf-8
Content-Length: 49
ETag: W/"31-0PQSlh/LwV6MQ515vkAE9w"
Date: Tue, 05 Jan 2016 01:42:43 GMT
Connection: keep-alive
Please add credits to your account and try again.
```
### License
MIT