res-json

1.0.1 • Public • Published

res-json

Node.js middleware to send JSON/JSONP responses.

Adds json() & jsonp() methods to response object.

This middleware is primarily created for router module. Unlike express, which supports json method natively, router does not provide such method to output json.

NPM version Build Status Coverage Status Known Vulnerabilities

Installation

$ npm install res-json --save

Usage

const json = require('res-json');
 
const router = Router();
router.use(json());
 
router.get('/', (req, res) => {
  res.json({id: 1, message: 'Hello, World!'})
});

API

The middleware can be initialized optionally with a replacer and a space value. For more info. refer to JSON.stringify().

You can also provide a third argument as callback name for jsonp to override default callback name - callback

router.use(json(null, '\t'));  // indent with tabs

res.json(obj)

Write a JSON response, using JSON.stringify() with the content-type application/json.

res.jsonp(obj)

Write a JSON response with JSONP support.

router.use(json(null, '', 'cb')); // callback name is cb
 
router.get('/?cb=callme', (req, res) => {
  res.jsonp({id: 1, message: 'Hello, World!'})
});

License

MIT

Package Sidebar

Install

npm i res-json

Weekly Downloads

1

Version

1.0.1

License

MIT

Last publish

Collaborators

  • palanik