@a-2-c-2-anpm/at-assumenda-sit

Version:

[![NPM version][npm-image]][npm-url] [![Node.js CI](https://github.com/a-2-c-2-anpm/at-assumenda-sit/actions/workflows/nodejs.yml/badge.svg)](https://github.com/a-2-c-2-anpm/at-assumenda-sit/actions/workflows/nodejs.yml) [![Test coverage][codecov-image]][

github.com/a-2-c-2-anpm/at-assumenda-sit/

a-2-c-2-anpm/at-assumenda-sit

90 lines (67 loc) • 5.96 kB

Markdown

View Raw

# @a-2-c-2-anpm/at-assumenda-sit [![NPM version][npm-image]][npm-url] [![Node.js CI](https://github.com/a-2-c-2-anpm/at-assumenda-sit/actions/workflows/nodejs.yml/badge.svg)](https://github.com/a-2-c-2-anpm/at-assumenda-sit/actions/workflows/nodejs.yml) [![Test coverage][codecov-image]][codecov-url] [![npm download][download-image]][download-url] [npm-image]: https://img.shields.io/npm/v/@a-2-c-2-anpm/at-assumenda-sit.svg?style=flat-square [npm-url]: https://npmjs.org/package/@a-2-c-2-anpm/at-assumenda-sit [codecov-image]: https://codecov.io/github/a-2-c-2-anpm/at-assumenda-sit/coverage.svg?branch=v2.x [codecov-url]: https://codecov.io/github/a-2-c-2-anpm/at-assumenda-sit?branch=v2.x [download-image]: https://img.shields.io/npm/dm/@a-2-c-2-anpm/at-assumenda-sit.svg?style=flat-square [download-url]: https://npmjs.org/package/@a-2-c-2-anpm/at-assumenda-sit [Cross-Origin Resource Sharing(CORS)](https://developer.mozilla.org/en/docs/Web/HTTP/Access_control_CORS) for koa ## Installation ```bash $ npm install @a-2-c-2-anpm/at-assumenda-sit --save ``` ## Quick start Enable cors with default options: - origin: `*` (v4 and before: the request's Origin header). This means that **by default the requests from all origin webpages will be allowed**. If you're running a generic API server, this is what you want, but otherwise you should look into changing the default to something more suitable to your application. - allowMethods: GET,HEAD,PUT,POST,DELETE,PATCH ```js const Koa = require('koa'); const cors = require('@a-2-c-2-anpm/at-assumenda-sit'); 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 '*' * If `credentials` set and return `true, the `origin` default value will set to the 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|Function(ctx)} credentials `Access-Control-Allow-Credentials`, default is false. * - {Boolean} keepHeadersOnError Add set headers to `err.header` if an error is thrown * - {Boolean} secureContext `Cross-Origin-Opener-Policy` & `Cross-Origin-Embedder-Policy` headers.', default is false * - {Boolean} privateNetworkAccess handle `Access-Control-Request-Private-Network` request by return `Access-Control-Allow-Private-Network`, default to false * @return {Function} cors middleware * @api public */ ``` ## Breaking change between 4.0 and 5.0 The default `origin` is set to `*`, if you want to keep the 4.0 behavior, you can set the `origin` handler like this: ```js app.use(cors({ origin(ctx) { return ctx.get('Origin') || '*'; }, })); ``` ## License [MIT](./LICENSE)  ## Contributors |[<img src="https://avatars.githubusercontent.com/u/156269?v=4" width="100px;"/> fengmk2](https://github.com/fengmk2) |[<img src="https://avatars.githubusercontent.com/u/985607?v=4" width="100px;"/> dead-horse](https://github.com/dead-horse) |[<img src="https://avatars.githubusercontent.com/u/1127384?v=4" width="100px;"/> omsmith](https://github.com/omsmith) |[<img src="https://avatars.githubusercontent.com/u/643505?v=4" width="100px;"/> jonathanong](https://github.com/jonathanong) |[<img src="https://avatars.githubusercontent.com/u/5622516?v=4" width="100px;"/> AlphaWong](https://github.com/AlphaWong) |[<img src="https://avatars.githubusercontent.com/u/55783048?v=4" width="100px;"/> cma-skedulo](https://github.com/cma-skedulo) | | :---: | :---: | :---: | :---: | :---: | :---: | |[<img src="https://avatars.githubusercontent.com/u/6992588?v=4" width="100px;"/> CleberRossi](https://github.com/CleberRossi) |[<img src="https://avatars.githubusercontent.com/u/178720?v=4" width="100px;"/> erikfried](https://github.com/erikfried) |[<img src="https://avatars.githubusercontent.com/u/1217939?v=4" width="100px;"/> j-waaang](https://github.com/j-waaang) |[<img src="https://avatars.githubusercontent.com/u/4184677?v=4" width="100px;"/> ltomes](https://github.com/ltomes) |[<img src="https://avatars.githubusercontent.com/u/372420?v=4" width="100px;"/> lfreneda](https://github.com/lfreneda) |[<img src="https://avatars.githubusercontent.com/u/170299?v=4" width="100px;"/> matthewmueller](https://github.com/matthewmueller) | [<img src="https://avatars.githubusercontent.com/u/6006498?v=4" width="100px;"/> PlasmaPower](https://github.com/PlasmaPower) |[<img src="https://avatars.githubusercontent.com/u/14932834?v=4" width="100px;"/> swain](https://github.com/swain) |[<img src="https://avatars.githubusercontent.com/u/49938086?v=4" width="100px;"/> TyrealHu](https://github.com/TyrealHu) |[<img src="https://avatars.githubusercontent.com/u/8369011?v=4" width="100px;"/> xg-wang](https://github.com/xg-wang) |[<img src="https://avatars.githubusercontent.com/u/12003270?v=4" width="100px;"/> lishengzxc](https://github.com/lishengzxc) |[<img src="https://avatars.githubusercontent.com/u/514097?v=4" width="100px;"/> mcohen75](https://github.com/mcohen75) This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Sat Oct 08 2022 21:35:10 GMT+0800`.