1.0.0 • Published 6 months ago

connect-reqres v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
6 months ago

NPM version Build Status Dependency Status

connect-reqres

Common request and response helpers expected by most Connnect/Express middleware.

Install

$ npm install --save connect-reqres

Usage

const app = require('connect');
const reqres = require('connect-reqres');

app.use(reqres({
  app
}));

reqres(options) - returns middleware function

options.app - is a reference to connect app that is exposed as req.app property options.querystring - is an object that provides parse method use to parse URL query string - by default node:querystring is used options.trustProxy - if falsy reqres will ignore x-forwarded-host and x-forwarded-proto headers - by default it is true

The reqres middleware decorates request and response objects. Request decorations include:

  • methods:
    • header()
    • get() alias for header
  • properties:
    • app
    • host
    • hostname
    • path
    • protocol
    • res - back reference to back
    • query
    • secure

Response decorations include:

  • methods:
    • clearCookie()
    • cookie()
    • header()
    • json()
    • redirect()
    • send()
    • sendStatus()
  • properties:
    • locals

License

MIT © Damian Krzeminski

1.0.0

6 months ago

0.0.0

6 months ago