webdriver

webdriver

Version 9.27.2
Published 4 days ago
409 kB
11 dependencies
MIT license

Install

npm i webdriver

yarn add webdriver

pnpm add webdriver

Overview

A Node.js bindings implementation for the W3C WebDriver and Mobile JSONWire Protocol

Index

Variables

variable APPIUM_MASKING_HEADER

const APPIUM_MASKING_HEADER: { 'x-appium-is-sensitive': string };

variable BASE_64_REGEX

const BASE_64_REGEX: RegExp;

variable BASE_64_SAFE_STRING_TO_PROCESS_LENGTH

const BASE_64_SAFE_STRING_TO_PROCESS_LENGTH: number;

variable DEFAULTS

const DEFAULTS: Options.Definition<Required<any>>;

variable ELEMENT_KEY

const ELEMENT_KEY: string;

variable SHADOW_ELEMENT_KEY

const SHADOW_ELEMENT_KEY: string;

Functions

function command

command: (
    method: string,
    endpointUri: string,
    commandInfo: CommandEndpoint,
    doubleEncodeVariables?: boolean
) => (
    this: BaseClient,
    ...unmaskedArgs: unknown[]
) => Promise<WebDriverResponse | BidiResponses | void>;

function getEnvironmentVars

getEnvironmentVars: ({
    isW3C,
    isMobile,
    isIOS,
    isAndroid,
    isFirefox,
    isSauce,
    isSeleniumStandalone,
    isChromium,
    isWindowsApp,
    isMacApp,
}: Partial<SessionFlags>) => PropertyDescriptorMap;

return all supported flags and return them in a format so we can attach them to the instance protocol
Parameter options
driver instance or option object containing these flags {Object} prototype object

function getPrototype

getPrototype: ({
    isW3C,
    isChromium,
    isFirefox,
    isMobile,
    isSauce,
    isSeleniumStandalone,
}: Partial<SessionFlags>) => Record<string, PropertyDescriptor>;

creates the base prototype for the webdriver monad

function initiateBidi

initiateBidi: (
    socketUrl: string,
    strictSSL?: boolean,
    userHeaders?: Record<string, string>
) => PropertyDescriptorMap;

Enhance the monad with WebDriver Bidi primitives if a connection can be established successfully
Parameter socketUrl
url to bidi interface
Parameter strictSSL
Parameter userHeaders
Returns
prototype with interface for bidi primitives

function parseBidiMessage

parseBidiMessage: (this: EventEmitter, data: ArrayBuffer) => void;

Classes

class BidiHandler

class BidiHandler extends BidiCore {}

method browserClose

browserClose: (params: remote.EmptyParams) => Promise<local.BrowserCloseResult>;

WebDriver Bidi command to send command method "browser.close" with parameters. https://w3c.github.io/webdriver-bidi/#command-browser-close
Parameter params
remote.EmptyParams command parameter
Returns
Promise<local.BrowserCloseResult>

method browserCreateUserContext

browserCreateUserContext: (
    params: remote.BrowserCreateUserContextParameters
) => Promise<local.BrowserCreateUserContextResult>;

WebDriver Bidi command to send command method "browser.createUserContext" with parameters. https://w3c.github.io/webdriver-bidi/#command-browser-createUserContext
Parameter params
remote.BrowserCreateUserContextParameters command parameter
Returns
Promise<local.BrowserCreateUserContextResult>

method browserGetClientWindows

browserGetClientWindows: (
    params: remote.EmptyParams
) => Promise<local.BrowserGetClientWindowsResult>;

WebDriver Bidi command to send command method "browser.getClientWindows" with parameters. https://w3c.github.io/webdriver-bidi/#command-browser-getClientWindows
Parameter params
remote.EmptyParams command parameter
Returns
Promise<local.BrowserGetClientWindowsResult>

method browserGetUserContexts

browserGetUserContexts: (
    params: remote.EmptyParams
) => Promise<local.BrowserGetUserContextsResult>;

WebDriver Bidi command to send command method "browser.getUserContexts" with parameters. https://w3c.github.io/webdriver-bidi/#command-browser-getUserContexts
Parameter params
remote.EmptyParams command parameter
Returns
Promise<local.BrowserGetUserContextsResult>

method browserRemoveUserContext

browserRemoveUserContext: (
    params: remote.BrowserRemoveUserContextParameters
) => Promise<local.BrowserRemoveUserContextResult>;

WebDriver Bidi command to send command method "browser.removeUserContext" with parameters. https://w3c.github.io/webdriver-bidi/#command-browser-removeUserContext
Parameter params
remote.BrowserRemoveUserContextParameters command parameter
Returns
Promise<local.BrowserRemoveUserContextResult>

method browserSetClientWindowState

browserSetClientWindowState: (
    params: remote.BrowserSetClientWindowStateParameters
) => Promise<local.BrowserSetClientWindowStateResult>;

WebDriver Bidi command to send command method "browser.setClientWindowState" with parameters. https://w3c.github.io/webdriver-bidi/#command-browser-setClientWindowState
Parameter params
remote.BrowserSetClientWindowStateParameters command parameter
Returns
Promise<local.BrowserSetClientWindowStateResult>

method browserSetDownloadBehavior

browserSetDownloadBehavior: (
    params: remote.BrowserSetDownloadBehaviorParameters
) => Promise<local.BrowserSetDownloadBehaviorResult>;

WebDriver Bidi command to send command method "browser.setDownloadBehavior" with parameters. https://w3c.github.io/webdriver-bidi/#command-browser-setDownloadBehavior
Parameter params
remote.BrowserSetDownloadBehaviorParameters command parameter
Returns
Promise<local.BrowserSetDownloadBehaviorResult>

method browsingContextActivate

browsingContextActivate: (
    params: remote.BrowsingContextActivateParameters
) => Promise<local.BrowsingContextActivateResult>;

WebDriver Bidi command to send command method "browsingContext.activate" with parameters. https://w3c.github.io/webdriver-bidi/#command-browsingContext-activate
Parameter params
remote.BrowsingContextActivateParameters command parameter
Returns
Promise<local.BrowsingContextActivateResult>

method browsingContextCaptureScreenshot

browsingContextCaptureScreenshot: (
    params: remote.BrowsingContextCaptureScreenshotParameters
) => Promise<local.BrowsingContextCaptureScreenshotResult>;

WebDriver Bidi command to send command method "browsingContext.captureScreenshot" with parameters. https://w3c.github.io/webdriver-bidi/#command-browsingContext-captureScreenshot
Parameter params
remote.BrowsingContextCaptureScreenshotParameters command parameter
Returns
Promise<local.BrowsingContextCaptureScreenshotResult>

method browsingContextClose

browsingContextClose: (
    params: remote.BrowsingContextCloseParameters
) => Promise<local.BrowsingContextCloseResult>;

WebDriver Bidi command to send command method "browsingContext.close" with parameters. https://w3c.github.io/webdriver-bidi/#command-browsingContext-close
Parameter params
remote.BrowsingContextCloseParameters command parameter
Returns
Promise<local.BrowsingContextCloseResult>

method browsingContextCreate

browsingContextCreate: (
    params: remote.BrowsingContextCreateParameters
) => Promise<local.BrowsingContextCreateResult>;

WebDriver Bidi command to send command method "browsingContext.create" with parameters. https://w3c.github.io/webdriver-bidi/#command-browsingContext-create
Parameter params
remote.BrowsingContextCreateParameters command parameter
Returns
Promise<local.BrowsingContextCreateResult>

method browsingContextGetTree

browsingContextGetTree: (
    params: remote.BrowsingContextGetTreeParameters
) => Promise<local.BrowsingContextGetTreeResult>;

WebDriver Bidi command to send command method "browsingContext.getTree" with parameters. https://w3c.github.io/webdriver-bidi/#command-browsingContext-getTree
Parameter params
remote.BrowsingContextGetTreeParameters command parameter
Returns
Promise<local.BrowsingContextGetTreeResult>

method browsingContextHandleUserPrompt

browsingContextHandleUserPrompt: (
    params: remote.BrowsingContextHandleUserPromptParameters
) => Promise<local.BrowsingContextHandleUserPromptResult>;

WebDriver Bidi command to send command method "browsingContext.handleUserPrompt" with parameters. https://w3c.github.io/webdriver-bidi/#command-browsingContext-handleUserPrompt
Parameter params
remote.BrowsingContextHandleUserPromptParameters command parameter
Returns
Promise<local.BrowsingContextHandleUserPromptResult>

method browsingContextLocateNodes

browsingContextLocateNodes: (
    params: remote.BrowsingContextLocateNodesParameters
) => Promise<local.BrowsingContextLocateNodesResult>;

WebDriver Bidi command to send command method "browsingContext.locateNodes" with parameters. https://w3c.github.io/webdriver-bidi/#command-browsingContext-locateNodes
Parameter params
remote.BrowsingContextLocateNodesParameters command parameter
Returns
Promise<local.BrowsingContextLocateNodesResult>

method browsingContextNavigate

browsingContextNavigate: (
    params: remote.BrowsingContextNavigateParameters
) => Promise<local.BrowsingContextNavigateResult>;

WebDriver Bidi command to send command method "browsingContext.navigate" with parameters. https://w3c.github.io/webdriver-bidi/#command-browsingContext-navigate
Parameter params
remote.BrowsingContextNavigateParameters command parameter
Returns
Promise<local.BrowsingContextNavigateResult>

method browsingContextPrint

browsingContextPrint: (
    params: remote.BrowsingContextPrintParameters
) => Promise<local.BrowsingContextPrintResult>;

WebDriver Bidi command to send command method "browsingContext.print" with parameters. https://w3c.github.io/webdriver-bidi/#command-browsingContext-print
Parameter params
remote.BrowsingContextPrintParameters command parameter
Returns
Promise<local.BrowsingContextPrintResult>

method browsingContextReload

browsingContextReload: (
    params: remote.BrowsingContextReloadParameters
) => Promise<local.BrowsingContextReloadResult>;

WebDriver Bidi command to send command method "browsingContext.reload" with parameters. https://w3c.github.io/webdriver-bidi/#command-browsingContext-reload
Parameter params
remote.BrowsingContextReloadParameters command parameter
Returns
Promise<local.BrowsingContextReloadResult>

method browsingContextSetBypassCsp

browsingContextSetBypassCsp: (
    params: remote.BrowsingContextSetBypassCspParameters
) => Promise<local.BrowsingContextSetBypassCspResult>;

WebDriver Bidi command to send command method "browsingContext.setBypassCSP" with parameters. https://w3c.github.io/webdriver-bidi/#command-browsingContext-setBypassCSP
Parameter params
remote.BrowsingContextSetBypassCspParameters command parameter
Returns
Promise<local.BrowsingContextSetBypassCspResult>

method browsingContextSetViewport

browsingContextSetViewport: (
    params: remote.BrowsingContextSetViewportParameters
) => Promise<local.BrowsingContextSetViewportResult>;

WebDriver Bidi command to send command method "browsingContext.setViewport" with parameters. https://w3c.github.io/webdriver-bidi/#command-browsingContext-setViewport
Parameter params
remote.BrowsingContextSetViewportParameters command parameter
Returns
Promise<local.BrowsingContextSetViewportResult>

method browsingContextTraverseHistory

browsingContextTraverseHistory: (
    params: remote.BrowsingContextTraverseHistoryParameters
) => Promise<local.BrowsingContextTraverseHistoryResult>;

WebDriver Bidi command to send command method "browsingContext.traverseHistory" with parameters. https://w3c.github.io/webdriver-bidi/#command-browsingContext-traverseHistory
Parameter params
remote.BrowsingContextTraverseHistoryParameters command parameter
Returns
Promise<local.BrowsingContextTraverseHistoryResult>

method emulationSetForcedColorsModeThemeOverride

emulationSetForcedColorsModeThemeOverride: (
    params: remote.EmulationSetForcedColorsModeThemeOverrideParameters
) => Promise<local.EmulationSetForcedColorsModeThemeOverrideResult>;

WebDriver Bidi command to send command method "emulation.setForcedColorsModeThemeOverride" with parameters. https://w3c.github.io/webdriver-bidi/#command-emulation-setForcedColorsModeThemeOverride
Parameter params
remote.EmulationSetForcedColorsModeThemeOverrideParameters command parameter
Returns
Promise<local.EmulationSetForcedColorsModeThemeOverrideResult>

method emulationSetGeolocationOverride

emulationSetGeolocationOverride: (
    params: remote.EmulationSetGeolocationOverrideParameters
) => Promise<local.EmulationSetGeolocationOverrideResult>;

WebDriver Bidi command to send command method "emulation.setGeolocationOverride" with parameters. https://w3c.github.io/webdriver-bidi/#command-emulation-setGeolocationOverride
Parameter params
remote.EmulationSetGeolocationOverrideParameters command parameter
Returns
Promise<local.EmulationSetGeolocationOverrideResult>

method emulationSetLocaleOverride

emulationSetLocaleOverride: (
    params: remote.EmulationSetLocaleOverrideParameters
) => Promise<local.EmulationSetLocaleOverrideResult>;

WebDriver Bidi command to send command method "emulation.setLocaleOverride" with parameters. https://w3c.github.io/webdriver-bidi/#command-emulation-setLocaleOverride
Parameter params
remote.EmulationSetLocaleOverrideParameters command parameter
Returns
Promise<local.EmulationSetLocaleOverrideResult>

method emulationSetNetworkConditions

emulationSetNetworkConditions: (
    params: remote.EmulationSetNetworkConditionsParameters
) => Promise<local.EmulationSetNetworkConditionsResult>;

WebDriver Bidi command to send command method "emulation.setNetworkConditions" with parameters. https://w3c.github.io/webdriver-bidi/#command-emulation-setNetworkConditions
Parameter params
remote.EmulationSetNetworkConditionsParameters command parameter
Returns
Promise<local.EmulationSetNetworkConditionsResult>

method emulationSetScreenOrientationOverride

emulationSetScreenOrientationOverride: (
    params: remote.EmulationSetScreenOrientationOverrideParameters
) => Promise<local.EmulationSetScreenOrientationOverrideResult>;

WebDriver Bidi command to send command method "emulation.setScreenOrientationOverride" with parameters. https://w3c.github.io/webdriver-bidi/#command-emulation-setScreenOrientationOverride
Parameter params
remote.EmulationSetScreenOrientationOverrideParameters command parameter
Returns
Promise<local.EmulationSetScreenOrientationOverrideResult>

method emulationSetScreenSettingsOverride

emulationSetScreenSettingsOverride: (
    params: remote.EmulationSetScreenSettingsOverrideParameters
) => Promise<local.EmulationSetScreenSettingsOverrideResult>;

WebDriver Bidi command to send command method "emulation.setScreenSettingsOverride" with parameters. https://w3c.github.io/webdriver-bidi/#command-emulation-setScreenSettingsOverride
Parameter params
remote.EmulationSetScreenSettingsOverrideParameters command parameter
Returns
Promise<local.EmulationSetScreenSettingsOverrideResult>

method emulationSetScriptingEnabled

emulationSetScriptingEnabled: (
    params: remote.EmulationSetScriptingEnabledParameters
) => Promise<local.EmulationSetScriptingEnabledResult>;

WebDriver Bidi command to send command method "emulation.setScriptingEnabled" with parameters. https://w3c.github.io/webdriver-bidi/#command-emulation-setScriptingEnabled
Parameter params
remote.EmulationSetScriptingEnabledParameters command parameter
Returns
Promise<local.EmulationSetScriptingEnabledResult>

method emulationSetScrollbarTypeOverride

emulationSetScrollbarTypeOverride: (
    params: remote.EmulationSetScrollbarTypeOverrideParameters
) => Promise<local.EmulationSetScrollbarTypeOverrideResult>;

WebDriver Bidi command to send command method "emulation.setScrollbarTypeOverride" with parameters. https://w3c.github.io/webdriver-bidi/#command-emulation-setScrollbarTypeOverride
Parameter params
remote.EmulationSetScrollbarTypeOverrideParameters command parameter
Returns
Promise<local.EmulationSetScrollbarTypeOverrideResult>

method emulationSetTimezoneOverride

emulationSetTimezoneOverride: (
    params: remote.EmulationSetTimezoneOverrideParameters
) => Promise<local.EmulationSetTimezoneOverrideResult>;

WebDriver Bidi command to send command method "emulation.setTimezoneOverride" with parameters. https://w3c.github.io/webdriver-bidi/#command-emulation-setTimezoneOverride
Parameter params
remote.EmulationSetTimezoneOverrideParameters command parameter
Returns
Promise<local.EmulationSetTimezoneOverrideResult>

method emulationSetTouchOverride

emulationSetTouchOverride: (
    params: remote.EmulationSetTouchOverrideParameters
) => Promise<local.EmulationSetTouchOverrideResult>;

WebDriver Bidi command to send command method "emulation.setTouchOverride" with parameters. https://w3c.github.io/webdriver-bidi/#command-emulation-setTouchOverride
Parameter params
remote.EmulationSetTouchOverrideParameters command parameter
Returns
Promise<local.EmulationSetTouchOverrideResult>

method emulationSetUserAgentOverride

emulationSetUserAgentOverride: (
    params: remote.EmulationSetUserAgentOverrideParameters
) => Promise<local.EmulationSetUserAgentOverrideResult>;

WebDriver Bidi command to send command method "emulation.setUserAgentOverride" with parameters. https://w3c.github.io/webdriver-bidi/#command-emulation-setUserAgentOverride
Parameter params
remote.EmulationSetUserAgentOverrideParameters command parameter
Returns
Promise<local.EmulationSetUserAgentOverrideResult>

method inputPerformActions

inputPerformActions: (
    params: remote.InputPerformActionsParameters
) => Promise<local.InputPerformActionsResult>;

WebDriver Bidi command to send command method "input.performActions" with parameters. https://w3c.github.io/webdriver-bidi/#command-input-performActions
Parameter params
remote.InputPerformActionsParameters command parameter
Returns
Promise<local.InputPerformActionsResult>

method inputReleaseActions

inputReleaseActions: (
    params: remote.InputReleaseActionsParameters
) => Promise<local.InputReleaseActionsResult>;

WebDriver Bidi command to send command method "input.releaseActions" with parameters. https://w3c.github.io/webdriver-bidi/#command-input-releaseActions
Parameter params
remote.InputReleaseActionsParameters command parameter
Returns
Promise<local.InputReleaseActionsResult>

method inputSetFiles

inputSetFiles: (
    params: remote.InputSetFilesParameters
) => Promise<local.InputSetFilesResult>;

WebDriver Bidi command to send command method "input.setFiles" with parameters. https://w3c.github.io/webdriver-bidi/#command-input-setFiles
Parameter params
remote.InputSetFilesParameters command parameter
Returns
Promise<local.InputSetFilesResult>

method networkAddDataCollector

networkAddDataCollector: (
    params: remote.NetworkAddDataCollectorParameters
) => Promise<local.NetworkAddDataCollectorResult>;

WebDriver Bidi command to send command method "network.addDataCollector" with parameters. https://w3c.github.io/webdriver-bidi/#command-network-addDataCollector
Parameter params
remote.NetworkAddDataCollectorParameters command parameter
Returns
Promise<local.NetworkAddDataCollectorResult>

method networkAddIntercept

networkAddIntercept: (
    params: remote.NetworkAddInterceptParameters
) => Promise<local.NetworkAddInterceptResult>;

WebDriver Bidi command to send command method "network.addIntercept" with parameters. https://w3c.github.io/webdriver-bidi/#command-network-addIntercept
Parameter params
remote.NetworkAddInterceptParameters command parameter
Returns
Promise<local.NetworkAddInterceptResult>

method networkContinueRequest

networkContinueRequest: (
    params: remote.NetworkContinueRequestParameters
) => Promise<local.NetworkContinueRequestResult>;

WebDriver Bidi command to send command method "network.continueRequest" with parameters. https://w3c.github.io/webdriver-bidi/#command-network-continueRequest
Parameter params
remote.NetworkContinueRequestParameters command parameter
Returns
Promise<local.NetworkContinueRequestResult>

method networkContinueResponse

networkContinueResponse: (
    params: remote.NetworkContinueResponseParameters
) => Promise<local.NetworkContinueResponseResult>;

WebDriver Bidi command to send command method "network.continueResponse" with parameters. https://w3c.github.io/webdriver-bidi/#command-network-continueResponse
Parameter params
remote.NetworkContinueResponseParameters command parameter
Returns
Promise<local.NetworkContinueResponseResult>

method networkContinueWithAuth

networkContinueWithAuth: (
    params: remote.NetworkContinueWithAuthParameters
) => Promise<local.NetworkContinueWithAuthResult>;

WebDriver Bidi command to send command method "network.continueWithAuth" with parameters. https://w3c.github.io/webdriver-bidi/#command-network-continueWithAuth
Parameter params
remote.NetworkContinueWithAuthParameters command parameter
Returns
Promise<local.NetworkContinueWithAuthResult>

method networkDisownData

networkDisownData: (
    params: remote.NetworkDisownDataParameters
) => Promise<local.NetworkDisownDataResult>;

WebDriver Bidi command to send command method "network.disownData" with parameters. https://w3c.github.io/webdriver-bidi/#command-network-disownData
Parameter params
remote.NetworkDisownDataParameters command parameter
Returns
Promise<local.NetworkDisownDataResult>

method networkFailRequest

networkFailRequest: (
    params: remote.NetworkFailRequestParameters
) => Promise<local.NetworkFailRequestResult>;

WebDriver Bidi command to send command method "network.failRequest" with parameters. https://w3c.github.io/webdriver-bidi/#command-network-failRequest
Parameter params
remote.NetworkFailRequestParameters command parameter
Returns
Promise<local.NetworkFailRequestResult>

method networkGetData

networkGetData: (
    params: remote.NetworkGetDataParameters
) => Promise<local.NetworkGetDataResult>;

WebDriver Bidi command to send command method "network.getData" with parameters. https://w3c.github.io/webdriver-bidi/#command-network-getData
Parameter params
remote.NetworkGetDataParameters command parameter
Returns
Promise<local.NetworkGetDataResult>

method networkProvideResponse

networkProvideResponse: (
    params: remote.NetworkProvideResponseParameters
) => Promise<local.NetworkProvideResponseResult>;

WebDriver Bidi command to send command method "network.provideResponse" with parameters. https://w3c.github.io/webdriver-bidi/#command-network-provideResponse
Parameter params
remote.NetworkProvideResponseParameters command parameter
Returns
Promise<local.NetworkProvideResponseResult>

method networkRemoveDataCollector

networkRemoveDataCollector: (
    params: remote.NetworkRemoveDataCollectorParameters
) => Promise<local.NetworkRemoveDataCollectorResult>;

WebDriver Bidi command to send command method "network.removeDataCollector" with parameters. https://w3c.github.io/webdriver-bidi/#command-network-removeDataCollector
Parameter params
remote.NetworkRemoveDataCollectorParameters command parameter
Returns
Promise<local.NetworkRemoveDataCollectorResult>

method networkRemoveIntercept

networkRemoveIntercept: (
    params: remote.NetworkRemoveInterceptParameters
) => Promise<local.NetworkRemoveInterceptResult>;

WebDriver Bidi command to send command method "network.removeIntercept" with parameters. https://w3c.github.io/webdriver-bidi/#command-network-removeIntercept
Parameter params
remote.NetworkRemoveInterceptParameters command parameter
Returns
Promise<local.NetworkRemoveInterceptResult>

method networkSetCacheBehavior

networkSetCacheBehavior: (
    params: remote.NetworkSetCacheBehaviorParameters
) => Promise<local.NetworkSetCacheBehaviorResult>;

WebDriver Bidi command to send command method "network.setCacheBehavior" with parameters. https://w3c.github.io/webdriver-bidi/#command-network-setCacheBehavior
Parameter params
remote.NetworkSetCacheBehaviorParameters command parameter
Returns
Promise<local.NetworkSetCacheBehaviorResult>

method networkSetExtraHeaders

networkSetExtraHeaders: (
    params: remote.NetworkSetExtraHeadersParameters
) => Promise<local.NetworkSetExtraHeadersResult>;

WebDriver Bidi command to send command method "network.setExtraHeaders" with parameters. https://w3c.github.io/webdriver-bidi/#command-network-setExtraHeaders
Parameter params
remote.NetworkSetExtraHeadersParameters command parameter
Returns
Promise<local.NetworkSetExtraHeadersResult>

method scriptAddPreloadScript

scriptAddPreloadScript: (
    params: remote.ScriptAddPreloadScriptParameters
) => Promise<local.ScriptAddPreloadScriptResult>;

WebDriver Bidi command to send command method "script.addPreloadScript" with parameters. https://w3c.github.io/webdriver-bidi/#command-script-addPreloadScript
Parameter params
remote.ScriptAddPreloadScriptParameters command parameter
Returns
Promise<local.ScriptAddPreloadScriptResult>

method scriptCallFunction

scriptCallFunction: (
    params: remote.ScriptCallFunctionParameters
) => Promise<local.ScriptCallFunctionResult>;

WebDriver Bidi command to send command method "script.callFunction" with parameters. https://w3c.github.io/webdriver-bidi/#command-script-callFunction
Parameter params
remote.ScriptCallFunctionParameters command parameter
Returns
Promise<local.ScriptCallFunctionResult>

method scriptDisown

scriptDisown: (
    params: remote.ScriptDisownParameters
) => Promise<local.ScriptDisownResult>;

WebDriver Bidi command to send command method "script.disown" with parameters. https://w3c.github.io/webdriver-bidi/#command-script-disown
Parameter params
remote.ScriptDisownParameters command parameter
Returns
Promise<local.ScriptDisownResult>

method scriptEvaluate

scriptEvaluate: (
    params: remote.ScriptEvaluateParameters
) => Promise<local.ScriptEvaluateResult>;

WebDriver Bidi command to send command method "script.evaluate" with parameters. https://w3c.github.io/webdriver-bidi/#command-script-evaluate
Parameter params
remote.ScriptEvaluateParameters command parameter
Returns
Promise<local.ScriptEvaluateResult>

method scriptGetRealms

scriptGetRealms: (
    params: remote.ScriptGetRealmsParameters
) => Promise<local.ScriptGetRealmsResult>;

WebDriver Bidi command to send command method "script.getRealms" with parameters. https://w3c.github.io/webdriver-bidi/#command-script-getRealms
Parameter params
remote.ScriptGetRealmsParameters command parameter
Returns
Promise<local.ScriptGetRealmsResult>

method scriptRemovePreloadScript

scriptRemovePreloadScript: (
    params: remote.ScriptRemovePreloadScriptParameters
) => Promise<local.ScriptRemovePreloadScriptResult>;

WebDriver Bidi command to send command method "script.removePreloadScript" with parameters. https://w3c.github.io/webdriver-bidi/#command-script-removePreloadScript
Parameter params
remote.ScriptRemovePreloadScriptParameters command parameter
Returns
Promise<local.ScriptRemovePreloadScriptResult>

method sessionEnd

sessionEnd: (params: remote.EmptyParams) => Promise<local.SessionEndResult>;

WebDriver Bidi command to send command method "session.end" with parameters. https://w3c.github.io/webdriver-bidi/#command-session-end
Parameter params
remote.EmptyParams command parameter
Returns
Promise<local.SessionEndResult>

method sessionNew

sessionNew: (
    params: remote.SessionNewParameters
) => Promise<local.SessionNewResult>;

WebDriver Bidi command to send command method "session.new" with parameters. https://w3c.github.io/webdriver-bidi/#command-session-new
Parameter params
remote.SessionNewParameters command parameter
Returns
Promise<local.SessionNewResult>

method sessionStatus

sessionStatus: (
    params: remote.EmptyParams
) => Promise<local.SessionStatusResult>;

WebDriver Bidi command to send command method "session.status" with parameters. https://w3c.github.io/webdriver-bidi/#command-session-status
Parameter params
remote.EmptyParams command parameter
Returns
Promise<local.SessionStatusResult>

method sessionSubscribe

sessionSubscribe: (
    params: remote.SessionSubscribeParameters
) => Promise<local.SessionSubscribeResult>;

WebDriver Bidi command to send command method "session.subscribe" with parameters. https://w3c.github.io/webdriver-bidi/#command-session-subscribe
Parameter params
remote.SessionSubscribeParameters command parameter
Returns
Promise<local.SessionSubscribeResult>

method sessionUnsubscribe

sessionUnsubscribe: (
    params: remote.SessionUnsubscribeParameters
) => Promise<local.SessionUnsubscribeResult>;

WebDriver Bidi command to send command method "session.unsubscribe" with parameters. https://w3c.github.io/webdriver-bidi/#command-session-unsubscribe
Parameter params
remote.SessionUnsubscribeParameters command parameter
Returns
Promise<local.SessionUnsubscribeResult>

method storageDeleteCookies

storageDeleteCookies: (
    params: remote.StorageDeleteCookiesParameters
) => Promise<local.StorageDeleteCookiesResult>;

WebDriver Bidi command to send command method "storage.deleteCookies" with parameters. https://w3c.github.io/webdriver-bidi/#command-storage-deleteCookies
Parameter params
remote.StorageDeleteCookiesParameters command parameter
Returns
Promise<local.StorageDeleteCookiesResult>

method storageGetCookies

storageGetCookies: (
    params: remote.StorageGetCookiesParameters
) => Promise<local.StorageGetCookiesResult>;

WebDriver Bidi command to send command method "storage.getCookies" with parameters. https://w3c.github.io/webdriver-bidi/#command-storage-getCookies
Parameter params
remote.StorageGetCookiesParameters command parameter
Returns
Promise<local.StorageGetCookiesResult>

method storageSetCookie

storageSetCookie: (
    params: remote.StorageSetCookieParameters
) => Promise<local.StorageSetCookieResult>;

WebDriver Bidi command to send command method "storage.setCookie" with parameters. https://w3c.github.io/webdriver-bidi/#command-storage-setCookie
Parameter params
remote.StorageSetCookieParameters command parameter
Returns
Promise<local.StorageSetCookieResult>

method webExtensionInstall

webExtensionInstall: (
    params: remote.WebExtensionInstallParameters
) => Promise<local.WebExtensionInstallResult>;

WebDriver Bidi command to send command method "webExtension.install" with parameters. https://w3c.github.io/webdriver-bidi/#command-webExtension-install
Parameter params
remote.WebExtensionInstallParameters command parameter
Returns
Promise<local.WebExtensionInstallResult>

method webExtensionUninstall

webExtensionUninstall: (
    params: remote.WebExtensionUninstallParameters
) => Promise<local.WebExtensionUninstallResult>;

WebDriver Bidi command to send command method "webExtension.uninstall" with parameters. https://w3c.github.io/webdriver-bidi/#command-webExtension-uninstall
Parameter params
remote.WebExtensionUninstallParameters command parameter
Returns
Promise<local.WebExtensionUninstallResult>

class CommandRuntimeOptions

class CommandRuntimeOptions {}

Additional options outside of the WebDriver spec, exclusively for WebdriverIO, only for runtime, and not sent to Appium

constructor

constructor(options: { mask?: boolean });

property mask

mask?: boolean;

class WebDriver

class WebDriver {}

property WebDriver

static readonly WebDriver: typeof WebDriver;

method attachToSession

static attachToSession: (
    options?: AttachOptions,
    modifier?: (...args: any[]) => any,
    userPrototype?: {},
    commandWrapper?: (...args: any[]) => any
) => Client;

allows user to attach to existing sessions

method newSession

static newSession: (
    options: Capabilities.RemoteConfig,
    modifier?: (...args: any[]) => any,
    userPrototype?: {},
    customCommandWrapper?: (...args: any[]) => any,
    implicitWaitExclusionList?: string[]
) => Promise<Client>;

method reloadSession

static reloadSession: (
    instance: Client & { _bidiHandler?: BidiHandler },
    newCapabilities?: WebdriverIO.Capabilities
) => Promise<string>;

Changes The instance session id and browser capabilities for the new session directly into the passed in browser object
Parameter instance
the object we get from a new browser session.
Returns
{string} the new session id of the browser

Interfaces

interface AttachOptions

interface AttachOptions extends Partial<SessionFlags>, Partial<Options.WebDriver> {}

property capabilities

capabilities?: WebdriverIO.Capabilities;

property requestedCapabilities

requestedCapabilities?: Capabilities.WithRequestedCapabilities['capabilities'];

property sessionId

sessionId: string;

interface BaseClient

interface BaseClient extends EventEmitter, SessionFlags {}

property capabilities

capabilities: WebdriverIO.Capabilities;

property options

options: Options.WebDriver;

property requestedCapabilities

requestedCapabilities: Capabilities.WithRequestedCapabilities['capabilities'];

property sessionId

sessionId: string;

interface Client

interface Client
    extends Omit<BaseClient, keyof BidiEventHandler>,
        ProtocolCommands,
        BidiHandler,
        BidiEventHandler {}

interface JSONWPCommandError

interface JSONWPCommandError extends Error {}

property code

code?: string;

property statusCode

statusCode?: string;

property statusMessage

statusMessage?: string;

interface SessionFlags

interface SessionFlags {}

property isAndroid

isAndroid: boolean;

property isBidi

isBidi: boolean;

property isChromium

isChromium: boolean;

property isFirefox

isFirefox: boolean;

property isIOS

isIOS: boolean;

property isMacApp

isMacApp: boolean;

property isMobile

isMobile: boolean;

property isNativeContext

isNativeContext: boolean;

property isSauce

isSauce: boolean;

property isSeleniumStandalone

isSeleniumStandalone: boolean;

property isW3C

isW3C: boolean;

property isWindowsApp

isWindowsApp: boolean;

property mobileContext

mobileContext: string | undefined;

interface WebDriverCommandEvent

interface WebDriverCommandEvent {}

property body

body: unknown;

property command

command: string;

property endpoint

endpoint: string;

property method

method: string;

interface WebDriverResultEvent

interface WebDriverResultEvent {}

property body

body: unknown;

property command

command: string;

property endpoint

endpoint: string;

property method

method: string;

property result

result: unknown;

Type Aliases

type BidiCommands

type BidiCommands =
    WebDriverBidiCommands[keyof WebDriverBidiCommands]['socket']['command'];

type BidiEventMap

type BidiEventMap = {
    [Event in keyof Omit<
        WebDriverBidiCommands,
        'sendCommand' | 'sendAsyncCommand'
    >]: BidiInterface[WebDriverBidiCommands[Event]['socket']['command']];
};

type BidiResponses

type BidiResponses = ValueOf<ObtainMethods<Pick<BidiHandler, BidiCommands>>>;

type EventMap

type EventMap = {
    [Event in EventData['method']]: GetParam<EventData, Event>;
} & WebDriverClassicEvents;

type RemoteConfig

type RemoteConfig = Options.WebDriver & Capabilities.WithRequestedCapabilities;

Namespaces

namespace local

module 'build/bidi/localTypes.d.ts' {}

!!! PLEASE DO NOT EDIT THIS FILE !!!
This source file, even though checked in, is auto-generated based on the current development within the WebDriver Bidi spec. Any changes to this file need to come from the specification. You can generate this file by calling
$ npm run generate:bidi
from the project root. You can find the scripts that generates this file in ./scripts/bidi/**

interface BrowserClientWindowInfo

interface BrowserClientWindowInfo {}

property active

active: boolean;

property clientWindow

clientWindow: BrowserClientWindow;

property height

height: JsUint;

property state

state: 'fullscreen' | 'maximized' | 'minimized' | 'normal';

property width

width: JsUint;

property x

x: JsInt;

property y

y: JsInt;

interface BrowserGetClientWindowsResult

interface BrowserGetClientWindowsResult {}

property clientWindows

clientWindows: BrowserClientWindowInfo[];

interface BrowserGetUserContextsResult

interface BrowserGetUserContextsResult {}

property userContexts

userContexts: BrowserUserContextInfo[];

interface BrowserUserContextInfo

interface BrowserUserContextInfo {}

property userContext

userContext: BrowserUserContext;

interface BrowsingContextAccessibilityLocator

interface BrowsingContextAccessibilityLocator {}

property type

type: 'accessibility';

property value

value: {
    name?: string;
    role?: string;
};

interface BrowsingContextBaseNavigationInfo

interface BrowsingContextBaseNavigationInfo {}

property context

context: BrowsingContextBrowsingContext;

navigation: BrowsingContextNavigation | null;

property timestamp

timestamp: JsUint;

property url

url: string;

property userContext

userContext?: BrowserUserContext;

interface BrowsingContextCaptureScreenshotResult

interface BrowsingContextCaptureScreenshotResult {}

property data

data: string;

interface BrowsingContextContextCreated

interface BrowsingContextContextCreated {}

property method

method: 'browsingContext.contextCreated';

property params

params: BrowsingContextInfo;

interface BrowsingContextContextDestroyed

interface BrowsingContextContextDestroyed {}

property method

method: 'browsingContext.contextDestroyed';

property params

params: BrowsingContextInfo;

interface BrowsingContextContextLocator

interface BrowsingContextContextLocator {}

property type

type: 'context';

property value

value: {
    context: BrowsingContextBrowsingContext;
};

interface BrowsingContextCreateResult

interface BrowsingContextCreateResult {}

property context

context: BrowsingContextBrowsingContext;

property userContext

userContext?: BrowserUserContext;

interface BrowsingContextCssLocator

interface BrowsingContextCssLocator {}

property type

type: 'css';

property value

value: string;

interface BrowsingContextDomContentLoaded

interface BrowsingContextDomContentLoaded {}

property method

method: 'browsingContext.domContentLoaded';

property params

params: BrowsingContextNavigationInfo;

interface BrowsingContextDownloadEnd

interface BrowsingContextDownloadEnd {}

property method

method: 'browsingContext.downloadEnd';

property params

params: BrowsingContextDownloadEndParams;

interface BrowsingContextDownloadWillBegin

interface BrowsingContextDownloadWillBegin {}

property method

method: 'browsingContext.downloadWillBegin';

property params

params: BrowsingContextDownloadWillBeginParams;

interface BrowsingContextFragmentNavigated

interface BrowsingContextFragmentNavigated {}

property method

method: 'browsingContext.fragmentNavigated';

property params

params: BrowsingContextNavigationInfo;

interface BrowsingContextGetTreeResult

interface BrowsingContextGetTreeResult {}

property contexts

contexts: BrowsingContextInfoList;

interface BrowsingContextHistoryUpdated

interface BrowsingContextHistoryUpdated {}

property method

method: 'browsingContext.historyUpdated';

property params

params: BrowsingContextHistoryUpdatedParameters;

interface BrowsingContextHistoryUpdatedParameters

interface BrowsingContextHistoryUpdatedParameters {}

property context

context: BrowsingContextBrowsingContext;

property timestamp

timestamp: JsUint;

property url

url: string;

property userContext

userContext?: BrowserUserContext;

interface BrowsingContextInfo

interface BrowsingContextInfo {}

property children

children: BrowsingContextInfoList | null;

property clientWindow

clientWindow: BrowserClientWindow;

property context

context: BrowsingContextBrowsingContext;

property originalOpener

originalOpener: BrowsingContextBrowsingContext | null;

property parent

parent?: BrowsingContextBrowsingContext | null;

property url

url: string;

property userContext

userContext: BrowserUserContext;

interface BrowsingContextInnerTextLocator

interface BrowsingContextInnerTextLocator {}

property ignoreCase

ignoreCase?: boolean;

property matchType

matchType?: 'full' | 'partial';

property maxDepth

maxDepth?: JsUint;

property type

type: 'innerText';

property value

value: string;

interface BrowsingContextLoad

interface BrowsingContextLoad {}

property method

method: 'browsingContext.load';

property params

params: BrowsingContextNavigationInfo;

interface BrowsingContextLocateNodesResult

interface BrowsingContextLocateNodesResult {}

property nodes

nodes: ScriptNodeRemoteValue[];

interface BrowsingContextNavigateResult

interface BrowsingContextNavigateResult {}

navigation: BrowsingContextNavigation | null;

property url

url: string;

interface BrowsingContextNavigationAborted

interface BrowsingContextNavigationAborted {}

property method

method: 'browsingContext.navigationAborted';

property params

params: BrowsingContextNavigationInfo;

interface BrowsingContextNavigationCommitted

interface BrowsingContextNavigationCommitted {}

property method

method: 'browsingContext.navigationCommitted';

property params

params: BrowsingContextNavigationInfo;

interface BrowsingContextNavigationFailed

interface BrowsingContextNavigationFailed {}

property method

method: 'browsingContext.navigationFailed';

property params

params: BrowsingContextNavigationInfo;

interface BrowsingContextNavigationStarted

interface BrowsingContextNavigationStarted {}

property method

method: 'browsingContext.navigationStarted';

property params

params: BrowsingContextNavigationInfo;

interface BrowsingContextPrintResult

interface BrowsingContextPrintResult {}

property data

data: string;

interface BrowsingContextUserPromptClosed

interface BrowsingContextUserPromptClosed {}

property method

method: 'browsingContext.userPromptClosed';

property params

params: BrowsingContextUserPromptClosedParameters;

interface BrowsingContextUserPromptClosedParameters

interface BrowsingContextUserPromptClosedParameters {}

property accepted

accepted: boolean;

property context

context: BrowsingContextBrowsingContext;

property type

type: BrowsingContextUserPromptType;

property userContext

userContext?: BrowserUserContext;

property userText

userText?: string;

interface BrowsingContextUserPromptOpened

interface BrowsingContextUserPromptOpened {}

property method

method: 'browsingContext.userPromptOpened';

property params

params: BrowsingContextUserPromptOpenedParameters;

interface BrowsingContextUserPromptOpenedParameters

interface BrowsingContextUserPromptOpenedParameters {}

property context

context: BrowsingContextBrowsingContext;

property defaultValue

defaultValue?: string;

property handler

handler: SessionUserPromptHandlerType;

property message

message: string;

property type

type: BrowsingContextUserPromptType;

property userContext

userContext?: BrowserUserContext;

interface BrowsingContextXPathLocator

interface BrowsingContextXPathLocator {}

property type

type: 'xpath';

property value

value: string;

interface InputFileDialogInfo

interface InputFileDialogInfo {}

property context

context: BrowsingContextBrowsingContext;

property element

element?: ScriptSharedReference;

property multiple

multiple: boolean;

property userContext

userContext?: BrowserUserContext;

interface InputFileDialogOpened

interface InputFileDialogOpened {}

property method

method: 'input.fileDialogOpened';

property params

params: InputFileDialogInfo;

interface LogBaseLogEntry

interface LogBaseLogEntry {}

property level

level: LogLevel;

property source

source: ScriptSource;

property stackTrace

stackTrace?: ScriptStackTrace;

property text

text: string | null;

property timestamp

timestamp: JsUint;

interface LogEntryAdded

interface LogEntryAdded {}

property method

method: 'log.entryAdded';

property params

params: LogEntry;

interface NetworkAddDataCollectorResult

interface NetworkAddDataCollectorResult {}

property collector

collector: NetworkCollector;

interface NetworkAddInterceptResult

interface NetworkAddInterceptResult {}

property intercept

intercept: NetworkIntercept;

interface NetworkAuthChallenge

interface NetworkAuthChallenge {}

property realm

realm: string;

property scheme

scheme: string;

interface NetworkAuthRequired

interface NetworkAuthRequired {}

property method

method: 'network.authRequired';

property params

params: NetworkAuthRequiredParameters;

interface NetworkBase64Value

interface NetworkBase64Value {}

property type

type: 'base64';

property value

value: string;

interface NetworkBaseParameters

interface NetworkBaseParameters {}

property context

context: BrowsingContextBrowsingContext | null;

property intercepts

intercepts?: NetworkIntercept[];

property isBlocked

isBlocked: boolean;

navigation: BrowsingContextNavigation | null;

property redirectCount

redirectCount: JsUint;

property request

request: NetworkRequestData;

property timestamp

timestamp: JsUint;

property userContext

userContext?: BrowserUserContext | null;

interface NetworkBeforeRequestSent

interface NetworkBeforeRequestSent {}

property method

method: 'network.beforeRequestSent';

property params

params: NetworkBeforeRequestSentParameters;

interface NetworkFetchError

interface NetworkFetchError {}

property method

method: 'network.fetchError';

property params

params: NetworkFetchErrorParameters;

interface NetworkFetchTimingInfo

interface NetworkFetchTimingInfo {}

property connectEnd

connectEnd: number;

property connectStart

connectStart: number;

property dnsEnd

dnsEnd: number;

property dnsStart

dnsStart: number;

property fetchStart

fetchStart: number;

property redirectEnd

redirectEnd: number;

property redirectStart

redirectStart: number;

property requestStart

requestStart: number;

property requestTime

requestTime: number;

property responseEnd

responseEnd: number;

property responseStart

responseStart: number;

property timeOrigin

timeOrigin: number;

property tlsStart

tlsStart: number;

interface NetworkGetDataResult

interface NetworkGetDataResult {}

property bytes

bytes: NetworkBytesValue;

interface NetworkHeader

interface NetworkHeader {}

property name

name: string;

property value

value: NetworkBytesValue;

interface NetworkInitiator

interface NetworkInitiator {}

property columnNumber

columnNumber?: JsUint;

property lineNumber

lineNumber?: JsUint;

property request

request?: NetworkRequest;

property stackTrace

stackTrace?: ScriptStackTrace;

property type

type?: 'parser' | 'script' | 'preflight' | 'other';

interface NetworkRequestData

interface NetworkRequestData {}

property bodySize

bodySize: JsUint | null;

property cookies

cookies: NetworkCookie[];

property destination

destination: string;

property headers

headers: NetworkHeader[];

property headersSize

headersSize: JsUint;

property initiatorType

initiatorType: string | null;

property method

method: string;

property request

request: NetworkRequest;

property timings

timings: NetworkFetchTimingInfo;

property url

url: string;

interface NetworkResponseCompleted

interface NetworkResponseCompleted {}

property method

method: 'network.responseCompleted';

property params

params: NetworkResponseCompletedParameters;

interface NetworkResponseContent

interface NetworkResponseContent {}

property size

size: JsUint;

interface NetworkResponseData

interface NetworkResponseData {}

property authChallenges

authChallenges?: NetworkAuthChallenge[];

property bodySize

bodySize: JsUint | null;

property bytesReceived

bytesReceived: JsUint;

property content

content: NetworkResponseContent;

property fromCache

fromCache: boolean;

property headers

headers: NetworkHeader[];

property headersSize

headersSize: JsUint | null;

property mimeType

mimeType: string;

property protocol

protocol: string;

property status

status: JsUint;

property statusText

statusText: string;

property url

url: string;

interface NetworkResponseStarted

interface NetworkResponseStarted {}

property method

method: 'network.responseStarted';

property params

params: NetworkResponseStartedParameters;

interface NetworkStringValue

interface NetworkStringValue {}

property type

type: 'string';

property value

value: string;

interface ScriptAddPreloadScriptResult

interface ScriptAddPreloadScriptResult {}

property script

script: ScriptPreloadScript;

interface ScriptArrayBufferRemoteValue

interface ScriptArrayBufferRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'arraybuffer';

interface ScriptArrayLocalValue

interface ScriptArrayLocalValue {}

property type

type: 'array';

property value

value: ScriptListLocalValue;

interface ScriptArrayRemoteValue

interface ScriptArrayRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'array';

property value

value?: ScriptListRemoteValue;

interface ScriptBaseRealmInfo

interface ScriptBaseRealmInfo {}

property origin

origin: string;

property realm

realm: ScriptRealm;

interface ScriptBigIntValue

interface ScriptBigIntValue {}

property type

type: 'bigint';

property value

value: string;

interface ScriptBooleanValue

interface ScriptBooleanValue {}

property type

type: 'boolean';

property value

value: boolean;

interface ScriptChannelProperties

interface ScriptChannelProperties {}

property channel

channel: ScriptChannel;

property ownership

ownership?: ScriptResultOwnership;

property serializationOptions

serializationOptions?: ScriptSerializationOptions;

interface ScriptChannelValue

interface ScriptChannelValue {}

property type

type: 'channel';

property value

value: ScriptChannelProperties;

interface ScriptDateLocalValue

interface ScriptDateLocalValue {}

property type

type: 'date';

property value

value: string;

interface ScriptErrorRemoteValue

interface ScriptErrorRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'error';

interface ScriptEvaluateResultException

interface ScriptEvaluateResultException {}

property exceptionDetails

exceptionDetails: ScriptExceptionDetails;

property realm

realm: ScriptRealm;

property type

type: 'exception';

interface ScriptEvaluateResultSuccess

interface ScriptEvaluateResultSuccess {}

property realm

realm: ScriptRealm;

property result

result: ScriptRemoteValue;

property type

type: 'success';

interface ScriptExceptionDetails

interface ScriptExceptionDetails {}

property columnNumber

columnNumber: JsUint;

property exception

exception: ScriptRemoteValue;

property lineNumber

lineNumber: JsUint;

property stackTrace

stackTrace: ScriptStackTrace;

property text

text: string;

interface ScriptFunctionRemoteValue

interface ScriptFunctionRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'function';

interface ScriptGeneratorRemoteValue

interface ScriptGeneratorRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'generator';

interface ScriptGetRealmsResult

interface ScriptGetRealmsResult {}

property realms

realms: ScriptRealmInfo[];

interface ScriptHtmlCollectionRemoteValue

interface ScriptHtmlCollectionRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'htmlcollection';

property value

value?: ScriptListRemoteValue;

interface ScriptMapLocalValue

interface ScriptMapLocalValue {}

property type

type: 'map';

property value

value: ScriptMappingLocalValue;

interface ScriptMapRemoteValue

interface ScriptMapRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'map';

property value

value?: ScriptMappingRemoteValue;

interface ScriptMessage

interface ScriptMessage {}

property method

method: 'script.message';

property params

params: ScriptMessageParameters;

interface ScriptMessageParameters

interface ScriptMessageParameters {}

property channel

channel: ScriptChannel;

property data

data: ScriptRemoteValue;

property source

source: ScriptSource;

interface ScriptNodeListRemoteValue

interface ScriptNodeListRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'nodelist';

property value

value?: ScriptListRemoteValue;

interface ScriptNodeProperties

interface ScriptNodeProperties {}

property attributes

attributes?: Record<string, string>;

property childNodeCount

childNodeCount: JsUint;

property children

children?: ScriptNodeRemoteValue[];

property localName

localName?: string;

property mode

mode?: 'open' | 'closed';

property namespaceUri

namespaceUri?: string;

property nodeType

nodeType: JsUint;

property nodeValue

nodeValue?: string;

property shadowRoot

shadowRoot?: ScriptNodeRemoteValue | null;

interface ScriptNodeRemoteValue

interface ScriptNodeRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property sharedId

sharedId?: ScriptSharedId;

property type

type: 'node';

property value

value?: ScriptNodeProperties;

interface ScriptNullValue

interface ScriptNullValue {}

property type

type: null;

interface ScriptNumberValue

interface ScriptNumberValue {}

property type

type: 'number';

property value

value: number | ScriptSpecialNumber;

interface ScriptObjectLocalValue

interface ScriptObjectLocalValue {}

property type

type: 'object';

property value

value: ScriptMappingLocalValue;

interface ScriptObjectRemoteValue

interface ScriptObjectRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'object';

property value

value?: ScriptMappingRemoteValue;

interface ScriptPromiseRemoteValue

interface ScriptPromiseRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'promise';

interface ScriptProxyRemoteValue

interface ScriptProxyRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'proxy';

interface ScriptRealmCreated

interface ScriptRealmCreated {}

property method

method: 'script.realmCreated';

property params

params: ScriptRealmInfo;

interface ScriptRealmDestroyed

interface ScriptRealmDestroyed {}

property method

method: 'script.realmDestroyed';

property params

params: ScriptRealmDestroyedParameters;

interface ScriptRealmDestroyedParameters

interface ScriptRealmDestroyedParameters {}

property realm

realm: ScriptRealm;

interface ScriptRegExpLocalValue

interface ScriptRegExpLocalValue {}

property type

type: 'regexp';

property value

value: ScriptRegExpValue;

interface ScriptRegExpValue

interface ScriptRegExpValue {}

property flags

flags?: string;

property pattern

pattern: string;

interface ScriptSerializationOptions

interface ScriptSerializationOptions {}

property includeShadowTree

includeShadowTree?: 'none' | 'open' | 'all';

'none'

property maxDomDepth

maxDomDepth?: JsUint | null;

property maxObjectDepth

maxObjectDepth?: JsUint | null;

null

interface ScriptSetLocalValue

interface ScriptSetLocalValue {}

property type

type: 'set';

property value

value: ScriptListLocalValue;

interface ScriptSetRemoteValue

interface ScriptSetRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'set';

property value

value?: ScriptListRemoteValue;

interface ScriptSource

interface ScriptSource {}

property context

context?: BrowsingContextBrowsingContext;

property realm

realm: ScriptRealm;

property userContext

userContext?: BrowserUserContext;

interface ScriptStackFrame

interface ScriptStackFrame {}

property columnNumber

columnNumber: JsUint;

property functionName

functionName: string;

property lineNumber

lineNumber: JsUint;

property url

url: string;

interface ScriptStackTrace

interface ScriptStackTrace {}

property callFrames

callFrames: ScriptStackFrame[];

interface ScriptStringValue

interface ScriptStringValue {}

property type

type: 'string';

property value

value: string;

interface ScriptSymbolRemoteValue

interface ScriptSymbolRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'symbol';

interface ScriptTypedArrayRemoteValue

interface ScriptTypedArrayRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'typedarray';

interface ScriptUndefinedValue

interface ScriptUndefinedValue {}

property type

type: 'undefined';

interface ScriptWeakMapRemoteValue

interface ScriptWeakMapRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'weakmap';

interface ScriptWeakSetRemoteValue

interface ScriptWeakSetRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'weakset';

interface ScriptWindowProxyProperties

interface ScriptWindowProxyProperties {}

property context

context: BrowsingContextBrowsingContext;

interface ScriptWindowProxyRemoteValue

interface ScriptWindowProxyRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'window';

property value

value: ScriptWindowProxyProperties;

interface SessionCapabilitiesRequest

interface SessionCapabilitiesRequest {}

property alwaysMatch

alwaysMatch?: SessionCapabilityRequest;

property firstMatch

firstMatch?: SessionCapabilityRequest[];

interface SessionNewResult

interface SessionNewResult {}

property capabilities

capabilities: {
    acceptInsecureCerts: boolean;
    browserName: string;
    browserVersion: string;
    platformName: string;
    setWindowRect: boolean;
    userAgent: string;
    proxy?: SessionProxyConfiguration;
    unhandledPromptBehavior?: SessionUserPromptHandler;
    webSocketUrl?: string;
};

property sessionId

sessionId: string;

interface SessionSocksProxyConfiguration

interface SessionSocksProxyConfiguration {}

property socksProxy

socksProxy: string;

property socksVersion

socksVersion: number;

interface SessionStatusResult

interface SessionStatusResult {}

property message

message: string;

property ready

ready: boolean;

interface SessionSubscribeResult

interface SessionSubscribeResult {}

property subscription

subscription: SessionSubscription;

interface SessionUserPromptHandler

interface SessionUserPromptHandler {}

property alert

alert?: SessionUserPromptHandlerType;

property beforeUnload

beforeUnload?: SessionUserPromptHandlerType;

property confirm

confirm?: SessionUserPromptHandlerType;

property default

default?: SessionUserPromptHandlerType;

property file

file?: SessionUserPromptHandlerType;

property prompt

prompt?: SessionUserPromptHandlerType;

interface StorageDeleteCookiesResult

interface StorageDeleteCookiesResult {}

property partitionKey

partitionKey: StoragePartitionKey;

interface StorageGetCookiesResult

interface StorageGetCookiesResult {}

property cookies

cookies: NetworkCookie[];

property partitionKey

partitionKey: StoragePartitionKey;

interface StorageSetCookieResult

interface StorageSetCookieResult {}

property partitionKey

partitionKey: StoragePartitionKey;

interface WebExtensionInstallResult

interface WebExtensionInstallResult {}

property extension

extension: WebExtensionExtension;

type BrowserClientWindow

type BrowserClientWindow = string;

type BrowserCloseResult

type BrowserCloseResult = EmptyResult;

type BrowserCreateUserContextResult

type BrowserCreateUserContextResult = BrowserUserContextInfo;

type BrowserRemoveUserContextResult

type BrowserRemoveUserContextResult = EmptyResult;

type BrowserResult

type BrowserResult =
    | BrowserCloseResult
    | BrowserCreateUserContextResult
    | BrowserGetClientWindowsResult
    | BrowserGetUserContextsResult
    | BrowserRemoveUserContextResult
    | BrowserSetClientWindowStateResult
    | BrowserSetDownloadBehaviorResult;

type BrowserSetClientWindowStateResult

type BrowserSetClientWindowStateResult = BrowserClientWindowInfo;

type BrowserSetDownloadBehaviorResult

type BrowserSetDownloadBehaviorResult = EmptyResult;

type BrowserUserContext

type BrowserUserContext = string;

type BrowsingContextActivateResult

type BrowsingContextActivateResult = EmptyResult;

type BrowsingContextBrowsingContext

type BrowsingContextBrowsingContext = string;

type BrowsingContextCloseResult

type BrowsingContextCloseResult = EmptyResult;

type BrowsingContextDownloadCanceledParams

type BrowsingContextDownloadCanceledParams = BrowsingContextBaseNavigationInfo & {
    status: 'canceled';
};

type BrowsingContextDownloadCompleteParams

type BrowsingContextDownloadCompleteParams = BrowsingContextBaseNavigationInfo & {
    status: 'complete';
    filepath: string | null;
};

type BrowsingContextDownloadEndParams

type BrowsingContextDownloadEndParams =
    | BrowsingContextDownloadCanceledParams
    | BrowsingContextDownloadCompleteParams;

type BrowsingContextDownloadWillBeginParams

type BrowsingContextDownloadWillBeginParams = BrowsingContextBaseNavigationInfo & {
    suggestedFilename: string;
};

type BrowsingContextEvent

type BrowsingContextEvent =
    | BrowsingContextContextCreated
    | BrowsingContextContextDestroyed
    | BrowsingContextDomContentLoaded
    | BrowsingContextDownloadEnd
    | BrowsingContextDownloadWillBegin
    | BrowsingContextFragmentNavigated
    | BrowsingContextHistoryUpdated
    | BrowsingContextLoad
    | BrowsingContextNavigationAborted
    | BrowsingContextNavigationCommitted
    | BrowsingContextNavigationFailed
    | BrowsingContextNavigationStarted
    | BrowsingContextUserPromptClosed
    | BrowsingContextUserPromptOpened;

type BrowsingContextHandleUserPromptResult

type BrowsingContextHandleUserPromptResult = EmptyResult;

type BrowsingContextInfoList

type BrowsingContextInfoList = BrowsingContextInfo[];

type BrowsingContextLocator

type BrowsingContextLocator =
    | BrowsingContextAccessibilityLocator
    | BrowsingContextCssLocator
    | BrowsingContextContextLocator
    | BrowsingContextInnerTextLocator
    | BrowsingContextXPathLocator;

type BrowsingContextNavigation

type BrowsingContextNavigation = string;

type BrowsingContextNavigationInfo

type BrowsingContextNavigationInfo = BrowsingContextBaseNavigationInfo;

type BrowsingContextReloadResult

type BrowsingContextReloadResult = BrowsingContextNavigateResult;

type BrowsingContextResult

type BrowsingContextResult =
    | BrowsingContextActivateResult
    | BrowsingContextCaptureScreenshotResult
    | BrowsingContextCloseResult
    | BrowsingContextCreateResult
    | BrowsingContextGetTreeResult
    | BrowsingContextHandleUserPromptResult
    | BrowsingContextLocateNodesResult
    | BrowsingContextNavigateResult
    | BrowsingContextPrintResult
    | BrowsingContextReloadResult
    | BrowsingContextSetBypassCspResult
    | BrowsingContextSetViewportResult
    | BrowsingContextTraverseHistoryResult;

type BrowsingContextSetBypassCspResult

type BrowsingContextSetBypassCspResult = EmptyResult;

type BrowsingContextSetViewportResult

type BrowsingContextSetViewportResult = EmptyResult;

type BrowsingContextTraverseHistoryResult

type BrowsingContextTraverseHistoryResult = EmptyResult;

type BrowsingContextUserPromptType

type BrowsingContextUserPromptType = 'alert' | 'beforeunload' | 'confirm' | 'prompt';

type CommandResponse

type CommandResponse = Extensible & {
    type: 'success';
    id: JsUint;
    result: ResultData;
};

type EmptyResult

type EmptyResult = Extensible;

type EmulationResult

type EmulationResult =
    | EmulationSetForcedColorsModeThemeOverrideResult
    | EmulationSetGeolocationOverrideResult
    | EmulationSetLocaleOverrideResult
    | EmulationSetScreenOrientationOverrideResult
    | EmulationSetScriptingEnabledResult
    | EmulationSetScrollbarTypeOverrideResult
    | EmulationSetTimezoneOverrideResult
    | EmulationSetTouchOverrideResult
    | EmulationSetUserAgentOverrideResult;

type EmulationSetForcedColorsModeThemeOverrideResult

type EmulationSetForcedColorsModeThemeOverrideResult = EmptyResult;

type EmulationSetGeolocationOverrideResult

type EmulationSetGeolocationOverrideResult = EmptyResult;

type EmulationSetLocaleOverrideResult

type EmulationSetLocaleOverrideResult = EmptyResult;

type EmulationSetNetworkConditionsResult

type EmulationSetNetworkConditionsResult = EmptyResult;

type EmulationSetScreenOrientationOverrideResult

type EmulationSetScreenOrientationOverrideResult = EmptyResult;

type EmulationSetScreenSettingsOverrideResult

type EmulationSetScreenSettingsOverrideResult = EmptyResult;

type EmulationSetScriptingEnabledResult

type EmulationSetScriptingEnabledResult = EmptyResult;

type EmulationSetScrollbarTypeOverrideResult

type EmulationSetScrollbarTypeOverrideResult = EmptyResult;

type EmulationSetTimezoneOverrideResult

type EmulationSetTimezoneOverrideResult = EmptyResult;

type EmulationSetTouchOverrideResult

type EmulationSetTouchOverrideResult = EmptyResult;

type EmulationSetUserAgentOverrideResult

type EmulationSetUserAgentOverrideResult = EmptyResult;

type ErrorCode

type ErrorCode =
    | 'invalid argument'
    | 'invalid selector'
    | 'invalid session id'
    | 'invalid web extension'
    | 'move target out of bounds'
    | 'no such alert'
    | 'no such network collector'
    | 'no such element'
    | 'no such frame'
    | 'no such handle'
    | 'no such history entry'
    | 'no such intercept'
    | 'no such network data'
    | 'no such node'
    | 'no such request'
    | 'no such script'
    | 'no such storage partition'
    | 'no such user context'
    | 'no such web extension'
    | 'session not created'
    | 'unable to capture screen'
    | 'unable to close browser'
    | 'unable to set cookie'
    | 'unable to set file input'
    | 'unavailable network data'
    | 'underspecified storage partition'
    | 'unknown command'
    | 'unknown error'
    | 'unsupported operation';

type ErrorResponse

type ErrorResponse = Extensible & {
    type: 'error';
    id: JsUint | null;
    error: ErrorCode;
    message: string;
    stacktrace?: string;
};

type Event

type Event = EventData &
    Extensible & {
        type: 'event';
    };

type EventData

type EventData =
    | BrowsingContextEvent
    | InputEvent
    | LogEvent
    | NetworkEvent
    | ScriptEvent;

type Extensible

type Extensible = Record<string, unknown>;

type InputEvent

type InputEvent = InputFileDialogOpened;

type InputPerformActionsResult

type InputPerformActionsResult = EmptyResult;

type InputReleaseActionsResult

type InputReleaseActionsResult = EmptyResult;

type InputResult

type InputResult =
    | InputPerformActionsResult
    | InputReleaseActionsResult
    | InputSetFilesResult;

type InputSetFilesResult

type InputSetFilesResult = EmptyResult;

type JsInt

type JsInt = number;

type JsUint

type JsUint = number;

type LogConsoleLogEntry

type LogConsoleLogEntry = LogBaseLogEntry & {
    type: 'console';
    method: string;
    args: ScriptRemoteValue[];
};

type LogEntry

type LogEntry = LogGenericLogEntry | LogConsoleLogEntry | LogJavascriptLogEntry;

type LogEvent

type LogEvent = LogEntryAdded;

type LogGenericLogEntry

type LogGenericLogEntry = LogBaseLogEntry & {
    type: string;
};

type LogJavascriptLogEntry

type LogJavascriptLogEntry = LogBaseLogEntry & {
    type: 'javascript';
};

type LogLevel

type LogLevel = 'debug' | 'info' | 'warn' | 'error';

type Message

type Message = CommandResponse | ErrorResponse | Event;

!!! PLEASE DO NOT EDIT THIS FILE !!!
This source file, even though checked in, is auto-generated based on the current development within the WebDriver Bidi spec. Any changes to this file need to come from the specification. You can generate this file by calling
$ npm run generate:bidi
from the project root. You can find the scripts that generates this file in ./scripts/bidi/**

type NetworkAuthRequiredParameters

type NetworkAuthRequiredParameters = NetworkBaseParameters & {
    response: NetworkResponseData;
};

type NetworkBeforeRequestSentParameters

type NetworkBeforeRequestSentParameters = NetworkBaseParameters & {
    initiator?: NetworkInitiator;
};

type NetworkBytesValue

type NetworkBytesValue = NetworkStringValue | NetworkBase64Value;

type NetworkCollector

type NetworkCollector = string;

type NetworkCollectorType

type NetworkCollectorType = 'blob';

type NetworkContinueRequestResult

type NetworkContinueRequestResult = EmptyResult;

type NetworkContinueResponseResult

type NetworkContinueResponseResult = EmptyResult;

type NetworkContinueWithAuthResult

type NetworkContinueWithAuthResult = EmptyResult;

type NetworkCookie

type NetworkCookie = Extensible & {
    name: string;
    value: NetworkBytesValue;
    domain: string;
    path: string;
    size: JsUint;
    httpOnly: boolean;
    secure: boolean;
    sameSite: NetworkSameSite;
    expiry?: JsUint;
};

type NetworkDataType

type NetworkDataType = 'request' | 'response';

type NetworkDisownDataResult

type NetworkDisownDataResult = EmptyResult;

type NetworkEvent

type NetworkEvent =
    | NetworkAuthRequired
    | NetworkBeforeRequestSent
    | NetworkFetchError
    | NetworkResponseCompleted
    | NetworkResponseStarted;

type NetworkFailRequestResult

type NetworkFailRequestResult = EmptyResult;

type NetworkFetchErrorParameters

type NetworkFetchErrorParameters = NetworkBaseParameters & {
    errorText: string;
};

type NetworkIntercept

type NetworkIntercept = string;

type NetworkProvideResponseResult

type NetworkProvideResponseResult = EmptyResult;

type NetworkRemoveDataCollectorResult

type NetworkRemoveDataCollectorResult = EmptyResult;

type NetworkRemoveInterceptResult

type NetworkRemoveInterceptResult = EmptyResult;

type NetworkRequest

type NetworkRequest = string;

type NetworkResponseCompletedParameters

type NetworkResponseCompletedParameters = NetworkBaseParameters & {
    response: NetworkResponseData;
};

type NetworkResponseStartedParameters

type NetworkResponseStartedParameters = NetworkBaseParameters & {
    response: NetworkResponseData;
};

type NetworkResult

type NetworkResult =
    | NetworkAddDataCollectorResult
    | NetworkAddInterceptResult
    | NetworkContinueRequestResult
    | NetworkContinueResponseResult
    | NetworkContinueWithAuthResult
    | NetworkDisownDataResult
    | NetworkFailRequestResult
    | NetworkGetDataResult
    | NetworkProvideResponseResult
    | NetworkRemoveDataCollectorResult
    | NetworkRemoveInterceptResult
    | NetworkSetCacheBehaviorResult
    | NetworkSetExtraHeadersResult;

type NetworkSameSite

type NetworkSameSite = 'strict' | 'lax' | 'none' | 'default';

type NetworkSetCacheBehaviorResult

type NetworkSetCacheBehaviorResult = EmptyResult;

type NetworkSetExtraHeadersResult

type NetworkSetExtraHeadersResult = EmptyResult;

type ResultData

type ResultData =
    | BrowserResult
    | BrowsingContextResult
    | EmulationResult
    | InputResult
    | NetworkResult
    | ScriptResult
    | SessionResult
    | StorageResult
    | WebExtensionResult;

type ScriptAudioWorkletRealmInfo

type ScriptAudioWorkletRealmInfo = ScriptBaseRealmInfo & {
    type: 'audio-worklet';
};

type ScriptCallFunctionResult

type ScriptCallFunctionResult = ScriptEvaluateResult;

type ScriptChannel

type ScriptChannel = string;

type ScriptDateRemoteValue

type ScriptDateRemoteValue = ScriptDateLocalValue & {
    handle?: ScriptHandle;
    internalId?: ScriptInternalId;
};

type ScriptDedicatedWorkerRealmInfo

type ScriptDedicatedWorkerRealmInfo = ScriptBaseRealmInfo & {
    type: 'dedicated-worker';
    owners: ScriptRealm[];
};

type ScriptDisownResult

type ScriptDisownResult = EmptyResult;

type ScriptEvaluateResult

type ScriptEvaluateResult =
    | ScriptEvaluateResultSuccess
    | ScriptEvaluateResultException;

type ScriptEvent

type ScriptEvent = ScriptMessage | ScriptRealmCreated | ScriptRealmDestroyed;

type ScriptHandle

type ScriptHandle = string;

type ScriptInternalId

type ScriptInternalId = string;

type ScriptListLocalValue

type ScriptListLocalValue = ScriptLocalValue[];

type ScriptListRemoteValue

type ScriptListRemoteValue = ScriptRemoteValue[];

type ScriptLocalValue

type ScriptLocalValue =
    | ScriptRemoteReference
    | ScriptPrimitiveProtocolValue
    | ScriptChannelValue
    | ScriptArrayLocalValue
    | ScriptDateLocalValue
    | ScriptMapLocalValue
    | ScriptObjectLocalValue
    | ScriptRegExpLocalValue
    | ScriptSetLocalValue;

type ScriptMappingLocalValue

type ScriptMappingLocalValue = (ScriptLocalValue | ScriptLocalValue)[];

type ScriptMappingRemoteValue

type ScriptMappingRemoteValue = (ScriptRemoteValue | ScriptRemoteValue)[];

type ScriptPaintWorkletRealmInfo

type ScriptPaintWorkletRealmInfo = ScriptBaseRealmInfo & {
    type: 'paint-worklet';
};

type ScriptPreloadScript

type ScriptPreloadScript = string;

type ScriptPrimitiveProtocolValue

type ScriptPrimitiveProtocolValue =
    | ScriptUndefinedValue
    | ScriptNullValue
    | ScriptStringValue
    | ScriptNumberValue
    | ScriptBooleanValue
    | ScriptBigIntValue;

type ScriptRealm

type ScriptRealm = string;

type ScriptRealmInfo

type ScriptRealmInfo =
    | ScriptWindowRealmInfo
    | ScriptDedicatedWorkerRealmInfo
    | ScriptSharedWorkerRealmInfo
    | ScriptServiceWorkerRealmInfo
    | ScriptWorkerRealmInfo
    | ScriptPaintWorkletRealmInfo
    | ScriptAudioWorkletRealmInfo
    | ScriptWorkletRealmInfo;

type ScriptRealmType

type ScriptRealmType =
    | 'window'
    | 'dedicated-worker'
    | 'shared-worker'
    | 'service-worker'
    | 'worker'
    | 'paint-worklet'
    | 'audio-worklet'
    | 'worklet';

type ScriptRegExpRemoteValue

type ScriptRegExpRemoteValue = ScriptRegExpLocalValue & {
    handle?: ScriptHandle;
    internalId?: ScriptInternalId;
};

type ScriptRemoteObjectReference

type ScriptRemoteObjectReference = Extensible & {
    handle: ScriptHandle;
    sharedId?: ScriptSharedId;
};

type ScriptRemoteReference

type ScriptRemoteReference = ScriptSharedReference | ScriptRemoteObjectReference;

type ScriptRemoteValue

type ScriptRemoteValue =
    | ScriptPrimitiveProtocolValue
    | ScriptSymbolRemoteValue
    | ScriptArrayRemoteValue
    | ScriptObjectRemoteValue
    | ScriptFunctionRemoteValue
    | ScriptRegExpRemoteValue
    | ScriptDateRemoteValue
    | ScriptMapRemoteValue
    | ScriptSetRemoteValue
    | ScriptWeakMapRemoteValue
    | ScriptWeakSetRemoteValue
    | ScriptGeneratorRemoteValue
    | ScriptErrorRemoteValue
    | ScriptProxyRemoteValue
    | ScriptPromiseRemoteValue
    | ScriptTypedArrayRemoteValue
    | ScriptArrayBufferRemoteValue
    | ScriptNodeListRemoteValue
    | ScriptHtmlCollectionRemoteValue
    | ScriptNodeRemoteValue
    | ScriptWindowProxyRemoteValue;

type ScriptRemovePreloadScriptResult

type ScriptRemovePreloadScriptResult = EmptyResult;

type ScriptResult

type ScriptResult =
    | ScriptAddPreloadScriptResult
    | ScriptCallFunctionResult
    | ScriptDisownResult
    | ScriptEvaluateResult
    | ScriptGetRealmsResult
    | ScriptRemovePreloadScriptResult;

type ScriptResultOwnership

type ScriptResultOwnership = 'root' | 'none';

type ScriptServiceWorkerRealmInfo

type ScriptServiceWorkerRealmInfo = ScriptBaseRealmInfo & {
    type: 'service-worker';
};

type ScriptSharedId

type ScriptSharedId = string;

type ScriptSharedReference

type ScriptSharedReference = Extensible & {
    sharedId: ScriptSharedId;
    handle?: ScriptHandle;
};

type ScriptSharedWorkerRealmInfo

type ScriptSharedWorkerRealmInfo = ScriptBaseRealmInfo & {
    type: 'shared-worker';
};

type ScriptSpecialNumber

type ScriptSpecialNumber = 'NaN' | '-0' | 'Infinity' | '-Infinity';

type ScriptWindowRealmInfo

type ScriptWindowRealmInfo = ScriptBaseRealmInfo & {
    type: 'window';
    context: BrowsingContextBrowsingContext;
    userContext?: BrowserUserContext;
    sandbox?: string;
};

type ScriptWorkerRealmInfo

type ScriptWorkerRealmInfo = ScriptBaseRealmInfo & {
    type: 'worker';
};

type ScriptWorkletRealmInfo

type ScriptWorkletRealmInfo = ScriptBaseRealmInfo & {
    type: 'worklet';
};

type SessionAutodetectProxyConfiguration

type SessionAutodetectProxyConfiguration = Extensible & {
    proxyType: 'autodetect';
};

type SessionCapabilityRequest

type SessionCapabilityRequest = Extensible & {
    acceptInsecureCerts?: boolean;
    browserName?: string;
    browserVersion?: string;
    platformName?: string;
    proxy?: SessionProxyConfiguration;
    unhandledPromptBehavior?: SessionUserPromptHandler;
};

type SessionDirectProxyConfiguration

type SessionDirectProxyConfiguration = Extensible & {
    proxyType: 'direct';
};

type SessionEndResult

type SessionEndResult = EmptyResult;

type SessionManualProxyConfiguration

type SessionManualProxyConfiguration = SessionSocksProxyConfiguration &
    Extensible & {
        proxyType: 'manual';
        httpProxy?: string;
        sslProxy?: string;
        noProxy?: string[];
    };

type SessionPacProxyConfiguration

type SessionPacProxyConfiguration = Extensible & {
    proxyType: 'pac';
    proxyAutoconfigUrl: string;
};

type SessionProxyConfiguration

type SessionProxyConfiguration =
    | SessionAutodetectProxyConfiguration
    | SessionDirectProxyConfiguration
    | SessionManualProxyConfiguration
    | SessionPacProxyConfiguration
    | SessionSystemProxyConfiguration;

type SessionResult

type SessionResult =
    | SessionEndResult
    | SessionNewResult
    | SessionStatusResult
    | SessionSubscribeResult
    | SessionUnsubscribeResult;

type SessionSubscription

type SessionSubscription = string;

type SessionSystemProxyConfiguration

type SessionSystemProxyConfiguration = Extensible & {
    proxyType: 'system';
};

type SessionUnsubscribeResult

type SessionUnsubscribeResult = EmptyResult;

type SessionUserPromptHandlerType

type SessionUserPromptHandlerType = 'accept' | 'dismiss' | 'ignore';

type StoragePartitionKey

type StoragePartitionKey = Extensible & {
    userContext?: string;
    sourceOrigin?: string;
};

type StorageResult

type StorageResult =
    | StorageDeleteCookiesResult
    | StorageGetCookiesResult
    | StorageSetCookieResult;

type WebExtensionExtension

type WebExtensionExtension = string;

type WebExtensionResult

type WebExtensionResult = WebExtensionInstallResult | WebExtensionUninstallResult;

type WebExtensionUninstallResult

type WebExtensionUninstallResult = EmptyResult;

namespace remote

module 'build/bidi/remoteTypes.d.ts' {}

!!! PLEASE DO NOT EDIT THIS FILE !!!
This source file, even though checked in, is auto-generated based on the current development within the WebDriver Bidi spec. Any changes to this file need to come from the specification. You can generate this file by calling
$ npm run generate:bidi
from the project root. You can find the scripts that generates this file in ./scripts/bidi/**

interface BrowserClientWindowInfo

interface BrowserClientWindowInfo {}

property active

active: boolean;

property clientWindow

clientWindow: BrowserClientWindow;

property height

height: JsUint;

property state

state: 'fullscreen' | 'maximized' | 'minimized' | 'normal';

property width

width: JsUint;

property x

x: JsInt;

property y

y: JsInt;

interface BrowserClientWindowNamedState

interface BrowserClientWindowNamedState {}

property state

state: 'fullscreen' | 'maximized' | 'minimized';

interface BrowserClientWindowRectState

interface BrowserClientWindowRectState {}

property height

height?: JsUint;

property state

state: 'normal';

property width

width?: JsUint;

property x

x?: JsInt;

property y

y?: JsInt;

interface BrowserClose

interface BrowserClose {}

property method

method: 'browser.close';

property params

params: EmptyParams;

interface BrowserCreateUserContext

interface BrowserCreateUserContext {}

property method

method: 'browser.createUserContext';

property params

params: BrowserCreateUserContextParameters;

interface BrowserCreateUserContextParameters

interface BrowserCreateUserContextParameters {}

property acceptInsecureCerts

acceptInsecureCerts?: boolean;

property proxy

proxy?: SessionProxyConfiguration;

property unhandledPromptBehavior

unhandledPromptBehavior?: SessionUserPromptHandler;

interface BrowserDownloadBehaviorAllowed

interface BrowserDownloadBehaviorAllowed {}

property destinationFolder

destinationFolder: string;

property type

type: 'allowed';

interface BrowserDownloadBehaviorDenied

interface BrowserDownloadBehaviorDenied {}

property type

type: 'denied';

interface BrowserGetClientWindows

interface BrowserGetClientWindows {}

property method

method: 'browser.getClientWindows';

property params

params: EmptyParams;

interface BrowserGetUserContexts

interface BrowserGetUserContexts {}

property method

method: 'browser.getUserContexts';

property params

params: EmptyParams;

interface BrowserRemoveUserContext

interface BrowserRemoveUserContext {}

property method

method: 'browser.removeUserContext';

property params

params: BrowserRemoveUserContextParameters;

interface BrowserRemoveUserContextParameters

interface BrowserRemoveUserContextParameters {}

property userContext

userContext: BrowserUserContext;

interface BrowserSetClientWindowState

interface BrowserSetClientWindowState {}

property method

method: 'browser.setClientWindowState';

property params

params: BrowserSetClientWindowStateParameters;

interface BrowserSetDownloadBehavior

interface BrowserSetDownloadBehavior {}

property method

method: 'browser.setDownloadBehavior';

property params

params: BrowserSetDownloadBehaviorParameters;

interface BrowserSetDownloadBehaviorParameters

interface BrowserSetDownloadBehaviorParameters {}

property downloadBehavior

downloadBehavior: BrowserDownloadBehavior | null;

property userContexts

userContexts?: BrowserUserContext[];

interface BrowserUserContextInfo

interface BrowserUserContextInfo {}

property userContext

userContext: BrowserUserContext;

interface BrowsingContextAccessibilityLocator

interface BrowsingContextAccessibilityLocator {}

property type

type: 'accessibility';

property value

value: {
    name?: string;
    role?: string;
};

interface BrowsingContextActivate

interface BrowsingContextActivate {}

property method

method: 'browsingContext.activate';

property params

params: BrowsingContextActivateParameters;

interface BrowsingContextActivateParameters

interface BrowsingContextActivateParameters {}

property context

context: BrowsingContextBrowsingContext;

interface BrowsingContextBoxClipRectangle

interface BrowsingContextBoxClipRectangle {}

property height

height: number;

property type

type: 'box';

property width

width: number;

property x

x: number;

property y

y: number;

interface BrowsingContextCaptureScreenshot

interface BrowsingContextCaptureScreenshot {}

property method

method: 'browsingContext.captureScreenshot';

property params

params: BrowsingContextCaptureScreenshotParameters;

interface BrowsingContextCaptureScreenshotParameters

interface BrowsingContextCaptureScreenshotParameters {}

property clip

clip?: BrowsingContextClipRectangle;

property context

context: BrowsingContextBrowsingContext;

property format

format?: BrowsingContextImageFormat;

property origin

origin?: 'viewport' | 'document';

'viewport'

interface BrowsingContextClose

interface BrowsingContextClose {}

property method

method: 'browsingContext.close';

property params

params: BrowsingContextCloseParameters;

interface BrowsingContextCloseParameters

interface BrowsingContextCloseParameters {}

property context

context: BrowsingContextBrowsingContext;

property promptUnload

promptUnload?: boolean;

interface BrowsingContextContextLocator

interface BrowsingContextContextLocator {}

property type

type: 'context';

property value

value: {
    context: BrowsingContextBrowsingContext;
};

interface BrowsingContextCreate

interface BrowsingContextCreate {}

property method

method: 'browsingContext.create';

property params

params: BrowsingContextCreateParameters;

interface BrowsingContextCreateParameters

interface BrowsingContextCreateParameters {}

property background

background?: boolean;

property referenceContext

referenceContext?: BrowsingContextBrowsingContext;

property type

type: BrowsingContextCreateType;

property userContext

userContext?: BrowserUserContext;

interface BrowsingContextCssLocator

interface BrowsingContextCssLocator {}

property type

type: 'css';

property value

value: string;

interface BrowsingContextElementClipRectangle

interface BrowsingContextElementClipRectangle {}

property element

element: ScriptSharedReference;

property type

type: 'element';

interface BrowsingContextGetTree

interface BrowsingContextGetTree {}

property method

method: 'browsingContext.getTree';

property params

params: BrowsingContextGetTreeParameters;

interface BrowsingContextGetTreeParameters

interface BrowsingContextGetTreeParameters {}

property maxDepth

maxDepth?: JsUint;

property root

root?: BrowsingContextBrowsingContext;

interface BrowsingContextHandleUserPrompt

interface BrowsingContextHandleUserPrompt {}

property method

method: 'browsingContext.handleUserPrompt';

property params

params: BrowsingContextHandleUserPromptParameters;

interface BrowsingContextHandleUserPromptParameters

interface BrowsingContextHandleUserPromptParameters {}

property accept

accept?: boolean;

property context

context: BrowsingContextBrowsingContext;

property userText

userText?: string;

interface BrowsingContextImageFormat

interface BrowsingContextImageFormat {}

property quality

quality?: number;

property type

type: string;

interface BrowsingContextInnerTextLocator

interface BrowsingContextInnerTextLocator {}

property ignoreCase

ignoreCase?: boolean;

property matchType

matchType?: 'full' | 'partial';

property maxDepth

maxDepth?: JsUint;

property type

type: 'innerText';

property value

value: string;

interface BrowsingContextLocateNodes

interface BrowsingContextLocateNodes {}

property method

method: 'browsingContext.locateNodes';

property params

params: BrowsingContextLocateNodesParameters;

interface BrowsingContextLocateNodesParameters

interface BrowsingContextLocateNodesParameters {}

property context

context: BrowsingContextBrowsingContext;

property locator

locator: BrowsingContextLocator;

property maxNodeCount

maxNodeCount?: JsUint;

property serializationOptions

serializationOptions?: ScriptSerializationOptions;

property startNodes

startNodes?: ScriptSharedReference[];

interface BrowsingContextNavigate

interface BrowsingContextNavigate {}

property method

method: 'browsingContext.navigate';

property params

params: BrowsingContextNavigateParameters;

interface BrowsingContextNavigateParameters

interface BrowsingContextNavigateParameters {}

property context

context: BrowsingContextBrowsingContext;

property url

url: string;

property wait

wait?: BrowsingContextReadinessState;

interface BrowsingContextPrint

interface BrowsingContextPrint {}

property method

method: 'browsingContext.print';

property params

params: BrowsingContextPrintParameters;

interface BrowsingContextPrintMarginParameters

interface BrowsingContextPrintMarginParameters {}

property bottom

bottom?: number;

property left

left?: number;

property right

right?: number;

property top

top?: number;

interface BrowsingContextPrintPageParameters

interface BrowsingContextPrintPageParameters {}

property height

height?: number;

27.94

property width

width?: number;

21.59

interface BrowsingContextPrintParameters

interface BrowsingContextPrintParameters {}

property background

background?: boolean;

property context

context: BrowsingContextBrowsingContext;

property margin

margin?: BrowsingContextPrintMarginParameters;

property orientation

orientation?: 'portrait' | 'landscape';

'portrait'

property page

page?: BrowsingContextPrintPageParameters;

property pageRanges

pageRanges?: (JsUint | string)[];

property scale

scale?: number;

property shrinkToFit

shrinkToFit?: boolean;

true

interface BrowsingContextReload

interface BrowsingContextReload {}

property method

method: 'browsingContext.reload';

property params

params: BrowsingContextReloadParameters;

interface BrowsingContextReloadParameters

interface BrowsingContextReloadParameters {}

property context

context: BrowsingContextBrowsingContext;

property ignoreCache

ignoreCache?: boolean;

property wait

wait?: BrowsingContextReadinessState;

interface BrowsingContextSetBypassCsp

interface BrowsingContextSetBypassCsp {}

property method

method: 'browsingContext.setBypassCSP';

property params

params: BrowsingContextSetBypassCspParameters;

interface BrowsingContextSetBypassCspParameters

interface BrowsingContextSetBypassCspParameters {}

property bypass

bypass: true | null;

property contexts

contexts?: BrowsingContextBrowsingContext[];

property userContexts

userContexts?: BrowserUserContext[];

interface BrowsingContextSetViewport

interface BrowsingContextSetViewport {}

property method

method: 'browsingContext.setViewport';

property params

params: BrowsingContextSetViewportParameters;

interface BrowsingContextSetViewportParameters

interface BrowsingContextSetViewportParameters {}

property context

context?: BrowsingContextBrowsingContext;

property devicePixelRatio

devicePixelRatio?: number | null;

property userContexts

userContexts?: BrowserUserContext[];

property viewport

viewport?: BrowsingContextViewport | null;

interface BrowsingContextTraverseHistory

interface BrowsingContextTraverseHistory {}

property method

method: 'browsingContext.traverseHistory';

property params

params: BrowsingContextTraverseHistoryParameters;

interface BrowsingContextTraverseHistoryParameters

interface BrowsingContextTraverseHistoryParameters {}

property context

context: BrowsingContextBrowsingContext;

property delta

delta: JsInt;

interface BrowsingContextViewport

interface BrowsingContextViewport {}

property height

height: JsUint;

property width

width: JsUint;

interface BrowsingContextXPathLocator

interface BrowsingContextXPathLocator {}

property type

type: 'xpath';

property value

value: string;

interface EmulationGeolocationCoordinates

interface EmulationGeolocationCoordinates {}

property accuracy

accuracy?: number;

property altitude

altitude?: number | null;

null

property altitudeAccuracy

altitudeAccuracy?: number | null;

null

property heading

heading?: number | null;

null

property latitude

latitude: number;

property longitude

longitude: number;

property speed

speed?: number | null;

null

interface EmulationGeolocationPositionError

interface EmulationGeolocationPositionError {}

property type

type: 'positionUnavailable';

interface EmulationNetworkConditionsOffline

interface EmulationNetworkConditionsOffline {}

property type

type: 'offline';

interface EmulationScreenArea

interface EmulationScreenArea {}

property height

height: JsUint;

property width

width: JsUint;

interface EmulationScreenOrientation

interface EmulationScreenOrientation {}

property natural

natural: EmulationScreenOrientationNatural;

property type

type: EmulationScreenOrientationType;

interface EmulationSetForcedColorsModeThemeOverride

interface EmulationSetForcedColorsModeThemeOverride {}

property method

method: 'emulation.setForcedColorsModeThemeOverride';

property params

params: EmulationSetForcedColorsModeThemeOverrideParameters;

interface EmulationSetForcedColorsModeThemeOverrideParameters

interface EmulationSetForcedColorsModeThemeOverrideParameters {}

property contexts

contexts?: BrowsingContextBrowsingContext[];

property theme

theme: EmulationForcedColorsModeTheme | null;

property userContexts

userContexts?: BrowserUserContext[];

interface EmulationSetGeolocationOverride

interface EmulationSetGeolocationOverride {}

property method

method: 'emulation.setGeolocationOverride';

property params

params: EmulationSetGeolocationOverrideParameters;

interface EmulationSetLocaleOverride

interface EmulationSetLocaleOverride {}

property method

method: 'emulation.setLocaleOverride';

property params

params: EmulationSetLocaleOverrideParameters;

interface EmulationSetLocaleOverrideParameters

interface EmulationSetLocaleOverrideParameters {}

property contexts

contexts?: BrowsingContextBrowsingContext[];

property locale

locale: string | null;

property userContexts

userContexts?: BrowserUserContext[];

interface EmulationSetNetworkConditions

interface EmulationSetNetworkConditions {}

property method

method: 'emulation.setNetworkConditions';

property params

params: EmulationSetNetworkConditionsParameters;

interface EmulationSetNetworkConditionsParameters

interface EmulationSetNetworkConditionsParameters {}

property contexts

contexts?: BrowsingContextBrowsingContext[];

property networkConditions

networkConditions: EmulationNetworkConditions | null;

property userContexts

userContexts?: BrowserUserContext[];

interface EmulationSetScreenOrientationOverride

interface EmulationSetScreenOrientationOverride {}

property method

method: 'emulation.setScreenOrientationOverride';

property params

params: EmulationSetScreenOrientationOverrideParameters;

interface EmulationSetScreenOrientationOverrideParameters

interface EmulationSetScreenOrientationOverrideParameters {}

property contexts

contexts?: BrowsingContextBrowsingContext[];

property screenOrientation

screenOrientation: EmulationScreenOrientation | null;

property userContexts

userContexts?: BrowserUserContext[];

interface EmulationSetScreenSettingsOverride

interface EmulationSetScreenSettingsOverride {}

property method

method: 'emulation.setScreenSettingsOverride';

property params

params: EmulationSetScreenSettingsOverrideParameters;

interface EmulationSetScreenSettingsOverrideParameters

interface EmulationSetScreenSettingsOverrideParameters {}

property contexts

contexts?: BrowsingContextBrowsingContext[];

property screenArea

screenArea: EmulationScreenArea | null;

property userContexts

userContexts?: BrowserUserContext[];

interface EmulationSetScriptingEnabled

interface EmulationSetScriptingEnabled {}

property method

method: 'emulation.setScriptingEnabled';

property params

params: EmulationSetScriptingEnabledParameters;

interface EmulationSetScriptingEnabledParameters

interface EmulationSetScriptingEnabledParameters {}

property contexts

contexts?: BrowsingContextBrowsingContext[];

property enabled

enabled: false | null;

property userContexts

userContexts?: BrowserUserContext[];

interface EmulationSetScrollbarTypeOverride

interface EmulationSetScrollbarTypeOverride {}

property method

method: 'emulation.setScrollbarTypeOverride';

property params

params: EmulationSetScrollbarTypeOverrideParameters;

interface EmulationSetScrollbarTypeOverrideParameters

interface EmulationSetScrollbarTypeOverrideParameters {}

property contexts

contexts?: BrowsingContextBrowsingContext[];

property scrollbarType

scrollbarType: 'classic' | 'overlay' | null;

property userContexts

userContexts?: BrowserUserContext[];

interface EmulationSetTimezoneOverride

interface EmulationSetTimezoneOverride {}

property method

method: 'emulation.setTimezoneOverride';

property params

params: EmulationSetTimezoneOverrideParameters;

interface EmulationSetTimezoneOverrideParameters

interface EmulationSetTimezoneOverrideParameters {}

property contexts

contexts?: BrowsingContextBrowsingContext[];

property timezone

timezone: string | null;

property userContexts

userContexts?: BrowserUserContext[];

interface EmulationSetTouchOverride

interface EmulationSetTouchOverride {}

property method

method: 'emulation.setTouchOverride';

property params

params: EmulationSetTouchOverrideParameters;

interface EmulationSetTouchOverrideParameters

interface EmulationSetTouchOverrideParameters {}

property contexts

contexts?: BrowsingContextBrowsingContext[];

property maxTouchPoints

maxTouchPoints: JsUint | null;

property userContexts

userContexts?: BrowserUserContext[];

interface EmulationSetUserAgentOverride

interface EmulationSetUserAgentOverride {}

property method

method: 'emulation.setUserAgentOverride';

property params

params: EmulationSetUserAgentOverrideParameters;

interface EmulationSetUserAgentOverrideParameters

interface EmulationSetUserAgentOverrideParameters {}

property contexts

contexts?: BrowsingContextBrowsingContext[];

property userAgent

userAgent: string | null;

property userContexts

userContexts?: BrowserUserContext[];

interface InputElementOrigin

interface InputElementOrigin {}

property element

element: ScriptSharedReference;

property type

type: 'element';

interface InputKeyDownAction

interface InputKeyDownAction {}

property type

type: 'keyDown';

property value

value: string;

interface InputKeySourceActions

interface InputKeySourceActions {}

property actions

actions: InputKeySourceAction[];

property id

id: string;

property type

type: 'key';

interface InputKeyUpAction

interface InputKeyUpAction {}

property type

type: 'keyUp';

property value

value: string;

interface InputNoneSourceActions

interface InputNoneSourceActions {}

property actions

actions: InputNoneSourceAction[];

property id

id: string;

property type

type: 'none';

interface InputPauseAction

interface InputPauseAction {}

property duration

duration?: JsUint;

property type

type: 'pause';

interface InputPerformActions

interface InputPerformActions {}

property method

method: 'input.performActions';

property params

params: InputPerformActionsParameters;

interface InputPerformActionsParameters

interface InputPerformActionsParameters {}

property actions

actions: InputSourceActions[];

property context

context: BrowsingContextBrowsingContext;

interface InputPointerCommonProperties

interface InputPointerCommonProperties {}

property altitudeAngle

altitudeAngle?: number;

0 .. 2 * Math.PI

property azimuthAngle

azimuthAngle?: number;

property height

height?: JsUint;

property pressure

pressure?: number;

property tangentialPressure

tangentialPressure?: number;

property twist

twist?: number;

0 .. Math.PI / 2

property width

width?: JsUint;

interface InputPointerParameters

interface InputPointerParameters {}

property pointerType

pointerType?: InputPointerType;

'mouse'

interface InputPointerSourceActions

interface InputPointerSourceActions {}

property actions

actions: InputPointerSourceAction[];

property id

id: string;

property parameters

parameters?: InputPointerParameters;

property type

type: 'pointer';

interface InputPointerUpAction

interface InputPointerUpAction {}

property button

button: JsUint;

property type

type: 'pointerUp';

interface InputReleaseActions

interface InputReleaseActions {}

property method

method: 'input.releaseActions';

property params

params: InputReleaseActionsParameters;

interface InputReleaseActionsParameters

interface InputReleaseActionsParameters {}

property context

context: BrowsingContextBrowsingContext;

interface InputSetFiles

interface InputSetFiles {}

property method

method: 'input.setFiles';

property params

params: InputSetFilesParameters;

interface InputSetFilesParameters

interface InputSetFilesParameters {}

property context

context: BrowsingContextBrowsingContext;

property element

element: ScriptSharedReference;

property files

files: string[];

interface InputWheelScrollAction

interface InputWheelScrollAction {}

property deltaX

deltaX: JsInt;

property deltaY

deltaY: JsInt;

property duration

duration?: JsUint;

property origin

origin?: InputOrigin;

'viewport'

property type

type: 'scroll';

property x

x: JsInt;

property y

y: JsInt;

interface InputWheelSourceActions

interface InputWheelSourceActions {}

property actions

actions: InputWheelSourceAction[];

property id

id: string;

property type

type: 'wheel';

interface NetworkAddDataCollector

interface NetworkAddDataCollector {}

property method

method: 'network.addDataCollector';

property params

params: NetworkAddDataCollectorParameters;

interface NetworkAddDataCollectorParameters

interface NetworkAddDataCollectorParameters {}

property collectorType

collectorType?: NetworkCollectorType;

'blob'

property contexts

contexts?: BrowsingContextBrowsingContext[];

property dataTypes

dataTypes: NetworkDataType[];

property maxEncodedDataSize

maxEncodedDataSize: JsUint;

property userContexts

userContexts?: BrowserUserContext[];

interface NetworkAddIntercept

interface NetworkAddIntercept {}

property method

method: 'network.addIntercept';

property params

params: NetworkAddInterceptParameters;

interface NetworkAddInterceptParameters

interface NetworkAddInterceptParameters {}

property contexts

contexts?: BrowsingContextBrowsingContext[];

property phases

phases: NetworkInterceptPhase[];

property urlPatterns

urlPatterns?: NetworkUrlPattern[];

interface NetworkAuthCredentials

interface NetworkAuthCredentials {}

property password

password: string;

property type

type: 'password';

property username

username: string;

interface NetworkBase64Value

interface NetworkBase64Value {}

property type

type: 'base64';

property value

value: string;

interface NetworkContinueRequest

interface NetworkContinueRequest {}

property method

method: 'network.continueRequest';

property params

params: NetworkContinueRequestParameters;

interface NetworkContinueRequestParameters

interface NetworkContinueRequestParameters {}

property body

body?: NetworkBytesValue;

property cookies

cookies?: NetworkCookieHeader[];

property headers

headers?: NetworkHeader[];

property method

method?: string;

property request

request: NetworkRequest;

property url

url?: string;

interface NetworkContinueResponse

interface NetworkContinueResponse {}

property method

method: 'network.continueResponse';

property params

params: NetworkContinueResponseParameters;

interface NetworkContinueResponseParameters

interface NetworkContinueResponseParameters {}

property cookies

cookies?: NetworkSetCookieHeader[];

property credentials

credentials?: NetworkAuthCredentials;

property headers

headers?: NetworkHeader[];

property reasonPhrase

reasonPhrase?: string;

property request

request: NetworkRequest;

property statusCode

statusCode?: JsUint;

interface NetworkContinueWithAuth

interface NetworkContinueWithAuth {}

property method

method: 'network.continueWithAuth';

property params

params: NetworkContinueWithAuthParameters;

interface NetworkContinueWithAuthCredentials

interface NetworkContinueWithAuthCredentials {}

property action

action: 'provideCredentials';

property credentials

credentials: NetworkAuthCredentials;

interface NetworkContinueWithAuthNoCredentials

interface NetworkContinueWithAuthNoCredentials {}

property action

action: 'default' | 'cancel';

interface NetworkCookieHeader

interface NetworkCookieHeader {}

property name

name: string;

property value

value: NetworkBytesValue;

interface NetworkDisownData

interface NetworkDisownData {}

property method

method: 'network.disownData';

property params

params: NetworkDisownDataParameters;

interface NetworkDisownDataParameters

interface NetworkDisownDataParameters {}

property collector

collector: NetworkCollector;

property dataType

dataType: NetworkDataType;

property request

request: NetworkRequest;

interface NetworkFailRequest

interface NetworkFailRequest {}

property method

method: 'network.failRequest';

property params

params: NetworkFailRequestParameters;

interface NetworkFailRequestParameters

interface NetworkFailRequestParameters {}

property request

request: NetworkRequest;

interface NetworkGetData

interface NetworkGetData {}

property method

method: 'network.getData';

property params

params: NetworkGetDataParameters;

interface NetworkGetDataParameters

interface NetworkGetDataParameters {}

property collector

collector?: NetworkCollector;

property dataType

dataType: NetworkDataType;

property disown

disown?: boolean;

property request

request: NetworkRequest;

interface NetworkHeader

interface NetworkHeader {}

property name

name: string;

property value

value: NetworkBytesValue;

interface NetworkProvideResponse

interface NetworkProvideResponse {}

property method

method: 'network.provideResponse';

property params

params: NetworkProvideResponseParameters;

interface NetworkProvideResponseParameters

interface NetworkProvideResponseParameters {}

property body

body?: NetworkBytesValue;

property cookies

cookies?: NetworkSetCookieHeader[];

property headers

headers?: NetworkHeader[];

property reasonPhrase

reasonPhrase?: string;

property request

request: NetworkRequest;

property statusCode

statusCode?: JsUint;

interface NetworkRemoveDataCollector

interface NetworkRemoveDataCollector {}

property method

method: 'network.removeDataCollector';

property params

params: NetworkRemoveDataCollectorParameters;

interface NetworkRemoveDataCollectorParameters

interface NetworkRemoveDataCollectorParameters {}

property collector

collector: NetworkCollector;

interface NetworkRemoveIntercept

interface NetworkRemoveIntercept {}

property method

method: 'network.removeIntercept';

property params

params: NetworkRemoveInterceptParameters;

interface NetworkRemoveInterceptParameters

interface NetworkRemoveInterceptParameters {}

property intercept

intercept: NetworkIntercept;

interface NetworkSetCacheBehavior

interface NetworkSetCacheBehavior {}

property method

method: 'network.setCacheBehavior';

property params

params: NetworkSetCacheBehaviorParameters;

interface NetworkSetCacheBehaviorParameters

interface NetworkSetCacheBehaviorParameters {}

property cacheBehavior

cacheBehavior: 'default' | 'bypass';

property contexts

contexts?: BrowsingContextBrowsingContext[];

interface NetworkSetCookieHeader

interface NetworkSetCookieHeader {}

property domain

domain?: string;

property expiry

expiry?: string;

property httpOnly

httpOnly?: boolean;

property maxAge

maxAge?: JsInt;

property name

name: string;

property path

path?: string;

property sameSite

sameSite?: NetworkSameSite;

property secure

secure?: boolean;

property value

value: NetworkBytesValue;

interface NetworkSetExtraHeaders

interface NetworkSetExtraHeaders {}

property method

method: 'network.setExtraHeaders';

property params

params: NetworkSetExtraHeadersParameters;

interface NetworkSetExtraHeadersParameters

interface NetworkSetExtraHeadersParameters {}

property contexts

contexts?: BrowsingContextBrowsingContext[];

property headers

headers: NetworkHeader[];

property userContexts

userContexts?: BrowserUserContext[];

interface NetworkStringValue

interface NetworkStringValue {}

property type

type: 'string';

property value

value: string;

interface NetworkUrlPatternPattern

interface NetworkUrlPatternPattern {}

property hostname

hostname?: string;

property pathname

pathname?: string;

property port

port?: string;

property protocol

protocol?: string;

property search

search?: string;

property type

type: 'pattern';

interface NetworkUrlPatternString

interface NetworkUrlPatternString {}

property pattern

pattern: string;

property type

type: 'string';

interface ScriptAddPreloadScript

interface ScriptAddPreloadScript {}

property method

method: 'script.addPreloadScript';

property params

params: ScriptAddPreloadScriptParameters;

interface ScriptAddPreloadScriptParameters

interface ScriptAddPreloadScriptParameters {}

property arguments

arguments?: ScriptChannelValue[];

property contexts

contexts?: BrowsingContextBrowsingContext[];

property functionDeclaration

functionDeclaration: string;

property sandbox

sandbox?: string;

property userContexts

userContexts?: BrowserUserContext[];

interface ScriptArrayBufferRemoteValue

interface ScriptArrayBufferRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'arraybuffer';

interface ScriptArrayLocalValue

interface ScriptArrayLocalValue {}

property type

type: 'array';

property value

value: ScriptListLocalValue;

interface ScriptArrayRemoteValue

interface ScriptArrayRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'array';

property value

value?: ScriptListRemoteValue;

interface ScriptBigIntValue

interface ScriptBigIntValue {}

property type

type: 'bigint';

property value

value: string;

interface ScriptBooleanValue

interface ScriptBooleanValue {}

property type

type: 'boolean';

property value

value: boolean;

interface ScriptCallFunction

interface ScriptCallFunction {}

property method

method: 'script.callFunction';

property params

params: ScriptCallFunctionParameters;

interface ScriptCallFunctionParameters

interface ScriptCallFunctionParameters {}

property arguments

arguments?: ScriptLocalValue[];

property awaitPromise

awaitPromise: boolean;

property functionDeclaration

functionDeclaration: string;

property resultOwnership

resultOwnership?: ScriptResultOwnership;

property serializationOptions

serializationOptions?: ScriptSerializationOptions;

property target

target: ScriptTarget;

property this

this?: ScriptLocalValue;

property userActivation

userActivation?: boolean;

interface ScriptChannelProperties

interface ScriptChannelProperties {}

property channel

channel: ScriptChannel;

property ownership

ownership?: ScriptResultOwnership;

property serializationOptions

serializationOptions?: ScriptSerializationOptions;

interface ScriptChannelValue

interface ScriptChannelValue {}

property type

type: 'channel';

property value

value: ScriptChannelProperties;

interface ScriptContextTarget

interface ScriptContextTarget {}

property context

context: BrowsingContextBrowsingContext;

property sandbox

sandbox?: string;

interface ScriptDateLocalValue

interface ScriptDateLocalValue {}

property type

type: 'date';

property value

value: string;

interface ScriptDisown

interface ScriptDisown {}

property method

method: 'script.disown';

property params

params: ScriptDisownParameters;

interface ScriptDisownParameters

interface ScriptDisownParameters {}

property handles

handles: ScriptHandle[];

property target

target: ScriptTarget;

interface ScriptErrorRemoteValue

interface ScriptErrorRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'error';

interface ScriptEvaluate

interface ScriptEvaluate {}

property method

method: 'script.evaluate';

property params

params: ScriptEvaluateParameters;

interface ScriptEvaluateParameters

interface ScriptEvaluateParameters {}

property awaitPromise

awaitPromise: boolean;

property expression

expression: string;

property resultOwnership

resultOwnership?: ScriptResultOwnership;

property serializationOptions

serializationOptions?: ScriptSerializationOptions;

property target

target: ScriptTarget;

property userActivation

userActivation?: boolean;

interface ScriptEvaluateResultException

interface ScriptEvaluateResultException {}

property exceptionDetails

exceptionDetails: ScriptExceptionDetails;

property realm

realm: ScriptRealm;

property type

type: 'exception';

interface ScriptEvaluateResultSuccess

interface ScriptEvaluateResultSuccess {}

property realm

realm: ScriptRealm;

property result

result: ScriptRemoteValue;

property type

type: 'success';

interface ScriptExceptionDetails

interface ScriptExceptionDetails {}

property columnNumber

columnNumber: JsUint;

property exception

exception: ScriptRemoteValue;

property lineNumber

lineNumber: JsUint;

property stackTrace

stackTrace: ScriptStackTrace;

property text

text: string;

interface ScriptFunctionRemoteValue

interface ScriptFunctionRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'function';

interface ScriptGeneratorRemoteValue

interface ScriptGeneratorRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'generator';

interface ScriptGetRealms

interface ScriptGetRealms {}

property method

method: 'script.getRealms';

property params

params: ScriptGetRealmsParameters;

interface ScriptGetRealmsParameters

interface ScriptGetRealmsParameters {}

property context

context?: BrowsingContextBrowsingContext;

property type

type?: ScriptRealmType;

interface ScriptHtmlCollectionRemoteValue

interface ScriptHtmlCollectionRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'htmlcollection';

property value

value?: ScriptListRemoteValue;

interface ScriptMapLocalValue

interface ScriptMapLocalValue {}

property type

type: 'map';

property value

value: ScriptMappingLocalValue;

interface ScriptMapRemoteValue

interface ScriptMapRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'map';

property value

value?: ScriptMappingRemoteValue;

interface ScriptNodeListRemoteValue

interface ScriptNodeListRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'nodelist';

property value

value?: ScriptListRemoteValue;

interface ScriptNodeProperties

interface ScriptNodeProperties {}

property attributes

attributes?: Record<string, string>;

property childNodeCount

childNodeCount: JsUint;

property children

children?: ScriptNodeRemoteValue[];

property localName

localName?: string;

property mode

mode?: 'open' | 'closed';

property namespaceUri

namespaceUri?: string;

property nodeType

nodeType: JsUint;

property nodeValue

nodeValue?: string;

property shadowRoot

shadowRoot?: ScriptNodeRemoteValue | null;

interface ScriptNodeRemoteValue

interface ScriptNodeRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property sharedId

sharedId?: ScriptSharedId;

property type

type: 'node';

property value

value?: ScriptNodeProperties;

interface ScriptNullValue

interface ScriptNullValue {}

property type

type: null;

interface ScriptNumberValue

interface ScriptNumberValue {}

property type

type: 'number';

property value

value: number | ScriptSpecialNumber;

interface ScriptObjectLocalValue

interface ScriptObjectLocalValue {}

property type

type: 'object';

property value

value: ScriptMappingLocalValue;

interface ScriptObjectRemoteValue

interface ScriptObjectRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'object';

property value

value?: ScriptMappingRemoteValue;

interface ScriptPromiseRemoteValue

interface ScriptPromiseRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'promise';

interface ScriptProxyRemoteValue

interface ScriptProxyRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'proxy';

interface ScriptRealmTarget

interface ScriptRealmTarget {}

property realm

realm: ScriptRealm;

interface ScriptRegExpLocalValue

interface ScriptRegExpLocalValue {}

property type

type: 'regexp';

property value

value: ScriptRegExpValue;

interface ScriptRegExpValue

interface ScriptRegExpValue {}

property flags

flags?: string;

property pattern

pattern: string;

interface ScriptRemovePreloadScript

interface ScriptRemovePreloadScript {}

property method

method: 'script.removePreloadScript';

property params

params: ScriptRemovePreloadScriptParameters;

interface ScriptRemovePreloadScriptParameters

interface ScriptRemovePreloadScriptParameters {}

property script

script: ScriptPreloadScript;

interface ScriptSerializationOptions

interface ScriptSerializationOptions {}

property includeShadowTree

includeShadowTree?: 'none' | 'open' | 'all';

'none'

property maxDomDepth

maxDomDepth?: JsUint | null;

property maxObjectDepth

maxObjectDepth?: JsUint | null;

null

interface ScriptSetLocalValue

interface ScriptSetLocalValue {}

property type

type: 'set';

property value

value: ScriptListLocalValue;

interface ScriptSetRemoteValue

interface ScriptSetRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'set';

property value

value?: ScriptListRemoteValue;

interface ScriptStackFrame

interface ScriptStackFrame {}

property columnNumber

columnNumber: JsUint;

property functionName

functionName: string;

property lineNumber

lineNumber: JsUint;

property url

url: string;

interface ScriptStackTrace

interface ScriptStackTrace {}

property callFrames

callFrames: ScriptStackFrame[];

interface ScriptStringValue

interface ScriptStringValue {}

property type

type: 'string';

property value

value: string;

interface ScriptSymbolRemoteValue

interface ScriptSymbolRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'symbol';

interface ScriptTypedArrayRemoteValue

interface ScriptTypedArrayRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'typedarray';

interface ScriptUndefinedValue

interface ScriptUndefinedValue {}

property type

type: 'undefined';

interface ScriptWeakMapRemoteValue

interface ScriptWeakMapRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'weakmap';

interface ScriptWeakSetRemoteValue

interface ScriptWeakSetRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'weakset';

interface ScriptWindowProxyProperties

interface ScriptWindowProxyProperties {}

property context

context: BrowsingContextBrowsingContext;

interface ScriptWindowProxyRemoteValue

interface ScriptWindowProxyRemoteValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

property type

type: 'window';

property value

value: ScriptWindowProxyProperties;

interface SessionCapabilitiesRequest

interface SessionCapabilitiesRequest {}

property alwaysMatch

alwaysMatch?: SessionCapabilityRequest;

property firstMatch

firstMatch?: SessionCapabilityRequest[];

interface SessionEnd

interface SessionEnd {}

property method

method: 'session.end';

property params

params: EmptyParams;

interface SessionNew

interface SessionNew {}

property method

method: 'session.new';

property params

params: SessionNewParameters;

interface SessionNewParameters

interface SessionNewParameters {}

property capabilities

capabilities: SessionCapabilitiesRequest;

interface SessionSocksProxyConfiguration

interface SessionSocksProxyConfiguration {}

property socksProxy

socksProxy: string;

property socksVersion

socksVersion: number;

interface SessionStatus

interface SessionStatus {}

property method

method: 'session.status';

property params

params: EmptyParams;

interface SessionSubscribe

interface SessionSubscribe {}

property method

method: 'session.subscribe';

property params

params: SessionSubscribeParameters;

interface SessionSubscribeParameters

interface SessionSubscribeParameters {}

property contexts

contexts?: BrowsingContextBrowsingContext[];

property events

events: string[];

property userContexts

userContexts?: BrowserUserContext[];

interface SessionUnsubscribe

interface SessionUnsubscribe {}

property method

method: 'session.unsubscribe';

property params

params: SessionUnsubscribeParameters;

interface SessionUnsubscribeByAttributesRequest

interface SessionUnsubscribeByAttributesRequest {}

property events

events: string[];

interface SessionUnsubscribeByIdRequest

interface SessionUnsubscribeByIdRequest {}

property subscriptions

subscriptions: SessionSubscription[];

interface SessionUserPromptHandler

interface SessionUserPromptHandler {}

property alert

alert?: SessionUserPromptHandlerType;

property beforeUnload

beforeUnload?: SessionUserPromptHandlerType;

property confirm

confirm?: SessionUserPromptHandlerType;

property default

default?: SessionUserPromptHandlerType;

property file

file?: SessionUserPromptHandlerType;

property prompt

prompt?: SessionUserPromptHandlerType;

interface StorageBrowsingContextPartitionDescriptor

interface StorageBrowsingContextPartitionDescriptor {}

property context

context: BrowsingContextBrowsingContext;

property type

type: 'context';

interface StorageDeleteCookies

interface StorageDeleteCookies {}

property method

method: 'storage.deleteCookies';

property params

params: StorageDeleteCookiesParameters;

interface StorageDeleteCookiesParameters

interface StorageDeleteCookiesParameters {}

property filter

filter?: StorageCookieFilter;

property partition

partition?: StoragePartitionDescriptor;

interface StorageGetCookies

interface StorageGetCookies {}

property method

method: 'storage.getCookies';

property params

params: StorageGetCookiesParameters;

interface StorageGetCookiesParameters

interface StorageGetCookiesParameters {}

property filter

filter?: StorageCookieFilter;

property partition

partition?: StoragePartitionDescriptor;

interface StorageSetCookie

interface StorageSetCookie {}

property method

method: 'storage.setCookie';

property params

params: StorageSetCookieParameters;

interface StorageSetCookieParameters

interface StorageSetCookieParameters {}

cookie: StoragePartialCookie;

property partition

partition?: StoragePartitionDescriptor;

interface WebExtensionExtensionArchivePath

interface WebExtensionExtensionArchivePath {}

property path

path: string;

property type

type: 'archivePath';

interface WebExtensionExtensionBase64Encoded

interface WebExtensionExtensionBase64Encoded {}

property type

type: 'base64';

property value

value: string;

interface WebExtensionExtensionPath

interface WebExtensionExtensionPath {}

property path

path: string;

property type

type: 'path';

interface WebExtensionInstall

interface WebExtensionInstall {}

property method

method: 'webExtension.install';

property params

params: WebExtensionInstallParameters;

interface WebExtensionInstallParameters

interface WebExtensionInstallParameters {}

property extensionData

extensionData: WebExtensionExtensionData;

interface WebExtensionUninstall

interface WebExtensionUninstall {}

property method

method: 'webExtension.uninstall';

property params

params: WebExtensionUninstallParameters;

interface WebExtensionUninstallParameters

interface WebExtensionUninstallParameters {}

property extension

extension: WebExtensionExtension;

type BrowserClientWindow

type BrowserClientWindow = string;

type BrowserCommand

type BrowserCommand =
    | BrowserClose
    | BrowserCreateUserContext
    | BrowserGetClientWindows
    | BrowserGetUserContexts
    | BrowserRemoveUserContext
    | BrowserSetClientWindowState
    | BrowserSetDownloadBehavior;

type BrowserDownloadBehavior

type BrowserDownloadBehavior =
    | BrowserDownloadBehaviorAllowed
    | BrowserDownloadBehaviorDenied;

type BrowserSetClientWindowStateParameters

type BrowserSetClientWindowStateParameters = (
    | BrowserClientWindowNamedState
    | BrowserClientWindowRectState
) & {
    clientWindow: BrowserClientWindow;
};

type BrowserUserContext

type BrowserUserContext = string;

type BrowsingContextBrowsingContext

type BrowsingContextBrowsingContext = string;

type BrowsingContextClipRectangle

type BrowsingContextClipRectangle =
    | BrowsingContextBoxClipRectangle
    | BrowsingContextElementClipRectangle;

type BrowsingContextCommand

type BrowsingContextCommand =
    | BrowsingContextActivate
    | BrowsingContextCaptureScreenshot
    | BrowsingContextClose
    | BrowsingContextCreate
    | BrowsingContextGetTree
    | BrowsingContextHandleUserPrompt
    | BrowsingContextLocateNodes
    | BrowsingContextNavigate
    | BrowsingContextPrint
    | BrowsingContextReload
    | BrowsingContextSetBypassCsp
    | BrowsingContextSetViewport
    | BrowsingContextTraverseHistory;

type BrowsingContextCreateType

type BrowsingContextCreateType = 'tab' | 'window';

type BrowsingContextLocator

type BrowsingContextLocator =
    | BrowsingContextAccessibilityLocator
    | BrowsingContextCssLocator
    | BrowsingContextContextLocator
    | BrowsingContextInnerTextLocator
    | BrowsingContextXPathLocator;

type BrowsingContextNavigation

type BrowsingContextNavigation = string;

type BrowsingContextReadinessState

type BrowsingContextReadinessState = 'none' | 'interactive' | 'complete';

type BrowsingContextUserPromptType

type BrowsingContextUserPromptType = 'alert' | 'beforeunload' | 'confirm' | 'prompt';

type Command

type Command = CommandData &
    Extensible & {
        id: JsUint;
    };

!!! PLEASE DO NOT EDIT THIS FILE !!!
This source file, even though checked in, is auto-generated based on the current development within the WebDriver Bidi spec. Any changes to this file need to come from the specification. You can generate this file by calling
$ npm run generate:bidi
from the project root. You can find the scripts that generates this file in ./scripts/bidi/**

type CommandData

type CommandData =
    | BrowserCommand
    | BrowsingContextCommand
    | EmulationCommand
    | InputCommand
    | NetworkCommand
    | ScriptCommand
    | SessionCommand
    | StorageCommand
    | WebExtensionCommand;

type EmptyParams

type EmptyParams = Extensible;

type EmulationCommand

type EmulationCommand =
    | EmulationSetForcedColorsModeThemeOverride
    | EmulationSetGeolocationOverride
    | EmulationSetLocaleOverride
    | EmulationSetNetworkConditions
    | EmulationSetScreenOrientationOverride
    | EmulationSetScreenSettingsOverride
    | EmulationSetScriptingEnabled
    | EmulationSetScrollbarTypeOverride
    | EmulationSetTimezoneOverride
    | EmulationSetTouchOverride
    | EmulationSetUserAgentOverride;

type EmulationForcedColorsModeTheme

type EmulationForcedColorsModeTheme = 'light' | 'dark';

type EmulationNetworkConditions

type EmulationNetworkConditions = EmulationNetworkConditionsOffline;

type EmulationScreenOrientationNatural

type EmulationScreenOrientationNatural = 'portrait' | 'landscape';

type EmulationScreenOrientationType

type EmulationScreenOrientationType =
    | 'portrait-primary'
    | 'portrait-secondary'
    | 'landscape-primary'
    | 'landscape-secondary';

type EmulationSetGeolocationOverrideParameters

type EmulationSetGeolocationOverrideParameters = (
    | {
          coordinates: EmulationGeolocationCoordinates | null;
      }
    | {
          error: EmulationGeolocationPositionError;
      }
) & {
    contexts?: BrowsingContextBrowsingContext[];
    userContexts?: BrowserUserContext[];
};

type Extensible

type Extensible = Record<string, unknown>;

type InputCommand

type InputCommand = InputPerformActions | InputReleaseActions | InputSetFiles;

type InputKeySourceAction

type InputKeySourceAction = InputPauseAction | InputKeyDownAction | InputKeyUpAction;

type InputNoneSourceAction

type InputNoneSourceAction = InputPauseAction;

type InputOrigin

type InputOrigin = 'viewport' | 'pointer' | InputElementOrigin;

type InputPointerDownAction

type InputPointerDownAction = InputPointerCommonProperties & {
    type: 'pointerDown';
    button: JsUint;
};

type InputPointerMoveAction

type InputPointerMoveAction = InputPointerCommonProperties & {
    type: 'pointerMove';
    x: number;
    y: number;
    duration?: JsUint;
    origin?: InputOrigin;
};

type InputPointerSourceAction

type InputPointerSourceAction =
    | InputPauseAction
    | InputPointerDownAction
    | InputPointerUpAction
    | InputPointerMoveAction;

type InputPointerType

type InputPointerType = 'mouse' | 'pen' | 'touch';

type InputSourceActions

type InputSourceActions =
    | InputNoneSourceActions
    | InputKeySourceActions
    | InputPointerSourceActions
    | InputWheelSourceActions;

type InputWheelSourceAction

type InputWheelSourceAction = InputPauseAction | InputWheelScrollAction;

type JsInt

type JsInt = number;

type JsUint

type JsUint = number;

type NetworkBytesValue

type NetworkBytesValue = NetworkStringValue | NetworkBase64Value;

type NetworkCollector

type NetworkCollector = string;

type NetworkCollectorType

type NetworkCollectorType = 'blob';

type NetworkCommand

type NetworkCommand =
    | NetworkAddDataCollector
    | NetworkAddIntercept
    | NetworkContinueRequest
    | NetworkContinueResponse
    | NetworkContinueWithAuth
    | NetworkDisownData
    | NetworkFailRequest
    | NetworkGetData
    | NetworkProvideResponse
    | NetworkRemoveDataCollector
    | NetworkRemoveIntercept
    | NetworkSetCacheBehavior
    | NetworkSetExtraHeaders;

type NetworkContinueWithAuthParameters

type NetworkContinueWithAuthParameters = (
    | NetworkContinueWithAuthCredentials
    | NetworkContinueWithAuthNoCredentials
) & {
    request: NetworkRequest;
};

type NetworkCookie

type NetworkCookie = Extensible & {
    name: string;
    value: NetworkBytesValue;
    domain: string;
    path: string;
    size: JsUint;
    httpOnly: boolean;
    secure: boolean;
    sameSite: NetworkSameSite;
    expiry?: JsUint;
};

type NetworkDataType

type NetworkDataType = 'request' | 'response';

type NetworkIntercept

type NetworkIntercept = string;

type NetworkInterceptPhase

type NetworkInterceptPhase =
    | 'beforeRequestSent'
    | 'responseStarted'
    | 'authRequired';

type NetworkRequest

type NetworkRequest = string;

type NetworkSameSite

type NetworkSameSite = 'strict' | 'lax' | 'none' | 'default';

type NetworkUrlPattern

type NetworkUrlPattern = NetworkUrlPatternPattern | NetworkUrlPatternString;

type ScriptChannel

type ScriptChannel = string;

type ScriptCommand

type ScriptCommand =
    | ScriptAddPreloadScript
    | ScriptCallFunction
    | ScriptDisown
    | ScriptEvaluate
    | ScriptGetRealms
    | ScriptRemovePreloadScript;

type ScriptDateRemoteValue

type ScriptDateRemoteValue = ScriptDateLocalValue & {
    handle?: ScriptHandle;
    internalId?: ScriptInternalId;
};

type ScriptEvaluateResult

type ScriptEvaluateResult =
    | ScriptEvaluateResultSuccess
    | ScriptEvaluateResultException;

type ScriptHandle

type ScriptHandle = string;

type ScriptInternalId

type ScriptInternalId = string;

type ScriptListLocalValue

type ScriptListLocalValue = ScriptLocalValue[];

type ScriptListRemoteValue

type ScriptListRemoteValue = ScriptRemoteValue[];

type ScriptLocalValue

type ScriptLocalValue =
    | ScriptRemoteReference
    | ScriptPrimitiveProtocolValue
    | ScriptChannelValue
    | ScriptArrayLocalValue
    | ScriptDateLocalValue
    | ScriptMapLocalValue
    | ScriptObjectLocalValue
    | ScriptRegExpLocalValue
    | ScriptSetLocalValue;

type ScriptMappingLocalValue

type ScriptMappingLocalValue = (ScriptLocalValue | ScriptLocalValue)[];

type ScriptMappingRemoteValue

type ScriptMappingRemoteValue = (ScriptRemoteValue | ScriptRemoteValue)[];

type ScriptPreloadScript

type ScriptPreloadScript = string;

type ScriptPrimitiveProtocolValue

type ScriptPrimitiveProtocolValue =
    | ScriptUndefinedValue
    | ScriptNullValue
    | ScriptStringValue
    | ScriptNumberValue
    | ScriptBooleanValue
    | ScriptBigIntValue;

type ScriptRealm

type ScriptRealm = string;

type ScriptRealmType

type ScriptRealmType =
    | 'window'
    | 'dedicated-worker'
    | 'shared-worker'
    | 'service-worker'
    | 'worker'
    | 'paint-worklet'
    | 'audio-worklet'
    | 'worklet';

type ScriptRegExpRemoteValue

type ScriptRegExpRemoteValue = ScriptRegExpLocalValue & {
    handle?: ScriptHandle;
    internalId?: ScriptInternalId;
};

type ScriptRemoteObjectReference

type ScriptRemoteObjectReference = Extensible & {
    handle: ScriptHandle;
    sharedId?: ScriptSharedId;
};

type ScriptRemoteReference

type ScriptRemoteReference = ScriptSharedReference | ScriptRemoteObjectReference;

type ScriptRemoteValue

type ScriptRemoteValue =
    | ScriptPrimitiveProtocolValue
    | ScriptSymbolRemoteValue
    | ScriptArrayRemoteValue
    | ScriptObjectRemoteValue
    | ScriptFunctionRemoteValue
    | ScriptRegExpRemoteValue
    | ScriptDateRemoteValue
    | ScriptMapRemoteValue
    | ScriptSetRemoteValue
    | ScriptWeakMapRemoteValue
    | ScriptWeakSetRemoteValue
    | ScriptGeneratorRemoteValue
    | ScriptErrorRemoteValue
    | ScriptProxyRemoteValue
    | ScriptPromiseRemoteValue
    | ScriptTypedArrayRemoteValue
    | ScriptArrayBufferRemoteValue
    | ScriptNodeListRemoteValue
    | ScriptHtmlCollectionRemoteValue
    | ScriptNodeRemoteValue
    | ScriptWindowProxyRemoteValue;

type ScriptResultOwnership

type ScriptResultOwnership = 'root' | 'none';

type ScriptSharedId

type ScriptSharedId = string;

type ScriptSharedReference

type ScriptSharedReference = Extensible & {
    sharedId: ScriptSharedId;
    handle?: ScriptHandle;
};

type ScriptSpecialNumber

type ScriptSpecialNumber = 'NaN' | '-0' | 'Infinity' | '-Infinity';

type ScriptTarget

type ScriptTarget = ScriptContextTarget | ScriptRealmTarget;

type SessionAutodetectProxyConfiguration

type SessionAutodetectProxyConfiguration = Extensible & {
    proxyType: 'autodetect';
};

type SessionCapabilityRequest

type SessionCapabilityRequest = Extensible & {
    acceptInsecureCerts?: boolean;
    browserName?: string;
    browserVersion?: string;
    platformName?: string;
    proxy?: SessionProxyConfiguration;
    unhandledPromptBehavior?: SessionUserPromptHandler;
};

type SessionCommand

type SessionCommand =
    | SessionEnd
    | SessionNew
    | SessionStatus
    | SessionSubscribe
    | SessionUnsubscribe;

type SessionDirectProxyConfiguration

type SessionDirectProxyConfiguration = Extensible & {
    proxyType: 'direct';
};

type SessionManualProxyConfiguration

type SessionManualProxyConfiguration = SessionSocksProxyConfiguration &
    Extensible & {
        proxyType: 'manual';
        httpProxy?: string;
        sslProxy?: string;
        noProxy?: string[];
    };

type SessionPacProxyConfiguration

type SessionPacProxyConfiguration = Extensible & {
    proxyType: 'pac';
    proxyAutoconfigUrl: string;
};

type SessionProxyConfiguration

type SessionProxyConfiguration =
    | SessionAutodetectProxyConfiguration
    | SessionDirectProxyConfiguration
    | SessionManualProxyConfiguration
    | SessionPacProxyConfiguration
    | SessionSystemProxyConfiguration;

type SessionSubscription

type SessionSubscription = string;

type SessionSystemProxyConfiguration

type SessionSystemProxyConfiguration = Extensible & {
    proxyType: 'system';
};

type SessionUnsubscribeParameters

type SessionUnsubscribeParameters =
    | SessionUnsubscribeByAttributesRequest
    | SessionUnsubscribeByIdRequest;

type SessionUserPromptHandlerType

type SessionUserPromptHandlerType = 'accept' | 'dismiss' | 'ignore';

type StorageCommand

type StorageCommand = StorageDeleteCookies | StorageGetCookies | StorageSetCookie;

type StorageCookieFilter

type StorageCookieFilter = Extensible & {
    name?: string;
    value?: NetworkBytesValue;
    domain?: string;
    path?: string;
    size?: JsUint;
    httpOnly?: boolean;
    secure?: boolean;
    sameSite?: NetworkSameSite;
    expiry?: JsUint;
};

type StoragePartialCookie

type StoragePartialCookie = Extensible & {
    name: string;
    value: NetworkBytesValue;
    domain: string;
    path?: string;
    httpOnly?: boolean;
    secure?: boolean;
    sameSite?: NetworkSameSite;
    expiry?: JsUint;
};

type StoragePartitionDescriptor

type StoragePartitionDescriptor =
    | StorageBrowsingContextPartitionDescriptor
    | StorageStorageKeyPartitionDescriptor;

type StoragePartitionKey

type StoragePartitionKey = Extensible & {
    userContext?: string;
    sourceOrigin?: string;
};

type StorageStorageKeyPartitionDescriptor

type StorageStorageKeyPartitionDescriptor = Extensible & {
    type: 'storageKey';
    userContext?: string;
    sourceOrigin?: string;
};

type WebExtensionCommand

type WebExtensionCommand = WebExtensionInstall | WebExtensionUninstall;

type WebExtensionExtension

type WebExtensionExtension = string;

type WebExtensionExtensionData

type WebExtensionExtensionData =
    | WebExtensionExtensionArchivePath
    | WebExtensionExtensionBase64Encoded
    | WebExtensionExtensionPath;

Package Files (8)

Dependencies (11)

Dev Dependencies (0)

No dev dependencies.

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/webdriver.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/webdriver)

HTML

<a href="https://www.jsdocs.io/package/webdriver"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 1 second ago.
Package analyzed in 11338 ms.
Missing or incorrect documentation? Open an issue for this package.

webdriver

Install

Overview

Index

Variables

Functions

Classes

Interfaces

Type Aliases

Namespaces

Variables

variable APPIUM_MASKING_HEADER

variable BASE_64_REGEX

variable BASE_64_SAFE_STRING_TO_PROCESS_LENGTH

variable DEFAULTS

variable ELEMENT_KEY

variable SHADOW_ELEMENT_KEY

Functions

function command

function getEnvironmentVars

Parameter options

function getPrototype

function initiateBidi

Parameter socketUrl

Parameter strictSSL

Parameter userHeaders

Returns

function parseBidiMessage

Classes

class BidiHandler

method browserClose

Parameter params

Returns

method browserCreateUserContext

Parameter params

Returns

method browserGetClientWindows

Parameter params

Returns

method browserGetUserContexts

Parameter params

Returns

method browserRemoveUserContext

Parameter params

Returns

method browserSetClientWindowState

Parameter params

Returns

method browserSetDownloadBehavior

Parameter params

Returns

method browsingContextActivate

Parameter params

Returns

method browsingContextCaptureScreenshot

Parameter params

Returns

method browsingContextClose

Parameter params

Returns

method browsingContextCreate

Parameter params

Returns

method browsingContextGetTree

Parameter params

Returns

method browsingContextHandleUserPrompt

Parameter params

Returns

method browsingContextLocateNodes

Parameter params

Returns

method browsingContextNavigate

Parameter params

Returns

method browsingContextPrint

Parameter params

Returns

method browsingContextReload

Parameter params