@schibsted/middy-cors

Middy middleware for adding CORS headers to success response and errors

3.0.1
latest
Source
npm

Version published: 2 years ago

Maintainers: 5

Created: 4 years ago

Source

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.

Keywords

FAQs

What is @schibsted/middy-cors?

Is @schibsted/middy-cors well maintained?

Package last updated on 29 Aug 2022

Did you know?

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

@schibsted/middy-cors