zadzbw / koa2-cors

CORS middleware for koa2

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

koa2-cors's Issues

Is it safe to use the headers from Access-Control-Request-Headers if the allowHeaders is empty?

I found the code below:

if (options.allowHeaders) {
        ctx.set('Access-Control-Allow-Headers', options.allowHeaders.join(','));
      } else {
        ctx.set('Access-Control-Allow-Headers', ctx.get('Access-Control-Request-Headers'));
      }
}

And I have a question of that if it is safe to use the value of Access-Control-Request-Headers for Access-Control-Allow-Headers or maybe I misunderstand the usage of the Access-Control-Request-Headers.

How to set up multiple origin?

app.use(cors({
  origin: 'http://localhost:8080'
}));

This setting is no problem on the localhost:8080 service.

But I also want to configure a service on the 8081 port should be configured?

使用了组件后获取不到get方法传递过来的参数

"axios": "latest",
"koa": "latest",
"koa-body": "latest",
"koa2-cors": "latest",
"koa-router": "latest",
"require-directory": "latest",
"form-data": "latest"

使用到这些库

Difference to @koa/cors?

Trying to figure out what to use to set CORS.
As I came across this package, was wondering what is the difference between this one and @koa/cors?

2.0.5 dist folder doesen't transform！！

dist folder file is same with src fix it ,

return async function (ctx, next) {
^^^^^^^^
SyntaxError: Unexpected token function

哥们 dist 目录的文件没bable 转译