kcors

@koa/cors
=======

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/@koa/cors.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@koa/cors
[travis-image]: https://img.shields.io/travis/koajs/cors.svg?style=flat-square
[travis-url]: https://travis-ci.org/koajs/cors
[codecov-image]: https://codecov.io/github/koajs/cors/coverage.svg?branch=v2.x
[codecov-url]: https://codecov.io/github/koajs/cors?branch=v2.x
[david-image]: https://img.shields.io/david/koajs/cors.svg?style=flat-square
[david-url]: https://david-dm.org/koajs/cors
[download-image]: https://img.shields.io/npm/dm/@koa/cors.svg?style=flat-square
[download-url]: https://npmjs.org/package/@koa/cors

Cross-Origin Resource Sharing(CORS) for koa

Installation

``bash
$ npm install @koa/cors@2 --save
`

Quick start

Enable cors with default options:

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

`js
const Koa = require('koa');
const cors = require('@koa/cors');

const app = new Koa();
app.use(cors());
`

cors(options)

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

License

MIT