npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

json-middleware

v1.0.2

Published

Middleare component to send responses as JSON when requested as JSON

Downloads

28

Readme

About

Automatically send model data as JSON instead of passing to the view renderer when the user agent sends an Accept type of application/json or adds a json parameter to the query string.

Installation

Installing through npm is as easy as:

npm install json-middleware

Usage

To plug the middleware into a Connect or Express server:

var app = require('express')();
app.use(require('json-middleware').middleware());

When the middleware component runs, an isJson property is attached to the request. The value of the isJson property will either be true when the Accept header is set to application/json, or it will be set to whatever the json query string parameter value was.

To send a response as JSON instead of the usual view renderer, just call res.render as normal:

app.get('/', function(req, res) {
   res.render("index", myDataObject);
});

In this case, when the response is to be rendered as JSON, myDataObject will be sent as a JSON response instead of being passed to whatever view engine has been set up (eg: hogan-middleware)

Example

app.use(require('json-middleware').middleware());

app.get('/', function(req, res) {
   console.log(req.isJson);
   res.render("index", req.session); // render the index view with all data from the session
});

When accessing /, the index view is rendered with data held in the req.session object. Accessing /?json=on result in the req.session object being sent to the client as JSON and the console will print on.

Accessing / with the Accept request header set to application/json will result in the console printing true and the req.session object being sent to the client as JSON.

Note

Only the req.render function is altered, all other utilities for responding to requests (eg: req.send) are left untouched.

License

Released under the MIT license. In short usage is free for any purpose, with the usual lack of warranties either explicit or implied.