Node-proxy-env NPM

Config module

Simple module to configure or auto-detect proxy URL. It is a standalone piece of code that does not require any other node modules.

Installation

In your project folder run:

npm install --save node-proxy-env

Note: The module code uses few ES6 features, so at least 4.4.5 version of Node is required.

Usage

First you need to include the module and configure it.

const proxy = require('node-proxy-env').create('http://proxy.example.org');

Requiring the module returns a create factory function that is immediately called with proxy URL (proxy is explicitly set in this case). If the URL parameter is ommited, the proxy module defaults to proxy auto-detection based on environment variables.

Using the proxy module is quite straightforward:

proxy.useProxy() // returns boolean value based on configuration or auto-detection proxy.enabled // equivalent to above
proxy.getUrl() // returns proxy URL or null value depending on the explicit configuration or auto-detection
proxy.setUrl(url) // explicitly sets new proxy URL, throws Error for invalid URLs
proxy.setUrl(null) // disabling proxy configuration
proxy.setUrl(proxy.autoDetect()) // setting proxy to auto-detected value

Example

Proxy module is typically used in conjunction with other libraries that may be configured with proxy URL in order to work properly.

const request = require('request');
const proxy = require('node-proxy-env').create();  // proxy autodetection

// configure request module to optionally use proxy
if (proxy.useProxy()) {
    request.defaults({
        proxy: proxy.getUrl()
    });
}
// make the call
request.get(...);