UNPKG

662 BTypeScriptView Raw
1/**
2 * Initializes a third-party proxy module for HTTP(S) requests. Call this function before
3 * using the {@link download} and {@link downloadArtifact} APIs if you need proxy support.
4 *
5 * If the `ELECTRON_GET_USE_PROXY` environment variable is set to `true`, this function will be
6 * called automatically for `@electron/get` requests.
7 *
8 * @category Utility
9 * @see {@link https://github.com/gajus/global-agent?tab=readme-ov-file#environment-variables | `global-agent`}
10 * documentation for available environment variables.
11 *
12 * @example
13 * ```sh
14 * export GLOBAL_AGENT_HTTPS_PROXY="$HTTPS_PROXY"
15 * ```
16 */
17export declare function initializeProxy(): void;