Wondering what’s next for npm?Check out our public roadmap! »

    kcors
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/kcors package

    2.2.2 • Public • Published

    @koa/cors

    NPM version build status Test coverage David deps npm download

    Cross-Origin Resource Sharing(CORS) for koa

    Installation

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

    Quick start

    Enable cors with default options:

    • origin: request Origin header
    • allowMethods: GET,HEAD,PUT,POST,DELETE,PATCH
    const Koa = require('koa');
    const cors = require('@koa/cors');
     
    const app = new Koa();
    app.use(cors());

    cors(options)

    /**
     * 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

    Install

    npm i kcors

    DownloadsWeekly Downloads

    22,061

    Version

    2.2.2

    License

    MIT

    Unpacked Size

    9.79 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar