@koa/cors

Cross-Origin Resource Sharing(CORS) for koa

Installation

1$ npm install @koa/cors@2 --save

Quick start

Enable cors with default options:

• origin: request Origin header
• allowMethods: GET,HEAD,PUT,POST,DELETE,PATCH

1const Koa = require('koa');
2const cors = require('@koa/cors');
3
4const app = new Koa();
5app.use(cors());

cors(options)

1/**
2 * CORS middleware
3 *
4 * @param {Object} [options]
5 *  - {String|Function(ctx)} origin `Access-Control-Allow-Origin`, default is request Origin header
6 *  - {String|Array} allowMethods `Access-Control-Allow-Methods`, default is 'GET,HEAD,PUT,POST,DELETE,PATCH'
7 *  - {String|Array} exposeHeaders `Access-Control-Expose-Headers`
8 *  - {String|Array} allowHeaders `Access-Control-Allow-Headers`
9 *  - {String|Number} maxAge `Access-Control-Max-Age` in seconds
10 *  - {Boolean} credentials `Access-Control-Allow-Credentials`
11 *  - {Boolean} keepHeadersOnError Add set headers to `err.header` if an error is thrown
12 * @return {Function} cors middleware
13 * @api public
14 */

License

MIT