Dig Dug docs: Module: digdug/NullTunnel

Inheritance

digdug/NullTunnel
module:digdug/Tunnel
Object

new (require("digdug/NullTunnel"))()

A no-op tunnel.

Source

NullTunnel.js, line 13

Property	Defined by
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
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
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
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
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
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
verbose: boolean Whether or not to tell the tunnel to provide verbose logging output.	digdug/Tunnel

Method	Defined by
_makeArgs(): Array.<string> (protected) Creates the list of command-line arguments to be passed to the spawned tunnel.	digdug/Tunnel
_makeChild(): Object (protected) Creates a newly spawned child process for the tunnel software.	digdug/Tunnel
_makeOptions(): Object (protected) Creates the set of options to use when spawning the tunnel process.	digdug/Tunnel
_normalizeEnvironment(environment) (protected) Normalizes a specific Tunnel environment descriptor to a general form.	digdug/Tunnel
_postDownloadFile() Called with the response after a file download has completed	digdug/Tunnel
_start(): Object (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
_stop(): Promise.<void> (protected) This method provides the implementation that actually stops the tunnel.	digdug/Tunnel
download(forceDownload: boolean): Promise.<void> Downloads and extracts the tunnel software if it is not already downloaded.	digdug/Tunnel
getEnvironments() Get a list of environments available on the service.	digdug/Tunnel
sendJobState(jobId: string, data: JobState): Promise.<void> Sends information about a job to the tunnel provider.	digdug/Tunnel
start(): Promise.<void> Starts the tunnel, automatically downloading dependencies if necessary.	digdug/Tunnel
stop(): Promise.<integer> Stops the tunnel.	digdug/Tunnel

Event	Defined by
downloadprogress Part of the tunnel has been downloaded from the server.	digdug/Tunnel
status Information about the status of the tunnel setup process that is suitable for presentation to end-users.	digdug/Tunnel
stderr A chunk of raw string data output by the tunnel software to stderr.	digdug/Tunnel
stdout A chunk of raw string data output by the tunnel software to stdout.	digdug/Tunnel