WebDriver Bidi Protocol

These protocol commands are generated based on the current living WebDriver Bidi specification. To enable the protocol for your test make sure to have webSocketUrl: true set in your capabilities.

Last Updated: Wed Nov 04 2026 11:43:49 GMT+0000 (Coordinated Universal Time)

send​

Send socket commands via WebDriver Bidi

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.send(params)

Parameters​

Returns​

• <Object> CommandResponse: WebDriver Bidi response

sendAsync​

Send asynchronous socket commands via WebDriver Bidi

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.sendAsync(params)

Parameters​

Returns​

• <Number> id: id of WebDriver Bidi request

sessionStatus​

WebDriver Bidi command to send command method "session.status" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.sessionStatus(params)

Parameters​

{}

Returns​

• <Object> local.SessionStatusResult: Command return value with the following interface:

  {
    ready: boolean;
    message: string;
  }
  

sessionNew​

WebDriver Bidi command to send command method "session.new" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.sessionNew(params)

Parameters​

{
  capabilities: SessionCapabilitiesRequest;
}

Returns​

• <Object> local.SessionNewResult: Command return value with the following interface:

  {
    sessionId: string;
    capabilities: SessionCapabilityResponse;
  }
  

sessionEnd​

WebDriver Bidi command to send command method "session.end" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.sessionEnd(params)

Parameters​

{}

Returns​

• <Object> local.SessionEndResult: Command return value with the following interface:

  ;
  

sessionSubscribe​

WebDriver Bidi command to send command method "session.subscribe" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.sessionSubscribe(params)

Parameters​

{
  events: string[];
  contexts?: BrowsingContextBrowsingContext[];
  userContexts?: BrowserUserContext[];
}

Returns​

• <Object> local.SessionSubscribeResult: Command return value with the following interface:

  {
    subscription: SessionSubscription;
  }
  

sessionUnsubscribe​

WebDriver Bidi command to send command method "session.unsubscribe" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.sessionUnsubscribe(params)

Parameters​

{}

Returns​

• <Object> local.SessionUnsubscribeResult: Command return value with the following interface:

  ;
  

browserClose​

WebDriver Bidi command to send command method "browser.close" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.browserClose(params)

Parameters​

{}

Returns​

• <Object> local.BrowserCloseResult: Command return value with the following interface:

  ;
  

browserCreateUserContext​

WebDriver Bidi command to send command method "browser.createUserContext" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.browserCreateUserContext(params)

Parameters​

{
  acceptInsecureCerts?: boolean;
  proxy?: SessionProxyConfiguration;
  unhandledPromptBehavior?: SessionUserPromptHandler;
}

Returns​

• <Object> local.BrowserCreateUserContextResult: Command return value with the following interface:

  ;
  

browserGetClientWindows​

WebDriver Bidi command to send command method "browser.getClientWindows" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.browserGetClientWindows(params)

Parameters​

{}

Returns​

• <Object> local.BrowserGetClientWindowsResult: Command return value with the following interface:

  {
    clientWindows: BrowserClientWindowInfo[];
  }
  

browserGetUserContexts​

WebDriver Bidi command to send command method "browser.getUserContexts" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.browserGetUserContexts(params)

Parameters​

{}

Returns​

• <Object> local.BrowserGetUserContextsResult: Command return value with the following interface:

  {
    userContexts: BrowserUserContextInfo[];
  }
  

browserRemoveUserContext​

WebDriver Bidi command to send command method "browser.removeUserContext" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.browserRemoveUserContext(params)

Parameters​

{
  userContext: BrowserUserContext;
}

Returns​

• <Object> local.BrowserRemoveUserContextResult: Command return value with the following interface:

  ;
  

browserSetClientWindowState​

WebDriver Bidi command to send command method "browser.setClientWindowState" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.browserSetClientWindowState(params)

Parameters​

{
  clientWindow: BrowserClientWindow;
};

Returns​

• <Object> local.BrowserSetClientWindowStateResult: Command return value with the following interface:

  ;
  

browserSetDownloadBehavior​

WebDriver Bidi command to send command method "browser.setDownloadBehavior" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.browserSetDownloadBehavior(params)

Parameters​

{
  downloadBehavior: BrowserDownloadBehavior | null;
  userContexts?: BrowserUserContext[];
}

Returns​

• <Object> local.BrowserSetDownloadBehaviorResult: Command return value with the following interface:

  ;
  

browsingContextActivate​

WebDriver Bidi command to send command method "browsingContext.activate" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.browsingContextActivate(params)

Parameters​

{
  context: BrowsingContextBrowsingContext;
}

Returns​

• <Object> local.BrowsingContextActivateResult: Command return value with the following interface:

  ;
  

browsingContextCaptureScreenshot​

WebDriver Bidi command to send command method "browsingContext.captureScreenshot" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.browsingContextCaptureScreenshot(params)

Parameters​

{
  context: BrowsingContextBrowsingContext;
  /**
   * @default 'viewport'
   */
  origin?: "viewport" | "document";
  format?: BrowsingContextImageFormat;
  clip?: BrowsingContextClipRectangle;
  imageSize?: BrowsingContextImageSize;
}

Returns​

• <Object> local.BrowsingContextCaptureScreenshotResult: Command return value with the following interface:

  {
    data: string;
  }
  

browsingContextClose​

WebDriver Bidi command to send command method "browsingContext.close" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.browsingContextClose(params)

Parameters​

{
  context: BrowsingContextBrowsingContext;
  promptUnload?: boolean;
}

Returns​

• <Object> local.BrowsingContextCloseResult: Command return value with the following interface:

  ;
  

browsingContextCreate​

WebDriver Bidi command to send command method "browsingContext.create" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.browsingContextCreate(params)

Parameters​

{
  type: BrowsingContextCreateType;
  referenceContext?: BrowsingContextBrowsingContext;
  background?: boolean;
  userContext?: BrowserUserContext;
}

Returns​

• <Object> local.BrowsingContextCreateResult: Command return value with the following interface:

  {
    context: BrowsingContextBrowsingContext;
    userContext?: BrowserUserContext;
  }
  

browsingContextGetTree​

WebDriver Bidi command to send command method "browsingContext.getTree" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.browsingContextGetTree(params)

Parameters​

{
  maxDepth?: JsUint;
  root?: BrowsingContextBrowsingContext;
}

Returns​

• <Object> local.BrowsingContextGetTreeResult: Command return value with the following interface:

  {
    contexts: BrowsingContextInfoList;
  }
  

browsingContextHandleUserPrompt​

WebDriver Bidi command to send command method "browsingContext.handleUserPrompt" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.browsingContextHandleUserPrompt(params)

Parameters​

{
  context: BrowsingContextBrowsingContext;
  accept?: boolean;
  userText?: string;
}

Returns​

• <Object> local.BrowsingContextHandleUserPromptResult: Command return value with the following interface:

  ;
  

browsingContextLocateNodes​

WebDriver Bidi command to send command method "browsingContext.locateNodes" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.browsingContextLocateNodes(params)

Parameters​

{
  context: BrowsingContextBrowsingContext;
  locator: BrowsingContextLocator;
  maxNodeCount?: JsUint;
  serializationOptions?: ScriptSerializationOptions;
  startNodes?: ScriptSharedReference[];
}

Returns​

• <Object> local.BrowsingContextLocateNodesResult: Command return value with the following interface:

  {
    nodes: ScriptNodeRemoteValue[];
  }
  

browsingContextNavigate​

WebDriver Bidi command to send command method "browsingContext.navigate" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.browsingContextNavigate(params)

Parameters​

{
  context: BrowsingContextBrowsingContext;
  url: string;
  wait?: BrowsingContextReadinessState;
}

Returns​

• <Object> local.BrowsingContextNavigateResult: Command return value with the following interface:

  {
    navigation: BrowsingContextNavigation | null;
    url: string;
  }
  

browsingContextPrint​

WebDriver Bidi command to send command method "browsingContext.print" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.browsingContextPrint(params)

Parameters​

{
  context: BrowsingContextBrowsingContext;
  background?: boolean;
  margin?: BrowsingContextPrintMarginParameters;
  /**
   * @default 'portrait'
   */
  orientation?: "portrait" | "landscape";
  page?: BrowsingContextPrintPageParameters;
  pageRanges?: (JsUint | string)[];
  /**
   * @default 1
   */
  scale?: number;
  /**
   * @default true
   */
  shrinkToFit?: boolean;
}

Returns​

• <Object> local.BrowsingContextPrintResult: Command return value with the following interface:

  {
    data: string;
  }
  

browsingContextReload​

WebDriver Bidi command to send command method "browsingContext.reload" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.browsingContextReload(params)

Parameters​

{
  context: BrowsingContextBrowsingContext;
  ignoreCache?: boolean;
  wait?: BrowsingContextReadinessState;
}

Returns​

• <Object> local.BrowsingContextReloadResult: Command return value with the following interface:

  ;
  

browsingContextSetBypassCsp​

WebDriver Bidi command to send command method "browsingContext.setBypassCSP" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.browsingContextSetBypassCsp(params)

Parameters​

{
  bypass: true | null;
  contexts?: BrowsingContextBrowsingContext[];
  userContexts?: BrowserUserContext[];
}

Returns​

• <Object> local.BrowsingContextSetBypassCspResult: Command return value with the following interface:

  ;
  

browsingContextSetViewport​

WebDriver Bidi command to send command method "browsingContext.setViewport" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.browsingContextSetViewport(params)

Parameters​

{
  context?: BrowsingContextBrowsingContext;
  viewport?: BrowsingContextViewport | null;
  devicePixelRatio?: number | null;
  userContexts?: BrowserUserContext[];
}

Returns​

• <Object> local.BrowsingContextSetViewportResult: Command return value with the following interface:

  ;
  

browsingContextStartScreencast​

WebDriver Bidi command to send command method "browsingContext.startScreencast" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.browsingContextStartScreencast(params)

Parameters​

{
  context: BrowsingContextBrowsingContext;
  destinationFolder?: string;
  mimeType?: string;
  video?: BrowsingContextMediaTrackConstraints;
  audio?: boolean;
}

Returns​

• <Object> local.BrowsingContextStartScreencastResult: Command return value with the following interface:

  {
    screencast: BrowsingContextScreencast;
    path: string;
  }
  

browsingContextStopScreencast​

WebDriver Bidi command to send command method "browsingContext.stopScreencast" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.browsingContextStopScreencast(params)

Parameters​

{
  screencast: BrowsingContextScreencast;
}

Returns​

• <Object> local.BrowsingContextStopScreencastResult: Command return value with the following interface:

  {
    path: string;
    error?: string;
  }
  

browsingContextTraverseHistory​

WebDriver Bidi command to send command method "browsingContext.traverseHistory" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.browsingContextTraverseHistory(params)

Parameters​

{
  context: BrowsingContextBrowsingContext;
  delta: JsInt;
}

Returns​

• <Object> local.BrowsingContextTraverseHistoryResult: Command return value with the following interface:

  ;
  

emulationSetForcedColorsModeThemeOverride​

WebDriver Bidi command to send command method "emulation.setForcedColorsModeThemeOverride" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.emulationSetForcedColorsModeThemeOverride(params)

Parameters​

{
  theme: EmulationForcedColorsModeTheme | null;
  contexts?: BrowsingContextBrowsingContext[];
  userContexts?: BrowserUserContext[];
}

Returns​

• <Object> local.EmulationSetForcedColorsModeThemeOverrideResult: Command return value with the following interface:

  ;
  

emulationSetGeolocationOverride​

WebDriver Bidi command to send command method "emulation.setGeolocationOverride" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.emulationSetGeolocationOverride(params)

Parameters​

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

Returns​

• <Object> local.EmulationSetGeolocationOverrideResult: Command return value with the following interface:

  ;
  

emulationSetLocaleOverride​

WebDriver Bidi command to send command method "emulation.setLocaleOverride" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.emulationSetLocaleOverride(params)

Parameters​

{
  locale: string | null;
  contexts?: BrowsingContextBrowsingContext[];
  userContexts?: BrowserUserContext[];
}

Returns​

• <Object> local.EmulationSetLocaleOverrideResult: Command return value with the following interface:

  ;
  

emulationSetMediaFeaturesOverride​

WebDriver Bidi command to send command method "emulation.setMediaFeaturesOverride" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.emulationSetMediaFeaturesOverride(params)

Parameters​

{
  features: EmulationMediaFeatures | null;
  contexts?: BrowsingContextBrowsingContext[];
  userContexts?: BrowserUserContext[];
}

Returns​

• <Object> local.EmulationSetMediaFeaturesOverrideResult: Command return value with the following interface:

  ;
  

emulationSetNetworkConditions​

WebDriver Bidi command to send command method "emulation.setNetworkConditions" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.emulationSetNetworkConditions(params)

Parameters​

{
  networkConditions: EmulationNetworkConditions | null;
  contexts?: BrowsingContextBrowsingContext[];
  userContexts?: BrowserUserContext[];
}

Returns​

• <Object> local.EmulationSetNetworkConditionsResult: Command return value with the following interface:

  ;
  

emulationSetScreenSettingsOverride​

WebDriver Bidi command to send command method "emulation.setScreenSettingsOverride" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.emulationSetScreenSettingsOverride(params)

Parameters​

{
  screenArea: EmulationScreenArea | null;
  contexts?: BrowsingContextBrowsingContext[];
  userContexts?: BrowserUserContext[];
}

Returns​

• <Object> local.EmulationSetScreenSettingsOverrideResult: Command return value with the following interface:

  ;
  

emulationSetScreenOrientationOverride​

WebDriver Bidi command to send command method "emulation.setScreenOrientationOverride" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.emulationSetScreenOrientationOverride(params)

Parameters​

{
  screenOrientation: EmulationScreenOrientation | null;
  contexts?: BrowsingContextBrowsingContext[];
  userContexts?: BrowserUserContext[];
}

Returns​

• <Object> local.EmulationSetScreenOrientationOverrideResult: Command return value with the following interface:

  ;
  

emulationSetUserAgentOverride​

WebDriver Bidi command to send command method "emulation.setUserAgentOverride" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.emulationSetUserAgentOverride(params)

Parameters​

{
  userAgent: string | null;
  contexts?: BrowsingContextBrowsingContext[];
  userContexts?: BrowserUserContext[];
}

Returns​

• <Object> local.EmulationSetUserAgentOverrideResult: Command return value with the following interface:

  ;
  

emulationSetViewportMetaOverride​

WebDriver Bidi command to send command method "emulation.setViewportMetaOverride" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.emulationSetViewportMetaOverride(params)

Parameters​

{
  viewportMeta: true | null;
  contexts?: BrowsingContextBrowsingContext[];
  userContexts?: BrowserUserContext[];
}

Returns​

• <Object> local.EmulationSetViewportMetaOverrideResult: Command return value with the following interface:

  ;
  

emulationSetScriptingEnabled​

WebDriver Bidi command to send command method "emulation.setScriptingEnabled" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.emulationSetScriptingEnabled(params)

Parameters​

{
  enabled: false | null;
  contexts?: BrowsingContextBrowsingContext[];
  userContexts?: BrowserUserContext[];
}

Returns​

• <Object> local.EmulationSetScriptingEnabledResult: Command return value with the following interface:

  ;
  

emulationSetScrollbarTypeOverride​

WebDriver Bidi command to send command method "emulation.setScrollbarTypeOverride" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.emulationSetScrollbarTypeOverride(params)

Parameters​

{
  scrollbarType: "classic" | "overlay" | null;
  contexts?: BrowsingContextBrowsingContext[];
  userContexts?: BrowserUserContext[];
}

Returns​

• <Object> local.EmulationSetScrollbarTypeOverrideResult: Command return value with the following interface:

  ;
  

emulationSetTextLayoutModeOverride​

WebDriver Bidi command to send command method "emulation.setTextLayoutModeOverride" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.emulationSetTextLayoutModeOverride(params)

Parameters​

{
  textLayoutMode: EmulationTextLayoutMode | null;
  contexts?: BrowsingContextBrowsingContext[];
  userContexts?: BrowserUserContext[];
}

Returns​

• <Object> local.EmulationSetTextLayoutModeOverrideResult: Command return value with the following interface:

  ;
  

emulationSetTimezoneOverride​

WebDriver Bidi command to send command method "emulation.setTimezoneOverride" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.emulationSetTimezoneOverride(params)

Parameters​

{
  timezone: string | null;
  contexts?: BrowsingContextBrowsingContext[];
  userContexts?: BrowserUserContext[];
}

Returns​

• <Object> local.EmulationSetTimezoneOverrideResult: Command return value with the following interface:

  ;
  

emulationSetTouchOverride​

WebDriver Bidi command to send command method "emulation.setTouchOverride" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.emulationSetTouchOverride(params)

Parameters​

{
  maxTouchPoints: JsUint | null;
  contexts?: BrowsingContextBrowsingContext[];
  userContexts?: BrowserUserContext[];
}

Returns​

• <Object> local.EmulationSetTouchOverrideResult: Command return value with the following interface:

  ;
  

networkAddDataCollector​

WebDriver Bidi command to send command method "network.addDataCollector" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.networkAddDataCollector(params)

Parameters​

{
  dataTypes: NetworkDataType[];
  maxEncodedDataSize: JsUint;
  /**
   * @default 'blob'
   */
  collectorType?: NetworkCollectorType;
  contexts?: BrowsingContextBrowsingContext[];
  userContexts?: BrowserUserContext[];
}

Returns​

• <Object> local.NetworkAddDataCollectorResult: Command return value with the following interface:

  {
    collector: NetworkCollector;
  }
  

networkAddIntercept​

WebDriver Bidi command to send command method "network.addIntercept" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.networkAddIntercept(params)

Parameters​

{
  phases: NetworkInterceptPhase[];
  contexts?: BrowsingContextBrowsingContext[];
  urlPatterns?: NetworkUrlPattern[];
}

Returns​

• <Object> local.NetworkAddInterceptResult: Command return value with the following interface:

  {
    intercept: NetworkIntercept;
  }
  

networkContinueRequest​

WebDriver Bidi command to send command method "network.continueRequest" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.networkContinueRequest(params)

Parameters​

{
  request: NetworkRequest;
  body?: NetworkBytesValue;
  cookies?: NetworkCookieHeader[];
  headers?: NetworkHeader[];
  method?: string;
  url?: string;
}

Returns​

• <Object> local.NetworkContinueRequestResult: Command return value with the following interface:

  ;
  

networkContinueResponse​

WebDriver Bidi command to send command method "network.continueResponse" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.networkContinueResponse(params)

Parameters​

{
  request: NetworkRequest;
  cookies?: NetworkSetCookieHeader[];
  credentials?: NetworkAuthCredentials;
  headers?: NetworkHeader[];
  reasonPhrase?: string;
  statusCode?: JsUint;
}

Returns​

• <Object> local.NetworkContinueResponseResult: Command return value with the following interface:

  ;
  

networkContinueWithAuth​

WebDriver Bidi command to send command method "network.continueWithAuth" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.networkContinueWithAuth(params)

Parameters​

{
  request: NetworkRequest;
};

Returns​

• <Object> local.NetworkContinueWithAuthResult: Command return value with the following interface:

  ;
  

networkDisownData​

WebDriver Bidi command to send command method "network.disownData" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.networkDisownData(params)

Parameters​

{
  dataType: NetworkDataType;
  collector: NetworkCollector;
  request: NetworkRequest;
}

Returns​

• <Object> local.NetworkDisownDataResult: Command return value with the following interface:

  ;
  

networkFailRequest​

WebDriver Bidi command to send command method "network.failRequest" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.networkFailRequest(params)

Parameters​

{
  request: NetworkRequest;
}

Returns​

• <Object> local.NetworkFailRequestResult: Command return value with the following interface:

  ;
  

networkGetData​

WebDriver Bidi command to send command method "network.getData" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.networkGetData(params)

Parameters​

{
  dataType: NetworkDataType;
  collector?: NetworkCollector;
  disown?: boolean;
  request: NetworkRequest;
}

Returns​

• <Object> local.NetworkGetDataResult: Command return value with the following interface:

  {
    bytes: NetworkBytesValue;
  }
  

networkProvideResponse​

WebDriver Bidi command to send command method "network.provideResponse" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.networkProvideResponse(params)

Parameters​

{
  request: NetworkRequest;
  body?: NetworkBytesValue;
  cookies?: NetworkSetCookieHeader[];
  headers?: NetworkHeader[];
  reasonPhrase?: string;
  statusCode?: JsUint;
}

Returns​

• <Object> local.NetworkProvideResponseResult: Command return value with the following interface:

  ;
  

networkRemoveDataCollector​

WebDriver Bidi command to send command method "network.removeDataCollector" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.networkRemoveDataCollector(params)

Parameters​

{
  collector: NetworkCollector;
}

Returns​

• <Object> local.NetworkRemoveDataCollectorResult: Command return value with the following interface:

  ;
  

networkRemoveIntercept​

WebDriver Bidi command to send command method "network.removeIntercept" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.networkRemoveIntercept(params)

Parameters​

{
  intercept: NetworkIntercept;
}

Returns​

• <Object> local.NetworkRemoveInterceptResult: Command return value with the following interface:

  ;
  

networkSetCacheBehavior​

WebDriver Bidi command to send command method "network.setCacheBehavior" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.networkSetCacheBehavior(params)

Parameters​

{
  cacheBehavior: "default" | "bypass";
  contexts?: BrowsingContextBrowsingContext[];
}

Returns​

• <Object> local.NetworkSetCacheBehaviorResult: Command return value with the following interface:

  ;
  

networkSetExtraHeaders​

WebDriver Bidi command to send command method "network.setExtraHeaders" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.networkSetExtraHeaders(params)

Parameters​

{
  headers: NetworkHeader[];
  contexts?: BrowsingContextBrowsingContext[];
  userContexts?: BrowserUserContext[];
}

Returns​

• <Object> local.NetworkSetExtraHeadersResult: Command return value with the following interface:

  ;
  

scriptAddPreloadScript​

WebDriver Bidi command to send command method "script.addPreloadScript" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.scriptAddPreloadScript(params)

Parameters​

{
  functionDeclaration: string;
  arguments?: ScriptChannelValue[];
  contexts?: BrowsingContextBrowsingContext[];
  userContexts?: BrowserUserContext[];
  sandbox?: string;
}

Returns​

• <Object> local.ScriptAddPreloadScriptResult: Command return value with the following interface:

  {
    script: ScriptPreloadScript;
  }
  

scriptDisown​

WebDriver Bidi command to send command method "script.disown" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.scriptDisown(params)

Parameters​

{
  handles: ScriptHandle[];
  target: ScriptTarget;
}

Returns​

• <Object> local.ScriptDisownResult: Command return value with the following interface:

  ;
  

scriptCallFunction​

WebDriver Bidi command to send command method "script.callFunction" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.scriptCallFunction(params)

Parameters​

{
  functionDeclaration: string;
  awaitPromise: boolean;
  target: ScriptTarget;
  arguments?: ScriptLocalValue[];
  resultOwnership?: ScriptResultOwnership;
  serializationOptions?: ScriptSerializationOptions;
  this?: ScriptLocalValue;
  userActivation?: boolean;
}

Returns​

• <Object> local.ScriptCallFunctionResult: Command return value with the following interface:

  ;
  

scriptEvaluate​

WebDriver Bidi command to send command method "script.evaluate" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.scriptEvaluate(params)

Parameters​

{
  expression: string;
  target: ScriptTarget;
  awaitPromise: boolean;
  resultOwnership?: ScriptResultOwnership;
  serializationOptions?: ScriptSerializationOptions;
  userActivation?: boolean;
}

Returns​

• <Object> local.ScriptEvaluateResult: Command return value with the following interface:

  ;
  

scriptGetRealms​

WebDriver Bidi command to send command method "script.getRealms" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.scriptGetRealms(params)

Parameters​

{
  context?: BrowsingContextBrowsingContext;
  type?: ScriptRealmType;
}

Returns​

• <Object> local.ScriptGetRealmsResult: Command return value with the following interface:

  {
    realms: ScriptRealmInfo[];
  }
  

scriptRemovePreloadScript​

WebDriver Bidi command to send command method "script.removePreloadScript" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.scriptRemovePreloadScript(params)

Parameters​

{
  script: ScriptPreloadScript;
}

Returns​

• <Object> local.ScriptRemovePreloadScriptResult: Command return value with the following interface:

  ;
  

storageGetCookies​

WebDriver Bidi command to send command method "storage.getCookies" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.storageGetCookies(params)

Parameters​

{
  filter?: StorageCookieFilter;
  partition?: StoragePartitionDescriptor;
}

Returns​

• <Object> local.StorageGetCookiesResult: Command return value with the following interface:

  {
    cookies: NetworkCookie[];
    partitionKey: StoragePartitionKey;
  }
  

storageSetCookie​

WebDriver Bidi command to send command method "storage.setCookie" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.storageSetCookie(params)

Parameters​

{
  cookie: StoragePartialCookie;
  partition?: StoragePartitionDescriptor;
}

Returns​

• <Object> local.StorageSetCookieResult: Command return value with the following interface:

  {
    partitionKey: StoragePartitionKey;
  }
  

storageDeleteCookies​

WebDriver Bidi command to send command method "storage.deleteCookies" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.storageDeleteCookies(params)

Parameters​

{
  filter?: StorageCookieFilter;
  partition?: StoragePartitionDescriptor;
}

Returns​

• <Object> local.StorageDeleteCookiesResult: Command return value with the following interface:

  {
    partitionKey: StoragePartitionKey;
  }
  

inputPerformActions​

WebDriver Bidi command to send command method "input.performActions" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.inputPerformActions(params)

Parameters​

{
  context: BrowsingContextBrowsingContext;
  actions: InputSourceActions[];
}

Returns​

• <Object> local.InputPerformActionsResult: Command return value with the following interface:

  ;
  

inputReleaseActions​

WebDriver Bidi command to send command method "input.releaseActions" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.inputReleaseActions(params)

Parameters​

{
  context: BrowsingContextBrowsingContext;
}

Returns​

• <Object> local.InputReleaseActionsResult: Command return value with the following interface:

  ;
  

inputSetFiles​

WebDriver Bidi command to send command method "input.setFiles" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.inputSetFiles(params)

Parameters​

{
  context: BrowsingContextBrowsingContext;
  element: ScriptSharedReference;
  files: string[];
}

Returns​

• <Object> local.InputSetFilesResult: Command return value with the following interface:

  ;
  

webExtensionInstall​

WebDriver Bidi command to send command method "webExtension.install" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.webExtensionInstall(params)

Parameters​

{
  extensionData: WebExtensionExtensionData;
}

Returns​

• <Object> local.WebExtensionInstallResult: Command return value with the following interface:

  {
    extension: WebExtensionExtension;
  }
  

webExtensionUninstall​

WebDriver Bidi command to send command method "webExtension.uninstall" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage​

await browser.webExtensionUninstall(params)

Parameters​

{
  extension: WebExtensionExtension;
}

Returns​

• <Object> local.WebExtensionUninstallResult: Command return value with the following interface:

  ;
  

Welcome! How can I help?