egg-cors

[![NPM version][npm-image]][npm-url]
[![Test coverage][codecov-image]][codecov-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/egg-cors.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-cors
[codecov-image]: https://codecov.io/github/eggjs/egg-cors/coverage.svg?branch=master
[codecov-url]: https://codecov.io/github/eggjs/egg-cors?branch=master
[download-image]: https://img.shields.io/npm/dm/egg-cors.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-cors

CORS plugin for egg, based on @koa/cors.

Install

``bash
$ npm i egg-cors --save
`

Usage

`js
// {app_root}/config/plugin.js
exports.cors = {
enable: true,
package: 'egg-cors',
};
`

egg-cors works internally with egg-security. By defining the property of domainWhiteList on object security, you have successfully informed the framework to whitelist the passed domains.

When you make a request from client side, egg should return an Access-Control-Allow-Origin response header with the domain that you passed in along with the payload and status code 200.

`js
exports.security = {
domainWhiteList: [ 'http://localhost:4200' ],
};
`

Configuration

Support all configurations in @koa/cors.

`js
// {app_root}/config/config.default.js
exports.cors = {
// {string|Function} origin: '*',
// {string|Array} allowMethods: 'GET,HEAD,PUT,POST,DELETE,PATCH'
};
`

If the origin is set, the plugin will follow it to set the Access-Control-Allow-Origin and ignore the security.domainWhiteList. Otherwise, the security.domainWhiteList which is default will take effect as described above.

Security

Only in safe domain list support CORS when security plugin enabled.

Questions & Suggestions

Please open an issue here.

License

MIT

Contributors

|
atian25
|
dead-horse
|
fengmk2
|
brickyang
|
sinchang
|
XadillaX
|
| :---: | :---: | :---: | :---: | :---: | :---: |

mattma
|
SoraYama
|
Yelmor
|
angela-1
|
waitingsong


This project follows the git-contributor spec, auto updated at Mon Dec 11 2023 13:25:00 GMT+0800`.