System Proxy
This library support
- Reading proxy settings from the
HTTP_PROXY
or HTTPS_PROXY
environment variables - Reading proxy settings from the
HTTP_PROXY
or HTTPS_PROXY
node configuration - Retrieveing the settings from the the ioternet settings on windows in the registry
- Validating the connection and asking for credentials if needed
Install
npm install --save get-proxy-settings
Usage
Import
import { getProxySettings, getAndTestProxySettings } from "get-proxy-settings";
const { getProxySettings, getAndTestProxySettings } = require("get-proxy-settings");
Use
async function basic() {
const proxy = await getProxySettings();
console.log("proxy", proxy.http, proxy.https);
}
async function withValidation() {
async function login() {
return {username: "abc", password: "123"}
}
const proxy = await getAndTestProxySettings(login);
console.log("proxy", proxy.http, proxy.https);
}
Config
Update the test url(Which url is used to validate the proxy)
import { defaults } from "get-proxy-settings";
defaults.testUrl = "https://example.com";
Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct.
For more information see the Code of Conduct FAQ or
contact opencode@microsoft.com with any additional questions or comments.