1.2.4 • Published 4 years ago

express-respond-simple v1.2.4

Weekly downloads
1
License
MIT
Repository
github
Last release
4 years ago

express-respond-simple

Simple helpers which create an express middleware, which responds 200 OK, or any other valid code. Optional response body as a string or object can be supplied.

Build Status

Install

npm install --save express-respond-simple

Use

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);
$ 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

1.2.4

4 years ago

1.2.3

4 years ago

1.2.2

5 years ago

1.2.1

5 years ago

1.2.0

5 years ago

1.1.0

8 years ago

1.0.2

8 years ago

1.0.1

8 years ago

1.0.0

8 years ago