Skip to content

Adds jsend formated json responses to the express response object

Notifications You must be signed in to change notification settings

wookets/express-jsend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Adds jsend() and jfail() and jerror() to the express.response object.

http://labs.omniti.com/labs/jsend

Install

In package.json, under dependencies, you can do...

"emailer": "https://github.com/wookets/node-emailer/0.1.1"

Use

// require after you require express
require('express-jsend');

// in your route
function(res, req, next) {
  res.jsend({...data object...});
  // sends -> {"status": "success", data: {... data object...}}

  res.jfail({... data object...});
  // sends -> {"status": "fail", data: {... data object...}}

  res.jfail('InvalidParameter', 'The name field is required.');
  // sends -> {"status": "fail", code: "InvalidParameter", message: "The name field is required."}

  res.jfail(new Error("My custom error"));
  // sends -> {"status": "fail", code: "Error", message: "My custom error"}

  res.jerror('InvalidParameter', 'The name field is required.');
  // sends -> {"status": "error", code: "InvalidParameter", message: "The name field is required."}

  res.jerror(new Error("My custom error"));
  // sends -> {"status": "error", code: "Error", message: "My custom error"}
}

License

(The MIT License)

Copyright (c) 2013 Sean Wesenberg <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Adds jsend formated json responses to the express response object

Resources

Stars

Watchers

Forks

Packages

No packages published