@mgdis/gol-got

gol-got

Convenience wrapper for got with automatic consideration of proxy env variables.

Install

$ npm install gol-got

Usage

Instead of:

// Exemple based on https://github.com/sindresorhus/got#proxies
const got = require('got');
const tunnel = require('tunnel');

/* Proxy env variables */
process.env.NO_PROXY = 'https://noproxy.com'
process.env.HTTPS_PROXY = 'https://proxy.mgdis.fr'

/* Indigestible code part to create the method for tunneling*/
const method = ...; //httpOverHttp or httpsOverHttp or httpOverHttps or httpsOverHttps
let agent;
switch (method) {
  case 'httpOverHttp': 
    agent = tunnel.httpOverHttp({
      proxy: {
        host: 'proxy.mgdis.fr'
      });
    break:
  ...
}
/* ------------------------------------------------------- */

const response = await got('https://www/mgdis.fr/resource/1', { agent });

You can do:

const golGot = require('gol-got');

/* Proxy env variables*/
process.env.NO_PROXY = 'https://noproxy.com'
process.env.HTTPS_PROXY = 'https://proxy.mgdis.fr'

// Prepare a Got instance
const got = golGot('https://www/mgdis.fr/resource/1');

// Use Got as usual
const response = await got('https://www/mgdis.fr/resource/1');

Why use gol-got

got actually does not manage proxy environment variables : see this issue.
If you use got in many projets that have to manage proxy environment variables, you probably don't want to write the same code routine all the time.

API

Same as got.

Clarification

• The tunnel agent used is tunnel-agent included in the popular request http calls library.
• proxy-from-env is used to get the proxy URL for the given URL based on standard proxies environment variables.

License

MIT © MGDIS