Class: Capabilities

Constructor

new Capabilities(otheropt)

Parameters:

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

Source: lib/capabilities.js, line 234

Members

size

Source: lib/capabilities.js, line 250

Methods

delete(key)

Deletes an entry from this set of capabilities.

Parameters:

Name	Type	Description
`key`	string	the capability key to delete.

Source: lib/capabilities.js, line 353

get(key) → {T}

Parameters:

Name	Type	Description
`key`	string	the parameter key to get.

Source: lib/capabilities.js, line 304

Returns:

the stored parameter value.

Type:: T

getAcceptInsecureCerts() → {boolean}

Source: lib/capabilities.js, line 386

Returns:

whether the session is configured to accept insecure TLS certificates.

Type:: boolean

getAlertBehavior() → {UserPromptHandler|undefined}

Source: lib/capabilities.js, line 509

Returns:

the behavior pattern for responding to unhandled user prompts, or undefined if not set.

Type:: UserPromptHandler | undefined

getBrowserName() → {string|undefined}

Source: lib/capabilities.js, line 404

Returns:

the configured browser name, or undefined if not set.

Type:: string | undefined

getBrowserVersion() → {string|undefined}

Source: lib/capabilities.js, line 422

Returns:

the configured browser version, or undefined if not set.

Type:: string | undefined

getPageLoadStrategy() → {string|undefined}

Returns the configured page load strategy.

Source: lib/capabilities.js, line 441

Returns:

the page load strategy.

Type:: string | undefined

getPlatform() → {string|undefined}

Source: lib/capabilities.js, line 459

Returns:

the configured platform or undefined if not set.

Type:: string | undefined

getProxy() → {proxy.Config|undefined}

Source: lib/capabilities.js, line 488

Returns:

the configured proxy settings, or undefined if not set.

Type:: proxy.Config | undefined

has(key) → {boolean}

Parameters:

Name	Type	Description
`key`	string	the key to test.

Source: lib/capabilities.js, line 312

Returns:

whether this capability set has the specified key.

Type:: boolean

keys() → (non-null) {Iterator.<string>}

Source: lib/capabilities.js, line 319

Returns:

an iterator of the keys set.

Type:: Iterator.<string>

merge(othernon-null) → (non-null) {Capabilities}

Merges another set of capabilities into this instance.

Parameters:

Name	Type	Description
`other`	Capabilities \| Map.<String, ?> \| Object.<string, ?>	The other set of capabilities to merge.

Source: lib/capabilities.js, line 329

Returns:

A self reference.

Type:: Capabilities

set(key, value) → (non-null) {Capabilities}

Parameters:

Name	Type	Description
`key`	string	The capability key.
`value`	*	The capability value.

Source: lib/capabilities.js, line 363

Throws:

If the key is not a string.
Type TypeError

Returns:

A self reference.

Type:: Capabilities

setAcceptInsecureCerts(accept) → (non-null) {Capabilities}

Sets whether a WebDriver session should implicitly accept self-signed, or other untrusted TLS certificates on navigation.

Parameters:

Name	Type	Description
`accept`	boolean	whether to accept insecure certs.

Source: lib/capabilities.js, line 378

Returns:

a self reference.

Type:: Capabilities

setAlertBehavior(behaviornullable) → (non-null) {Capabilities}

Sets the default action to take with an unexpected alert before returning an error. If unspecified, WebDriver will default to UserPromptHandler.DISMISS_AND_NOTIFY.

Parameters:

Name	Type	Attributes	Description
`behavior`	UserPromptHandler	<nullable>	The way WebDriver should respond to unhandled user prompts.

Source: lib/capabilities.js, line 501

Returns:

A self reference.

Type:: Capabilities

setBrowserName(name) → (non-null) {Capabilities}

Sets the name of the target browser.

Parameters:

Name	Type	Description
`name`	Browser \| string	the browser name.

Source: lib/capabilities.js, line 396

Returns:

a self reference.

Type:: Capabilities

setBrowserVersion(version) → (non-null) {Capabilities}

Sets the desired version of the target browser.

Parameters:

Name	Type	Description
`version`	string	the desired version.

Source: lib/capabilities.js, line 414

Returns:

a self reference.

Type:: Capabilities

setLoggingPrefs(prefs) → (non-null) {Capabilities}

Sets the logging preferences. Preferences may be specified as a ./logging.Preferences instance, or as a map of log-type to log-level.

Parameters:

Name	Type	Description
`prefs`

Source: lib/capabilities.js, line 471

Returns:

A self reference.

Type:: Capabilities

setPageLoadStrategy(strategy) → (non-null) {Capabilities}

Sets the desired page loading strategy for a new WebDriver session.

Parameters:

Name	Type	Description
`strategy`	PageLoadStrategy	the desired strategy.

Source: lib/capabilities.js, line 432

Returns:

a self reference.

Type:: Capabilities

setPlatform(platform) → (non-null) {Capabilities}

Sets the target platform.

Parameters:

Name	Type	Description
`platform`	Platform \| string	the target platform.

Source: lib/capabilities.js, line 451

Returns:

a self reference.

Type:: Capabilities

setProxy(proxy) → (non-null) {Capabilities}

Sets the proxy configuration for this instance.

Parameters:

Name	Type	Description
`proxy`	proxy.Config	The desired proxy configuration.

Source: lib/capabilities.js, line 480

Returns:

A self reference.

Type:: Capabilities

setStrictFileInteractability()

Sets the boolean flag configuration for this instance.

Source: lib/capabilities.js, line 516

(static) chrome() → (non-null) {Capabilities}

Source: lib/capabilities.js, line 257

Returns:

A basic set of capabilities for Chrome.

Type:: Capabilities

(static) edge() → (non-null) {Capabilities}

Source: lib/capabilities.js, line 264

Returns:

A basic set of capabilities for Microsoft Edge.

Type:: Capabilities

(static) firefox() → (non-null) {Capabilities}

Source: lib/capabilities.js, line 271

Returns:

A basic set of capabilities for Firefox.

Type:: Capabilities

(static) ie() → (non-null) {Capabilities}

Source: lib/capabilities.js, line 278

Returns:

A basic set of capabilities for Internet Explorer.

Type:: Capabilities

(static) safari() → (non-null) {Capabilities}

Source: lib/capabilities.js, line 285

Returns:

A basic set of capabilities for Safari.

Type:: Capabilities