@cnamts/vue-cli-plugin-proxy

Provide all http-proxy-middleware options to vue-cli

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
112May 8, 2021Oct 2, 2018Minified + gzip package size for @cnamts/vue-cli-plugin-proxy in KB

Readme

VueDot

CNAM – Vue CLI plugin proxy

This plugin is meant to provide all http-proxy-middleware options to vue-cli.

NPM Version NPM Downloads License

Issue

See the issue than initiated this plugin (#2320)

As Easy as 1, 2, 3

Install

yarn add @cnamts/vue-cli-plugin-proxy # OR npm install @cnamts/vue-cli-plugin-proxy

Use

// vue.config.js
module.exports = {
    pluginOptions: {
        proxy: {
            enabled: true,
            context: '',
            options: {
                // ...
            }
        }
    }
}

You're done! 🎉

See http-proxy-middleware for options object to pass to the plugin.

Object examples

  • First example of the docs:
// vue.config.js
module.exports = {
    pluginOptions: {
        proxy: {
            enabled: true,
            context: '/api',
            options: {
                target: 'http://www.example.org',
                changeOrigin: true
            }
        }
    }
}
  • v1.0.0 default:
// vue.config.js
module.exports = {
    pluginOptions: {
        proxy: {
            enabled: true,
            context: ['/**', '!/dist/**'],
            options: {
                target: 'http://127.0.0.1:8000',
            }
        }
    }
}

License

Vue CLI Plugin Proxy is licensed under MIT License.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.