Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

express-json-handler

Package Overview
Dependencies
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

express-json-handler

Simplify sending JSON responses in express handlers

  • 0.0.1
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

express-json-handler

Simply return objects from your route handler functions in express.

Instead of:

app.post('/auth/', (req, res) => {
  res.json({ success: false });
});

do:

const JSONHandler = require('express-json-handler');

app.post('/auth/', JSONHandler(async (req, res) {
  return { success: false };
}));

Benefits?

  • return instead of res.json()
  • async functions properly handled
  • errors properly delivered in JSON responses
  • browser cache disabled

Installation

npm install express-json-handler

Async functions handled and errors catched

express-json-handler properly supports async functions in Express 4. This won't work as expected in Express 4:

app.post('/auth/', async (req, res) {
  non_existing();
});

express-json-handler catches errors on your async handler and in that case { success: false } is returned. You can change the default reply:

const JSONHandler = require('express-json-handler');

JSONHandler.DEFAULT_FAIL_RESPONSE = {
  message: "Internal server error"
};

app.post('/auth/', JSONHandler(async (req, res) {
  non_existing();
}));

Direct responses

You can still send direct responses from your handler code, either with res.send() or even res.json() if you like. Return nothing or null from your handler in case you do.

Caching of responses

By default express-json-handler sends cache disabling headers in responses, namely:

Cache-Control: private, max-age=0, no-cache, must-revalidate
Pragma: no-cache

You can change that behavior:

const JSONHandler = require('JSONHandler');

JSONHandler.DEFAULT_HEADERS = {
  'Cache-Control': 'max-age=3600'
};

Development and maintenance

Tests: npm run test or mocha test.js.

Liner: npm run lint or eslint index.js.

Author: Egor Egorov me@egorfine.com.
License: MIT

Keywords

FAQs

Package last updated on 12 Nov 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc