Class: Options

Constructor

new Options(otheropt)

Parameters:

Name	Type	Attributes	Description
`other`	Capabilities \| Map.<string, ?> \| Object	<optional>	Another set of capabilities to initialize this instance from.

Source: firefox.js, line 241

Methods

addArguments(…args) → (non-null) {Options}

Specify additional command line arguments that should be used when starting the Firefox browser.

Parameters:

Name	Type	Attributes	Description
`args`	string \| !Array.<string>	<repeatable>	The arguments to include.

Source: firefox.js, line 286

Returns:

A self reference.

Type:: Options

addExtensions(…paths) → (non-null) {Options}

Add extensions that should be installed when starting Firefox.

Parameters:

Name	Type	Attributes	Description
`paths`	string	<repeatable>	The paths to the extension XPI files to install.

Source: firefox.js, line 320

Returns:

A self reference.

Type:: Options

enableBidi() → (non-null) {Capabilities}

Enable bidi connection

Source: firefox.js, line 406

Returns:

Type:: Capabilities

enableDebugger()

Enables moz:debuggerAddress for firefox cdp

Source: firefox.js, line 398

enableMobile(androidPackage) → (non-null) {Options}

Enables Mobile start up features

Parameters:

Name	Type	Default	Description
`androidPackage`	string	org.mozilla.firefox	The package to use

Source: firefox.js, line 383

Returns:

A self reference

Type:: Options

setBinary(binary) → (non-null) {Options}

Sets the binary to use. The binary may be specified as the path to a Firefox executable.

Parameters:

Name	Type	Description
`binary`	string	The binary to use.

Source: firefox.js, line 369

Throws:

If binary is an invalid type.
Type TypeError

Returns:

A self reference.

Type:: Options

setPreference(key, value) → (non-null) {Options}

Parameters:

Name	Type	Description
`key`	string	the preference key.
`value`	string \| number \| boolean	the preference value.

Source: firefox.js, line 331

Throws:

if either the key or value has an invalid type.
Type TypeError

Returns:

A self reference.

Type:: Options

setProfile(profile) → (non-null) {Options}

Sets the path to an existing profile to use as a template for new browser sessions. This profile will be copied for each new session - changes will not be applied to the profile itself.

Parameters:

Name	Type	Description
`profile`	string	The profile to use.

Source: firefox.js, line 353

Throws:

if profile is not a string.
Type TypeError

Returns:

A self reference.

Type:: Options

windowSize(size) → (non-null) {Options}

Sets the initial window size

Parameters:

Name	Type	Description
`size`	Object	The desired window size.

Source: firefox.js, line 302

Throws:

if width or height is unspecified, not a number, or less than or equal to 0.
Type TypeError

Returns:

A self reference.

Type:: Options