JSender
Simple and structured application level JSON responses for Express. Based on JSend specification (http://labs.omniti.com/labs/jsend).
Installation
npm install jsender
Setup the middleware in your Express app. Before any routes.
var express = jsender = ; var app = ; // ... (other middlewares)app; app; // JSON Response// {// "status": "success",// "data": {// "notice": "Hello, World!"// }// }
API
JSender augments the node res
object with the following methods.
success(data)
- data: Optional response data object.
{ res;}; // JSON Response// {// "status": "success",// "data": {// "notice": "Hello, World!"// }// }
fail(data)
- data: Required failure data.
{ res;}; // JSON Response// {// "status": "fail",// "data": {// "name": "Name is required."// }// }
error(message, data, code)
- message: Required error message.
- data: Optional error data.
- code: Optional error code.
{ res;}; // JSON Response// {// "status": "error",// "message": "Server error."// }
jsend(err, data)
- err: An error object or
null
. - data: Optional response data object.
{ books ;}; // same as { books ;};