Package Exports

@schibsted/middy-cors
@schibsted/middy-cors/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@schibsted/middy-cors) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Schibsted Middy CORS middleware

github checks current version @ npm weekly downloads @ npm minified size

CORS middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda

This middleware sets HTTP CORS headers, necessary for making cross-origin requests, to the response object.

Sets headers in after and onError phases.

This is an alternative to standard Middy cors handler with the following differences:

it allows you to add more CORS headers

Install

To install this middleware you can use NPM:

npm install --save @schibsted/middy-cors

Options

allowedOrigins (array) - list of allowed origins or ['*'] for allowing all origins
exposeHeaders (array) - list of headers to expose
maxAge (string) - value passed to access-control-max-age header
credentials (bool) - value passed to access-control-allow-credentials header
allowMethods (array) - list of allowed HTTP methods
allowHeaders (array) - list of allowed HTTP headers

Sample usage

const middy = require('@middy/core');
const cors = require('@schibsted/middy-cors');

const handler = middy(async () => ({
        statusCode: 200,
        body: JSON.stringify({ foo: 'bar' }),
    }));

handler
  .use(cors({ allowedOrigins: ['https://www.vg.no', 'https://www.tek.no']}));

// when Lambda runs the handler...
handler({}, {}, (_, response) => {
  expect(response).toEqual({
    statusCode: 200,
    headers: {
        'access-control-allow-origin': 'https://www.vg.no',
    },
    body: JSON.stringify({ foo: 'bar' }),
  })
})

Contributing

Everyone is very welcome to contribute to this repository. Feel free to raise issues or to submit Pull Requests.