https://github.com/droideveloper/restfuljsonwrap
RESTful Express Json Response Wrap
https://github.com/droideveloper/restfuljsonwrap
Last synced: 11 months ago
JSON representation
RESTful Express Json Response Wrap
- Host: GitHub
- URL: https://github.com/droideveloper/restfuljsonwrap
- Owner: droideveloper
- Created: 2017-01-29T20:37:28.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-01-29T20:44:38.000Z (over 9 years ago)
- Last Synced: 2025-03-12T08:45:25.189Z (over 1 year ago)
- Language: TypeScript
- Size: 2.93 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## RESTful Express Response Wrap-JSON
Wraps JSON with as follows;
`Array or []`:
```json
{
"code": 200,
"message": "success",
"href": "$current",
"offset": 0,
"limit": 25,
"count": 0,
"data": []
}
```
`T or {}` :
```json
{
"code": 200,
"message": "success",
"href": "$current",
"data": {}
}
```
### How to install
using npm;
`npm install --save restful-express-response-wrap`
### How to use
in server.js;
```javascript
var express = require("express");
var wrap = require("restful-express-response-wrap");
var server = express();
server.get("/", function(req, res, next) {
var success = ...;
if(success) {
// use array or object as res.data param
res.data = [ { name: "node", lang: "javascript" } ] || { name: "node", lang: "javascript" };
} else {
res.error = { status: 401, message: "Unauthroized", name: "Unauthroized" };
}
next(); // call to wrap
});
// for offset and limit to be used in Array response.
// { offset: 0, limit: 10 } this part is optional default is 0, 25 as respectively
server.use(wrap());
// also wrap register for 404 and 500 errors
// always returns json but server status code served inside json with message.
```