digdug/BrowserStackTunnel
Inheritance
- digdug/BrowserStackTunnel
- module:digdug/Tunnel
- Object
new (require("digdug/BrowserStackTunnel"))()
All Properties
| Property | Defined by |
|---|---|
|
accessKey: string
The BrowserStack access key. |
digdug/BrowserStackTunnel |
|
architecture: string
The architecture the tunnel will run against. |
digdug/Tunnel |
|
auth: string
An HTTP authorization string to use when initiating connections to the tunnel. |
digdug/Tunnel |
|
automateOnly: boolean
Whether or not to start the tunnel with only WebDriver support. |
digdug/BrowserStackTunnel |
|
clientUrl: string
(readonly)
The URL that a WebDriver client should used to interact with this service. |
digdug/Tunnel |
|
directory: string
The directory where the tunnel software will be extracted. |
digdug/Tunnel |
|
The URL of a service that provides a list of environments supported by BrowserStack. |
digdug/BrowserStackTunnel |
|
executable: string
The executable to spawn in order to create a tunnel. |
digdug/Tunnel |
|
extraCapabilities: string
(readonly)
A map of additional capabilities that need to be sent to the provider when a new session is being created. |
digdug/Tunnel |
|
forceLocal: boolean
If true, route all traffic via the local machine. |
digdug/BrowserStackTunnel |
|
hostname: string
The host on which a WebDriver client can access the service provided by the tunnel. |
digdug/Tunnel |
|
isDownloaded: string
(readonly)
Whether or not the tunnel software has already been downloaded. |
digdug/Tunnel |
|
isRunning: boolean
(readonly)
Whether or not the tunnel is currently running. |
digdug/Tunnel |
|
isStarting: boolean
(readonly)
Whether or not the tunnel is currently starting up. |
digdug/Tunnel |
|
isStopping: boolean
(readonly)
Whether or not the tunnel is currently stopping. |
digdug/Tunnel |
|
killOtherTunnels: boolean
If true, any other tunnels running on the account will be killed when the tunnel is started. |
digdug/BrowserStackTunnel |
|
pathname: string
The path that a WebDriver client should use to access the service provided by the tunnel. |
digdug/Tunnel |
|
platform: string
The operating system the tunnel will run on. |
digdug/Tunnel |
|
port: number
The local port where the WebDriver server should be exposed by the tunnel. |
digdug/Tunnel |
|
protocol: string
The protocol (e.g., 'http') that a WebDriver client should use to access the service provided by the tunnel. |
digdug/Tunnel |
|
proxy: string
The URL of a proxy server for the tunnel to go through. |
digdug/Tunnel |
|
servers: Array.<string>
A list of server URLs that should be proxied by the tunnel. |
digdug/BrowserStackTunnel |
|
skipServerValidation: boolean
Skip verification that the proxied servers are online and responding at the time the tunnel starts. |
digdug/BrowserStackTunnel |
|
tunnelId: string
A unique identifier for the newly created tunnel. |
digdug/Tunnel |
|
url: string
The URL where the tunnel software can be downloaded. |
digdug/Tunnel |
|
username: string
The BrowserStack username. |
digdug/BrowserStackTunnel |
|
verbose: boolean
Whether or not to tell the tunnel to provide verbose logging output. |
digdug/Tunnel |
All Methods
| Method | Defined by |
|---|---|
|
(protected)
Creates the list of command-line arguments to be passed to the spawned tunnel. |
digdug/Tunnel |
|
(protected)
Creates a newly spawned child process for the tunnel software. |
digdug/Tunnel |
|
(protected)
Creates the set of options to use when spawning the tunnel process. |
digdug/Tunnel |
|
Called with the response after a file download has completed |
digdug/Tunnel |
|
(protected)
This method provides the implementation that actually starts the tunnel and any other logic for emitting events on the Tunnel based on data passed by the tunnel software. |
digdug/Tunnel |
|
(protected)
This method provides the implementation that actually stops the tunnel. |
digdug/Tunnel |
|
Downloads and extracts the tunnel software if it is not already downloaded. |
digdug/Tunnel |
|
Get a list of environments available on the service. |
digdug/Tunnel |
|
Sends information about a job to the tunnel provider. |
digdug/Tunnel |
|
Starts the tunnel, automatically downloading dependencies if necessary. |
digdug/Tunnel |
|
Stops the tunnel. |
digdug/Tunnel |
All Events
| Event | Defined by |
|---|---|
|
Part of the tunnel has been downloaded from the server. |
digdug/Tunnel |
|
Information about the status of the tunnel setup process that is suitable for presentation to end-users. |
digdug/Tunnel |
|
A chunk of raw string data output by the tunnel software to stderr. |
digdug/Tunnel |
|
A chunk of raw string data output by the tunnel software to stdout. |
digdug/Tunnel |
Properties
accessKey: string
The BrowserStack access key. This will be initialized with the value of the BROWSERSTACK_ACCESS_KEY
environment variable.
Defaults to
'the value of the BROWSERSTACK_ACCESS_KEY environment variable'
Source
automateOnly: boolean
Whether or not to start the tunnel with only WebDriver support. Setting this value to false is not
supported.
Defaults to
true
Source
environmentUrl
The URL of a service that provides a list of environments supported by BrowserStack.
Source
forceLocal: boolean
If true, route all traffic via the local machine.
Defaults to
false
Source
killOtherTunnels: boolean
If true, any other tunnels running on the account will be killed when the tunnel is started.
Defaults to
false
Source
servers: Array.<string>
A list of server URLs that should be proxied by the tunnel. Only the hostname, port, and protocol are used.
Source
skipServerValidation: boolean
Skip verification that the proxied servers are online and responding at the time the tunnel starts.
Defaults to
true
Source
username: string
The BrowserStack username. This will be initialized with the value of the BROWSERSTACK_USERNAME
environment variable.
Defaults to
'the value of the BROWSERSTACK_USERNAME environment variable'