express-response-formatter
Better way to format Express response
How It Works
- You can use response with readable name like
res.formatter.ok
for 200 ok orres.formatter.badRequest
for 400 bad request. - It will format your response in two ways
success
anderror
.- If response is
2xx, 3xx
return response under object keydata
. - If response is
4xx, 5xx
return response under object keyerror
.
- If response is
- You can pass metadata as second parameter and it's will present under
meta
object key.
Installation
npm install express-response-formatter --save
Quick Start
Response for 200 Ok.
const app = // Add formatter functions to "res" object via "responseEnhancer()"app app app
Result
HTTP/1.1 200 Ok
More usages
Response for 200 Ok with meta field
app
HTTP/1.1 200 Ok
Response for 400 Bad Request with "error"
app
HTTP/1.1 400 Bad Request
APIs
METHOD | STATUS CODE |
---|---|
res.formatter.ok(data, meta?) | 200 |
res.formatter.created(data, meta?) | 201 |
res.formatter.accepted(data, meta?) | 202 |
res.formatter.noContent(data, meta?) | 204 |
res.formatter.badRequest(errors, meta) | 400 |
res.formatter.unauthorized(errors, meta) | 401 |
res.formatter.forbidden(errors, meta) | 403 |
res.formatter.notFound(errors, meta) | 404 |
res.formatter.methodNotAllowed(errors, meta) | 405 |
res.formatter.timeout(errors, meta) | 408 |
res.formatter.conflict(errors, meta) | 409 |
res.formatter.unprocess(errors, meta) | 422 |
res.formatter.tooManyRequests(errors, meta) | 429 |
res.formatter.serverError(errors, meta) | 500 |
res.formatter.badGateway(errors, meta) | 502 |
res.formatter.serviceUnavailable(errors, meta) | 503 |
res.formatter.gatewayTimeout(errors, meta) | 504 |