Middy CORS middleware
WARNING: this package has been deprecated. Please use the renamed version
@middy/http-cors
!
CORS middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda
This middleware sets CORS headers (Access-Control-Allow-Origin
, Access-Control-Allow-Headers
, Access-Control-Allow-Credentials
), necessary for making cross-origin requests, to the response object.
Sets headers in after
and onError
phases.
Install
To install this middleware you can use NPM:
npm install --save @middy/cors
Options
-
origin
(string) (optional): origin to put in the header (default: "*
") -
headers
(string) (optional): value to put in Access-Control-Allow-Headers (default:null
) -
credentials
(bool) (optional): if true, sets theAccess-Control-Allow-Origin
as request headerOrigin
, if present (defaultfalse
)
Sample usage
const middy = require('middy')
const { cors } = require('middy/middlewares')
const handler = middy((event, context, cb) => {
cb(null, {})
})
handler.use(cors())
// when Lambda runs the handler...
handler({}, {}, (_, response) => {
expect(response.headers['Access-Control-Allow-Origin']).toEqual('*')
})
Middy documentation and examples
For more documentation and examples, refers to the main Middy monorepo on GitHub or Middy official website.
Contributing
Everyone is very welcome to contribute to this repository. Feel free to raise issues or to submit Pull Requests.
License
Licensed under MIT License. Copyright (c) 2017-2018 Luciano Mammino and the Middy team.