Gathering detailed insights and metrics for express-response-formatter
@faatlab/express-response-formatter
This library was generated with [Nx](https://nx.dev).
shiny-express-formatter
request/response formatter for node.js express apps
@ianriizky/jsonapi-formatter-express
An Express library to serialize/deserialize the incoming request and outcoming response into JSON:API format.
npm install express-response-formatterTypescript
Module System
Node Version
NPM Version
70.3
Supply Chain
98.7
Quality
75.7
Maintenance
100
Vulnerability
100
License
TypeScript (80.04%)
JavaScript (19.96%)
Love this project? Help keep it running — sponsor us today! 🚀
Total Downloads
100,427
Last Day
7
Last Week
7
Last Month
1,447
Last Year
25,940
25 Stars
85 Commits
9 Forks
4 Watching
4 Branches
2 Contributors
Minified
Minified + Gzipped
Latest Version
2.0.2
Package Id
express-response-formatter@2.0.2
Unpacked Size
0.99 MB
Size
518.32 kB
File Count
9
NPM Version
6.13.4
Node Version
12.16.1
Cumulative downloads
Total Downloads
Last day
0%
7
Compared to previous day
Last week
-96.5%
7
Compared to previous week
Last month
-8.1%
1,447
Compared to previous month
Last year
-15.1%
25,940
Compared to previous year
Better way to format Express response
res.formatter.ok for 200 ok or res.formatter.badRequest for 400 bad request.success and error.
2xx, 3xx return response under object key data.4xx, 5xx return response under object key error.meta object key.
npm install express-response-formatter --save
Response for 200 Ok.
1import app from 'express' 2import { responseEnhancer } from 'express-response-formatter' 3 4const app = express() 5 6// Add formatter functions to "res" object via "responseEnhancer()" 7app.use(responseEnhancer()) 8 9app.get('/success', (req, res) => { 10 const users = [{ name: 'Dana Kennedy' }, { name: 'Warren Young' }] 11 12 // It's enhance "res" with "formatter" which contain formatter functions 13 res.formatter.ok(users) 14}) 15 16app.listen(3000, () => console.log('Start at http://localhost:3000'))
Result
1HTTP/1.1 200 Ok 2{ 3 "data": [ 4 { 5 "name": "Dana Kennedy" 6 }, 7 { 8 "name": "Warren Young" 9 } 10 ] 11}
Response for 200 Ok with meta field
1app.get('/success-with-meta', (req, res) => { 2 const users = [{ name: 'Dana Kennedy' }, { name: 'Warren Young' }] 3 4 const meta = { 5 total: 2, 6 limit: 10, 7 offset: 0, 8 } 9 10 res.formatter.ok(users, meta) 11})
1HTTP/1.1 200 Ok 2{ 3 "meta": { 4 "total": 2, 5 "limit": 10, 6 "offset": 0, 7 }, 8 "data": [ 9 { 10 "name": "Dana Kennedy" 11 }, 12 { 13 "name": "Warren Young" 14 } 15 ] 16}
Response for 400 Bad Request with "error"
1app.get('/bad-request', (req, res) => { 2 const errors = [ 3 { detail: 'Field id is required.' }, 4 { detail: 'Field foo is required.' }, 5 ] 6 7 res.formatter.badRequest(errors) 8})
1HTTP/1.1 400 Bad Request 2{ 3 "error": [ 4 { 5 "detail": "Field id is required." 6 }, 7 { 8 "detail": "Field foo is required." 9 } 10 ] 11}
| 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 |
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
Reason
Found 1/29 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
Reason
project is not fuzzed
Details
Reason
branch protection not enabled on development/release branches
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Reason
43 existing vulnerabilities detected
Details
Score
Last Scanned on 2025-02-03
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More