Class: Builder

Constructor

new Builder(exe)

Parameters:

Name	Type	Description
`exe`	string	Path to the executable to use. This executable must accept the `--port` flag for defining the port to start the server on.

Source: remote/index.js, line 315

Throws:

If the provided executable path does not exist.
Type Error

Methods

addArguments(…var_args) → (non-null) {THIS}

Define additional command line arguments to use when starting the server.

This:

{THIS}

Parameters:

Name	Type	Attributes	Description
`var_args`	CommandLineFlag	<repeatable>	The arguments to include.

Source: remote/index.js, line 342

Returns:

A self reference.

Type:: THIS

build() → (non-null) {DriverService}

Creates a new DriverService using this instance's current configuration.

Source: remote/index.js, line 437

Returns:

A new driver service.

Type:: DriverService

setEnvironment(env) → (non-null) {DriverService.Builder}

Defines the environment to start the server under. This setting will be inherited by every browser session started by the server. By default, the server will inherit the enviroment of the current process.

Parameters:

Name	Type	Description
`env`	Map.<string, string> \| Object.<string, string> \| null	The desired environment to use, or `null` if the server should inherit the current environment.

Source: remote/index.js, line 409

Returns:

A self reference.

Type:: DriverService.Builder

setHostname(hostname) → (non-null) {DriverService.Builder}

Sets the host name to access the server on. If specified, the loopback setting will be ignored.

Parameters:

Name	Type	Description
`hostname`	string

Source: remote/index.js, line 354

Returns:

A self reference.

Type:: DriverService.Builder

setLoopback(loopback) → (non-null) {DriverService.Builder}

Sets whether the service should be accessed at this host's loopback address.

Parameters:

Name	Type	Description
`loopback`	boolean

Source: remote/index.js, line 366

Returns:

A self reference.

Type:: DriverService.Builder

setPath(basePathnullable) → (non-null) {DriverService.Builder}

Sets the base path for WebDriver REST commands (e.g. "/wd/hub"). By default, the driver will accept commands relative to "/".

Parameters:

Name	Type	Attributes	Description
`basePath`	string	<nullable>	The base path to use, or `null` to use the default.

Source: remote/index.js, line 379

Returns:

A self reference.

Type:: DriverService.Builder

setPort(port) → (non-null) {DriverService.Builder}

Sets the port to start the server on.

Parameters:

Name	Type	Description
`port`	number	The port to use, or 0 for any free port.

Source: remote/index.js, line 391

Throws:

If an invalid port is specified.
Type Error

Returns:

A self reference.

Type:: DriverService.Builder

setStdio(config) → (non-null) {DriverService.Builder}

IO configuration for the spawned server process. For more information, refer to the documentation of child_process.spawn.

Parameters:

Name	Type	Description
`config`	StdIoOptions	The desired IO configuration.

Source: remote/index.js, line 427
See: https://nodejs.org/dist/latest-v4.x/docs/api/child_process.html#child_process_options_stdio

Returns:

A self reference.

Type:: DriverService.Builder