https://github.com/possibilities/micro-cors

Simple CORS middleware for Zeit's Micro
https://github.com/possibilities/micro-cors

Last synced: about 1 month ago
JSON representation

Simple CORS middleware for Zeit's Micro

• Host: GitHub
• URL: https://github.com/possibilities/micro-cors
• Owner: possibilities
• License: mit
• Created: 2017-01-14T09:56:45.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-07T08:59:12.000Z (over 1 year ago)
• Last Synced: 2024-05-02T16:19:47.516Z (about 1 month ago)
• Language: JavaScript
• Size: 562 KB
• Stars: 192
• Watchers: 5
• Forks: 32
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-micro - micro-cors - Simple CORS middleware. (Modules / Middlewares)

README

        
# CORS middleware for Micro

### Summary

Simple [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS) middleware for Zeit's [Micro](https://github.com/zeit/micro)

[![CircleCI](https://circleci.com/gh/possibilities/micro-cors.svg?style=svg)](https://circleci.com/gh/possibilities/micro-cors)

###### We're working on [`v1`](https://github.com/possibilities/micro-cors/issues/51), come help us out!

### Install

```

yarn add micro-cors

```

### Usage

Basic:

```js

const { send } = require('micro')

const cors = require('micro-cors')()

const handler = (req, res) => send(res, 200, 'ok!')

module.exports = cors(handler)

```

With options:

```js

const { send } = require('micro')

const microCors = require('micro-cors')

const cors = microCors({ allowMethods: ['PUT', 'POST'] })

const handler = (req, res) => send(res, 200, 'ok!')

module.exports = cors(handler)

```

Since the current version of `micro-cors` only sets headers in the response (`res`), you have do some manual work if you want to avoid triggering your handler on an `OPTIONS` preflight request (this will be built-in in v1). Let's say you want to approve preflight requests and otherwise only let POST requests trigger the handler:

```js

const { send } = require('micro')

const cors = require('micro-cors')()

const handler = (req, res) => {

  if (req.method === 'OPTIONS') {

    return send(res, 200, 'ok!');

  }

  if (req.method !== 'POST') {

    throw createError(404, 'Not Found');

  }

  // handle incoming request as usual

}

module.exports = cors(handler)

```

#### Options

##### `allowMethods`

default: `['POST','GET','PUT','PATCH','DELETE','OPTIONS']`

##### `allowHeaders`

default: `['X-Requested-With','Access-Control-Allow-Origin','X-HTTP-Method-Override','Content-Type','Authorization','Accept']`

##### `allowCredentials`

default: `true`

##### `exposeHeaders`

default: `[]`

##### `maxAge`

default: `86400`

##### `origin`

default: `*`