https://github.com/robbestad/koa-cors

CORS middleware for Koa
https://github.com/robbestad/koa-cors

Last synced: 3 months ago
JSON representation

CORS middleware for Koa

• Host: GitHub
• URL: https://github.com/robbestad/koa-cors
• Owner: robbestad
• License: mit
• Fork: true (zymnytskiy/koa-cors)
• Created: 2018-05-29T07:24:52.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-02-07T13:52:01.000Z (almost 7 years ago)
• Last Synced: 2024-09-26T16:41:01.802Z (4 months ago)
• Language: JavaScript
• Homepage:
• Size: 39.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
koa-cors

========

CORS middleware for Koa

Inspired by the great [node-cors](https://github.com/troygoode/node-cors) module.

## Installation (via [npm](https://npmjs.org/package/koa-cors))

```bash

$ npm install koa-cors

```

## Usage

```javascript

var koa = require('koa');

var route = require('koa-route');

var cors = require('koa-cors');

var app = koa();

app.use(cors());

app.use(route.get('/', function() {

  this.body = { msg: 'Hello World!' };

}));

app.listen(3000);

```

## Options

### origin

Configures the **Access-Control-Allow-Origin** CORS header. Expects a string

(ex: http://example.com). Set to `true` to reflect the

[request origin](http://tools.ietf.org/html/draft-abarth-origin-09), as defined

by `req.header('Origin')`. Set to `false` to disable CORS. Can also be set to a

function, which takes the request as the first parameter.

### expose

Configures the **Access-Control-Expose-Headers** CORS header. Expects a

comma-delimited string (ex: 'WWW-Authenticate,Server-Authorization') or an array

(ex: `['WWW-Authenticate', 'Server-Authorization']`). Set this to pass the

header, otherwise it is omitted.

### maxAge

Configures the **Access-Control-Max-Age** CORS header. Set to an integer to pass

the header, otherwise it is omitted.

### credentials

Configures the **Access-Control-Allow-Credentials** CORS header. Set to `true`

to pass the header, otherwise it is omitted.

### methods

Configures the **Access-Control-Allow-Methods** CORS header. Expects a

comma-delimited string (ex: 'GET,PUT,POST') or an array (ex: `['GET', 'PUT',

'POST']`).

### headers

Configures the **Access-Control-Allow-Headers** CORS header. Expects a

comma-delimited string (ex: 'Content-Type,Authorization') or an array (ex:

`['Content-Type', 'Authorization']`). If not specified, defaults to reflecting

the headers specified in the request's **Access-Control-Request-Headers**

header.

For details on the effect of each CORS header,

[read this article on HTML5 Rocks](http://www.html5rocks.com/en/tutorials/cors/).

## License

[MIT License](http://www.opensource.org/licenses/mit-license.php)