Node http.setGlobalProxyFromEnv function | API Reference

): () => void;

Dynamically resets the global configurations to enable built-in proxy support for fetch() and http.request()/https.request() at runtime, as an alternative to using the --use-env-proxy flag or NODE_USE_ENV_PROXY environment variable. It can also be used to override settings configured from the environment variables.

As this function resets the global configurations, any previously configured http.globalAgent, https.globalAgent or undici global dispatcher would be overridden after this function is invoked. It's recommended to invoke it before any requests are made and avoid invoking it in the middle of any requests.

See Built-in Proxy Support for details on proxy URL formats and NO_PROXY syntax.

@param proxyEnv

An object containing proxy configuration. This accepts the same options as the proxyEnv option accepted by Agent. Default: process.env.

@returns

A function that restores the original agent and dispatcher settings to the state before this http.setGlobalProxyFromEnv() is invoked.

Referenced types

interface ProxyEnv

http_proxy?: string
HTTP_PROXY?: string
https_proxy?: string
HTTPS_PROXY?: string
no_proxy?: string
NO_PROXY?: string
NODE_ENV?: string
TZ?: string
Can be used to change the default timezone at runtime