Class: thenableWebDriverProxy

new thenableWebDriverProxy(sessionnon-null, …rest)

Parameters:

Name	Type	Attributes	Description
`session`	IThenable.<!Session>
`rest`	?	<repeatable>

Implements: ThenableWebDriver
Source: index.js, line 133

Extends

WebDriver

Members

catch

Source: index.js, line 149

then

Source: index.js, line 146

Methods

(async) addCredential(credential)

Injects a credential into the authenticator.

Parameters:

Name	Type	Description
`credential`		Credential to be added

Overrides: WebDriver#addCredential
Source: lib/webdriver.js, line 1638

(async) addVirtualAuthenticator(options)

Adds a virtual authenticator with the given options.

Parameters:

Name	Type	Description
`options`		VirtualAuthenticatorOptions object to set authenticator options.

Overrides: WebDriver#addVirtualAuthenticator
Source: lib/webdriver.js, line 1614

(async) createCDPConnection() → (non-null) {Promise.<resolved>}

Creates a new WebSocket connection.

Overrides: WebDriver#createCDPConnection
Source: lib/webdriver.js, line 1241

Returns:

A new CDP instance.

Type:: Promise.<resolved>

(async) fireSessionEvent(eventType, payloadopt) → (non-null) {Promise.<Object>}

Fires a custom session event to the remote server event bus.

This allows test code to trigger server-side utilities that subscribe to the event bus.

Parameters:

Name	Type	Attributes	Default	Description
`eventType`	string			The type of event (e.g., "test:failed", "log:collect").
`payload`	Object	<optional>	null	Optional data to include with the event.

Overrides: WebDriver#fireSessionEvent
Source: lib/webdriver.js, line 1769

Returns:

A promise that resolves to the response containing success status, event type, and timestamp.

Type:: Promise.<Object>

Examples

// Fire a simple event
await driver.fireSessionEvent('test:started');

// Fire an event with payload
await driver.fireSessionEvent('test:failed', {
  testName: 'LoginTest',
  error: 'Element not found'
});

(async) getBidi() → {BIDI}

Initiates bidi connection using 'webSocketUrl'

Overrides: WebDriver#getBidi
Source: lib/webdriver.js, line 1308

Returns:

Type:: BIDI

(async) getCredentials()

Overrides: WebDriver#getCredentials
Source: lib/webdriver.js, line 1648

Returns:

The list of credentials owned by the authenticator.

(async) getWsUrl(debuggerAddress, target, caps) → {string}

Retrieves 'webSocketDebuggerUrl' by sending a http request using debugger address

Parameters:

Name	Type	Description
`debuggerAddress`	string
`target`
`caps`

Overrides: WebDriver#getWsUrl
Source: lib/webdriver.js, line 1324

Returns:

Returns parsed webSocketDebuggerUrl obtained from the http request

Type:: string

(async) logMutationEvents(connection, callback) → {Promise.<void>}

Parameters:

Name	Type	Description
`connection`
`callback`

Overrides: WebDriver#logMutationEvents
Source: lib/webdriver.js, line 1493

Returns:

Type:: Promise.<void>

(async) normalize_(webElementPromisenon-null) → (non-null) {Promise.<!WebElement>}

Parameters:

Name	Type	Description
`webElementPromise`	function	The webElement in unresolved state

Overrides: WebDriver#normalize_
Source: lib/webdriver.js, line 1029

Returns:

First single WebElement from array of resolved promises

Type:: Promise.<!WebElement>

(async) onIntercept(connection, httpResponse, callback)

Handle Network interception requests

Parameters:

Name	Type	Description
`connection`		WebSocket connection to the browser
`httpResponse`		Object representing what we are intercepting as well as what should be returned.
`callback`		callback called when we intercept requests.

Overrides: WebDriver#onIntercept
Source: lib/webdriver.js, line 1398

(async) onLogEvent(connection, callback) → {Promise.<void>}

Parameters:

Name	Type	Description
`connection`
`callback`

Overrides: WebDriver#onLogEvent
Source: lib/webdriver.js, line 1435

Returns:

Type:: Promise.<void>

(async) onLogException(connection, callback) → {Promise.<void>}

Parameters:

Name	Type	Description
`connection`
`callback`

Overrides: WebDriver#onLogException
Source: lib/webdriver.js, line 1470

Returns:

Type:: Promise.<void>

(async) register(username, password, connection)

Sets a listener for Fetch.authRequired event from CDP If event is triggered, it enters username and password and allows the test to move forward

Parameters:

Name	Type	Description
`username`	string
`password`	string
`connection`		CDP Connection

Overrides: WebDriver#register
Source: lib/webdriver.js, line 1361

(async) removeAllCredentials()

Removes all the credentials from the authenticator.

Overrides: WebDriver#removeAllCredentials
Source: lib/webdriver.js, line 1679

(async) removeCredential(credential_id)

Removes a credential from the authenticator.

Parameters:

Name	Type	Description
`credential_id`		The ID of the credential to be removed.

Overrides: WebDriver#removeCredential
Source: lib/webdriver.js, line 1663

(async) removeVirtualAuthenticator()

Removes a previously added virtual authenticator. The authenticator is no longer valid after removal, so no methods may be called.

Overrides: WebDriver#removeVirtualAuthenticator
Source: lib/webdriver.js, line 1624

(async) setUserVerified(verified)

Sets whether the authenticator will simulate success or fail on user verification.

Parameters:

Name	Type	Description
`verified`		true if the authenticator will pass user verification, false otherwise.

Overrides: WebDriver#setUserVerified
Source: lib/webdriver.js, line 1689

virtualAuthenticatorId()

Overrides: WebDriver#virtualAuthenticatorId
Source: lib/webdriver.js, line 1606

Returns:

The value of authenticator ID added