koa2-cors
cors middleware for koa2
Last updated 2 years ago by zadzbw .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install koa2-cors 
SYNC missed versions from official npm registry.

koa2-cors

install

it requires node v7.6.0 or higher now

npm install --save koa2-cors

Usage

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

var app = new Koa();
app.use(cors());

Options

origin

Configures the Access-Control-Allow-Origin CORS header. expects a string. Can also be set to a function, which takes the ctx as the first parameter.

exposeHeaders

Configures the Access-Control-Expose-Headers CORS header. Expects a comma-delimited array.

maxAge

Configures the Access-Control-Max-Age CORS header. Expects a Number.

credentials

Configures the Access-Control-Allow-Credentials CORS header. Expects a Boolean.

allowMethods

Configures the Access-Control-Allow-Methods CORS header. Expects a comma-delimited array , If not specified, default allowMethods is ['GET', 'PUT', 'POST', 'PATCH', 'DELETE', 'HEAD', 'OPTIONS'].

allowHeaders

Configures the Access-Control-Allow-Headers CORS header. Expects a comma-delimited array . If not specified, defaults to reflecting the headers specified in the request's Access-Control-Request-Headers header.

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

var app = new Koa();
app.use(cors({
  origin: function(ctx) {
    if (ctx.url === '/test') {
      return false;
    }
    return '*';
  },
  exposeHeaders: ['WWW-Authenticate', 'Server-Authorization'],
  maxAge: 5,
  credentials: true,
  allowMethods: ['GET', 'POST', 'DELETE'],
  allowHeaders: ['Content-Type', 'Authorization', 'Accept'],
}));
...

More details about CORS.

License

MIT License

Current Tags

  • 2.0.6                                ...           latest (2 years ago)

5 Versions

  • 2.0.6                                ...           2 years ago
  • 2.0.5                                ...           3 years ago
  • 2.0.4                                ...           3 years ago
  • 2.0.3                                ...           3 years ago
  • 2.0.2                                ...           4 years ago
Maintainers (1)
Downloads
Today 13
This Week 1,158
This Month 4,301
Last Day 422
Last Week 1,869
Last Month 8,156
Dependencies (0)
None
Dev Dependencies (10)
Dependents (155)

Copyright 2014 - 2016 © taobao.org |