Skip to content
This repository has been archived by the owner on Jul 29, 2024. It is now read-only.

chore(config): Update docs regarding proxies #5048

Merged
merged 1 commit into from
Dec 19, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions lib/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -99,14 +99,15 @@ export interface Config {
*/
seleniumSessionId?: string;
/**
* The address of a proxy server to use for communicating to Sauce Labs rest APIs via the
* The address of a proxy server to use for communicating to Sauce Labs REST APIs via the
* saucelabs node module. For example, the Sauce Labs Proxy can be setup with: sauceProxy:
* 'http://localhost:3128'
*/
sauceProxy?: string;

/**
* The proxy address that browser traffic will go through which is tied to the browser session.
* The proxy address that WebDriver (e.g. Selenium commands) traffic will go through
* which is tied to the browser session.
*/
webDriverProxy?: string;

Expand Down Expand Up @@ -136,13 +137,13 @@ export interface Config {
*/
sauceKey?: string;
/**
* Use sauceAgent if you need custom HTTP agent to connect to saucelabs.com.
* Use sauceAgent if you need custom HTTP agent to connect to saucelabs.com APIs.
* This is needed if your computer is behind a corporate proxy.
*
* To match sauce agent implementation, use
* [HttpProxyAgent](https://github.com/TooTallNate/node-http-proxy-agent)
* to generate the agent or use webDriverProxy as an alternative. If a
* webDriverProxy is provided, the sauceAgent will be overridden.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. I remember trying to set it all to webDriverProxy at one point 3 years ago...

* to generate the agent or use sauceProxy as an alternative. If a
* sauceProxy is provided, the sauceAgent will be overridden.
*/
sauceAgent?: any;
/**
Expand Down