webdriver

webdriver

Version 9.1.2
Published 9 days ago
228 kB
9 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 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,
    ...args: any[]
) => Promise<WebDriverResponse | BidiResponses | void>;

function getEnvironmentVars

getEnvironmentVars: ({
    isW3C,
    isMobile,
    isIOS,
    isAndroid,
    isFirefox,
    isSauce,
    isSeleniumStandalone,
    isBidi,
    isChromium,
}: 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) => PropertyDescriptorMap;

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

function parseBidiMessage

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

Classes

class BidiHandler

class BidiHandler extends BidiCore {}

method browserClose

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

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.EmptyResult>

method browserCreateUserContext

browserCreateUserContext: (
    params: remote.EmptyParams
) => 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.EmptyParams command parameter
Returns
Promise<local.BrowserCreateUserContextResult>

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.EmptyResult>;

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.EmptyResult>

method browsingContextActivate

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

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.EmptyResult>

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.EmptyResult>;

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.EmptyResult>

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.EmptyResult>;

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.EmptyResult>

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.EmptyResult>;

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.EmptyResult>

method browsingContextSetViewport

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

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.EmptyResult>

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 inputPerformActions

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

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.EmptyResult>

method inputReleaseActions

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

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.EmptyResult>

method inputSetFiles

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

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.EmptyResult>

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.EmptyResult>;

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.EmptyResult>

method networkContinueResponse

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

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.EmptyResult>

method networkContinueWithAuth

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

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.EmptyResult>

method networkFailRequest

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

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.EmptyResult>

method networkProvideResponse

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

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.EmptyResult>

method networkRemoveIntercept

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

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.EmptyResult>

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.ScriptEvaluateResult>;

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.EmptyResult>

method scriptDisown

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

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.EmptyResult>

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.EmptyResult>;

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.EmptyResult>

method sessionEnd

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

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.EmptyResult>

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.SessionSubscriptionRequest
) => Promise<local.EmptyResult>;

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

method sessionUnsubscribe

sessionUnsubscribe: (
    params: remote.SessionSubscriptionRequest
) => Promise<local.EmptyResult>;

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

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>

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
) => Promise<Client>;

method reloadSession

static reloadSession: (
    instance: Client,
    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 isMobile

isMobile: boolean;

property isSauce

isSauce: boolean;

property isSeleniumStandalone

isSeleniumStandalone: boolean;

property isW3C

isW3C: boolean;

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 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 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 BrowsingContextCreateResult

interface BrowsingContextCreateResult {}

property context

context: BrowsingContextBrowsingContext;

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 BrowsingContextDownloadWillBegin

interface BrowsingContextDownloadWillBegin {}

property method

method: 'browsingContext.downloadWillBegin';

property params

params: BrowsingContextNavigationInfo;

interface BrowsingContextFragmentNavigated

interface BrowsingContextFragmentNavigated {}

property method

method: 'browsingContext.fragmentNavigated';

property params

params: BrowsingContextNavigationInfo;

interface BrowsingContextGetTreeResult

interface BrowsingContextGetTreeResult {}

property contexts

contexts: BrowsingContextInfoList;

interface BrowsingContextInfo

interface BrowsingContextInfo {}

property children

children: BrowsingContextInfoList | null;

property context

context: BrowsingContextBrowsingContext;

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 BrowsingContextNavigationFailed

interface BrowsingContextNavigationFailed {}

property method

method: 'browsingContext.navigationFailed';

property params

params: BrowsingContextNavigationInfo;

interface BrowsingContextNavigationInfo

interface BrowsingContextNavigationInfo {}

property context

context: BrowsingContextBrowsingContext;

navigation: BrowsingContextNavigation | null;

property timestamp

timestamp: JsUint;

property url

url: string;

interface BrowsingContextNavigationStarted

interface BrowsingContextNavigationStarted {}

property method

method: 'browsingContext.navigationStarted';

property params

params: BrowsingContextNavigationInfo;

interface BrowsingContextPrintResult

interface BrowsingContextPrintResult {}

property data

data: string;

interface BrowsingContextTraverseHistoryResult

interface BrowsingContextTraverseHistoryResult {}

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 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 message

message: string;

property type

type: 'alert' | 'confirm' | 'prompt' | 'beforeunload';

interface BrowsingContextXPathLocator

interface BrowsingContextXPathLocator {}

property type

type: 'xpath';

property value

value: string;

interface CommandResponse

interface CommandResponse extends Extensible {}

property id

id: JsUint;

property result

result: ResultData;

property type

type: 'success';

interface EmptyResult

interface EmptyResult extends Extensible {}

interface ErrorResponse

interface ErrorResponse extends Extensible {}

property error

error: ErrorCode;

property id

id: JsUint | null;

property message

message: string;

property stacktrace

stacktrace?: string;

property type

type: 'error';

interface Event

interface Event extends Extensible {}

property type

type: 'event';

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 LogConsoleLogEntry

interface LogConsoleLogEntry extends LogBaseLogEntry {}

property args

args: ScriptRemoteValue[];

property method

method: string;

property type

type: 'console';

interface LogEntryAdded

interface LogEntryAdded {}

property method

method: 'log.entryAdded';

property params

params: LogEntry;

interface LogEvent

interface LogEvent extends LogEntryAdded {}

interface LogGenericLogEntry

interface LogGenericLogEntry extends LogBaseLogEntry {}

property type

type: string;

interface LogJavascriptLogEntry

interface LogJavascriptLogEntry extends LogBaseLogEntry {}

property type

type: 'javascript';

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 NetworkAuthRequiredParameters

interface NetworkAuthRequiredParameters extends NetworkBaseParameters {}

property response

response: NetworkResponseData;

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;

interface NetworkBeforeRequestSent

interface NetworkBeforeRequestSent {}

property method

method: 'network.beforeRequestSent';

property params

params: NetworkBeforeRequestSentParameters;

interface NetworkBeforeRequestSentParameters

interface NetworkBeforeRequestSentParameters extends NetworkBaseParameters {}

property initiator

initiator: NetworkInitiator;

interface NetworkCookie

interface NetworkCookie extends Extensible {}

property domain

domain: string;

property expiry

expiry?: JsUint;

property httpOnly

httpOnly: boolean;

property name

name: string;

property path

path: string;

property sameSite

sameSite: NetworkSameSite;

property secure

secure: boolean;

property size

size: JsUint;

property value

value: NetworkBytesValue;

interface NetworkFetchError

interface NetworkFetchError {}

property method

method: 'network.fetchError';

property params

params: NetworkFetchErrorParameters;

interface NetworkFetchErrorParameters

interface NetworkFetchErrorParameters extends NetworkBaseParameters {}

property errorText

errorText: string;

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 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 headers

headers: NetworkHeader[];

property headersSize

headersSize: JsUint;

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 NetworkResponseCompletedParameters

interface NetworkResponseCompletedParameters extends NetworkBaseParameters {}

property response

response: NetworkResponseData;

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 NetworkResponseStartedParameters

interface NetworkResponseStartedParameters extends NetworkBaseParameters {}

property response

response: NetworkResponseData;

interface NetworkResult

interface NetworkResult extends NetworkAddInterceptResult {}

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 ScriptAudioWorkletRealmInfo

interface ScriptAudioWorkletRealmInfo extends ScriptBaseRealmInfo {}

property type

type: 'audio-worklet';

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 ScriptDateRemoteValue

interface ScriptDateRemoteValue extends ScriptDateLocalValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

interface ScriptDedicatedWorkerRealmInfo

interface ScriptDedicatedWorkerRealmInfo extends ScriptBaseRealmInfo {}

property owners

owners: ScriptRealm[];

property type

type: 'dedicated-worker';

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 ScriptPaintWorkletRealmInfo

interface ScriptPaintWorkletRealmInfo extends ScriptBaseRealmInfo {}

property type

type: 'paint-worklet';

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 ScriptRegExpRemoteValue

interface ScriptRegExpRemoteValue extends ScriptRegExpLocalValue {}

property handle

handle?: ScriptHandle;

property internalId

internalId?: ScriptInternalId;

interface ScriptRegExpValue

interface ScriptRegExpValue {}

property flags

flags?: string;

property pattern

pattern: string;

interface ScriptRemoteObjectReference

interface ScriptRemoteObjectReference extends Extensible {}

property handle

handle: ScriptHandle;

property sharedId

sharedId?: ScriptSharedId;

interface ScriptSerializationOptions

interface ScriptSerializationOptions {}

property includeShadowTree

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

'none'

property maxDomDepth

maxDomDepth?: JsUint | null;

property maxObjectDepth

maxObjectDepth?: JsUint | null;

null

interface ScriptServiceWorkerRealmInfo

interface ScriptServiceWorkerRealmInfo extends ScriptBaseRealmInfo {}

property type

type: 'service-worker';

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 ScriptSharedReference

interface ScriptSharedReference extends Extensible {}

property handle

handle?: ScriptHandle;

property sharedId

sharedId: ScriptSharedId;

interface ScriptSharedWorkerRealmInfo

interface ScriptSharedWorkerRealmInfo extends ScriptBaseRealmInfo {}

property type

type: 'shared-worker';

interface ScriptSource

interface ScriptSource {}

property context

context?: BrowsingContextBrowsingContext;

property realm

realm: ScriptRealm;

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 ScriptWindowRealmInfo

interface ScriptWindowRealmInfo extends ScriptBaseRealmInfo {}

property context

context: BrowsingContextBrowsingContext;

property sandbox

sandbox?: string;

property type

type: 'window';

interface ScriptWorkerRealmInfo

interface ScriptWorkerRealmInfo extends ScriptBaseRealmInfo {}

property type

type: 'worker';

interface ScriptWorkletRealmInfo

interface ScriptWorkletRealmInfo extends ScriptBaseRealmInfo {}

property type

type: 'worklet';

interface SessionAutodetectProxyConfiguration

interface SessionAutodetectProxyConfiguration extends Extensible {}

property proxyType

proxyType: 'autodetect';

interface SessionCapabilitiesRequest

interface SessionCapabilitiesRequest {}

property alwaysMatch

alwaysMatch?: SessionCapabilityRequest;

property firstMatch

firstMatch?: SessionCapabilityRequest[];

interface SessionCapabilityRequest

interface SessionCapabilityRequest extends Extensible {}

property acceptInsecureCerts

acceptInsecureCerts?: boolean;

property browserName

browserName?: string;

property browserVersion

browserVersion?: string;

property platformName

platformName?: string;

property proxy

proxy?: SessionProxyConfiguration;

property webSocketUrl

webSocketUrl?: boolean;

interface SessionDirectProxyConfiguration

interface SessionDirectProxyConfiguration extends Extensible {}

property proxyType

proxyType: 'direct';

interface SessionManualProxyConfiguration

interface SessionManualProxyConfiguration
    extends SessionSocksProxyConfiguration,
        Extensible {}

property ftpProxy

ftpProxy?: string;

property httpProxy

httpProxy?: string;

property noProxy

noProxy?: string[];

property proxyType

proxyType: 'manual';

property sslProxy

sslProxy?: string;

interface SessionNewResult

interface SessionNewResult {}

property capabilities

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

property sessionId

sessionId: string;

interface SessionPacProxyConfiguration

interface SessionPacProxyConfiguration extends Extensible {}

property proxyAutoconfigUrl

proxyAutoconfigUrl: string;

property proxyType

proxyType: 'pac';

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 SessionSystemProxyConfiguration

interface SessionSystemProxyConfiguration extends Extensible {}

property proxyType

proxyType: 'system';

interface StorageDeleteCookiesResult

interface StorageDeleteCookiesResult {}

property partitionKey

partitionKey: StoragePartitionKey;

interface StorageGetCookiesResult

interface StorageGetCookiesResult {}

property cookies

cookies: NetworkCookie[];

property partitionKey

partitionKey: StoragePartitionKey;

interface StoragePartitionKey

interface StoragePartitionKey extends Extensible {}

property sourceOrigin

sourceOrigin?: string;

property userContext

userContext?: string;

interface StorageSetCookieResult

interface StorageSetCookieResult {}

property partitionKey

partitionKey: StoragePartitionKey;

type BrowserCreateUserContextResult

type BrowserCreateUserContextResult = BrowserUserContextInfo;

type BrowserResult

type BrowserResult = BrowserCreateUserContextResult | BrowserGetUserContextsResult;

type BrowserUserContext

type BrowserUserContext = string;

type BrowsingContextBrowsingContext

type BrowsingContextBrowsingContext = string;

type BrowsingContextEvent

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

type BrowsingContextInfoList

type BrowsingContextInfoList = BrowsingContextInfo[];

type BrowsingContextLocator

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

type BrowsingContextNavigation

type BrowsingContextNavigation = string;

type BrowsingContextResult

type BrowsingContextResult =
    | BrowsingContextCaptureScreenshotResult
    | BrowsingContextCreateResult
    | BrowsingContextGetTreeResult
    | BrowsingContextLocateNodesResult
    | BrowsingContextNavigateResult
    | BrowsingContextPrintResult
    | BrowsingContextTraverseHistoryResult;

type ErrorCode

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

type EventData

type EventData = BrowsingContextEvent | LogEvent | NetworkEvent | ScriptEvent;

type Extensible

type Extensible = Record<string, any>;

type JsInt

type JsInt = number;

type JsUint

type JsUint = number;

type LogEntry

type LogEntry = LogGenericLogEntry | LogConsoleLogEntry | LogJavascriptLogEntry;

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 NetworkBytesValue

type NetworkBytesValue = NetworkStringValue | NetworkBase64Value;

type NetworkEvent

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

type NetworkIntercept

type NetworkIntercept = string;

type NetworkRequest

type NetworkRequest = string;

type NetworkSameSite

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

type ResultData

type ResultData =
    | BrowsingContextResult
    | EmptyResult
    | NetworkResult
    | ScriptResult
    | SessionResult
    | StorageResult;

type ScriptChannel

type ScriptChannel = string;

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 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 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 ScriptResult

type ScriptResult =
    | ScriptAddPreloadScriptResult
    | ScriptEvaluateResult
    | ScriptGetRealmsResult;

type ScriptResultOwnership

type ScriptResultOwnership = 'root' | 'none';

type ScriptSharedId

type ScriptSharedId = string;

type ScriptSpecialNumber

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

type SessionProxyConfiguration

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

type SessionResult

type SessionResult = SessionNewResult | SessionStatusResult;

type StorageResult

type StorageResult =
    | StorageDeleteCookiesResult
    | StorageGetCookiesResult
    | StorageSetCookieResult;

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 BrowserClose

interface BrowserClose extends Command {}

property method

method: 'browser.close';

property params

params: EmptyParams;

interface BrowserCreateUserContext

interface BrowserCreateUserContext extends Command {}

property method

method: 'browser.createUserContext';

property params

params: EmptyParams;

interface BrowserGetUserContexts

interface BrowserGetUserContexts extends Command {}

property method

method: 'browser.getUserContexts';

property params

params: EmptyParams;

interface BrowserRemoveUserContext

interface BrowserRemoveUserContext extends Command {}

property method

method: 'browser.removeUserContext';

property params

params: BrowserRemoveUserContextParameters;

interface BrowserRemoveUserContextParameters

interface BrowserRemoveUserContextParameters {}

property userContext

userContext: 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 extends Command {}

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 extends Command {}

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 extends Command {}

webdriver

Install

Overview

Index

Variables

Functions

Classes

Interfaces

Type Aliases

Namespaces

Variables

variable DEFAULTS

variable ELEMENT_KEY

variable SHADOW_ELEMENT_KEY

Functions

function command

function getEnvironmentVars

Parameter options

function getPrototype

function initiateBidi

Parameter socketUrl

Returns

function parseBidiMessage

Classes

class BidiHandler

method browserClose

Parameter params

Returns

method browserCreateUserContext

Parameter params

Returns

method browserGetUserContexts

Parameter params

Returns

method browserRemoveUserContext

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

Returns

method browsingContextSetViewport

Parameter params

Returns

method browsingContextTraverseHistory

Parameter params

Returns

method inputPerformActions

Parameter params

Returns

method inputReleaseActions

Parameter params

Returns

method inputSetFiles