浏览器上下文

浏览器上下文提供了一种操作多个独立浏览器会话的方式。

如果页面打开另一个页面，例如通过 window.open 调用，则弹出窗口将属于父页面的浏览器上下文。

Playwright 允许使用 browser.newContext() 方法创建隔离的非持久性浏览器上下文。非持久性浏览器上下文不会将任何浏览数据写入磁盘。

// Create a new incognito browser context
const context = await browser.newContext();
// Create a new page inside context.
const page = await context.newPage();
await page.goto('https://example.com');
// Dispose context once it's no longer needed.
await context.close();

方法

addCookies

在 v1.9 之前添加

browserContext.addCookies

将 Cookie 添加到此浏览器上下文中。此上下文中的所有页面都将安装这些 Cookie。Cookie 可以通过 browserContext.cookies() 获取。

用法

await browserContext.addCookies([cookieObject1, cookieObject2]);

参数

cookies Array<Object>#
- name string
- value string
- url string （可选）
  
  url 或 domain / path 是必需的。可选。
- domain string （可选）
  
  为了使 Cookie 也适用于所有子域，请在域前加上一个点，例如：".example.com"。url 或 domain / path 是必需的。可选。
- path string （可选）
  
  url 或 domain / path 是必需的可选。
- expires number （可选）
  
  Unix 时间戳，以秒为单位。可选。
- httpOnly boolean （可选）
  
  可选。
- secure boolean （可选）
  
  可选。
- sameSite "Strict" | "Lax" | "None" （可选）
  
  可选。

返回值

Promise<void>#

addInitScript

在 v1.9 之前添加

browserContext.addInitScript

添加一个脚本，该脚本将在以下情况之一中执行：

每当在浏览器上下文中创建或导航页面时。
每当在浏览器上下文中的任何页面中附加或导航子框架时。在这种情况下，脚本在新附加的框架的上下文中执行。

脚本在文档创建后但在其任何脚本运行之前执行。这对于修改 JavaScript 环境很有用，例如，为 Math.random 播种。

用法

在页面加载之前覆盖 Math.random 的示例

// preload.js
Math.random = () => 42;

// In your playwright script, assuming the preload.js file is in same directory.
await browserContext.addInitScript({
  path: 'preload.js'
});

注意

通过 browserContext.addInitScript() 和 page.addInitScript() 安装的多个脚本的评估顺序未定义。

参数

script function | string | Object #
- path string （可选）
  
  JavaScript 文件的路径。如果 path 是相对路径，则相对于当前工作目录解析。可选。
- content string （可选）
  
  原始脚本内容。可选。
要在浏览器上下文中所有页面中评估的脚本。
arg Serializable （可选）#

传递给 script 的可选参数（仅在传递函数时支持）。

返回值

Promise<void>#

backgroundPages

添加于：v1.11

browserContext.backgroundPages

注意

后台页面仅在基于 Chromium 的浏览器上受支持。

上下文中所有现有的后台页面。

用法

browserContext.backgroundPages();

返回值

Array<Page>#

browser

在 v1.9 之前添加

browserContext.browser

返回上下文的浏览器实例。如果它是作为持久上下文启动的，则返回 null。

用法

browserContext.browser();

返回值

null | Browser #

clearCookies

在 v1.9 之前添加

browserContext.clearCookies

从上下文中删除 Cookie。接受可选过滤器。

用法

await context.clearCookies();
await context.clearCookies({ name: 'session-id' });
await context.clearCookies({ domain: 'my-origin.com' });
await context.clearCookies({ domain: /.*my-origin\.com/ });
await context.clearCookies({ path: '/api/v1' });
await context.clearCookies({ name: 'session-id', domain: 'my-origin.com' });

参数

options Object （可选）
- domain string | RegExp （可选）添加于：v1.43#
  
  仅删除具有给定域的 Cookie。
- name string | RegExp （可选）添加于：v1.43#
  
  仅删除具有给定名称的 Cookie。
- path string | RegExp （可选）添加于：v1.43#
  
  仅删除具有给定路径的 Cookie。

返回值

Promise<void>#

clearPermissions

在 v1.9 之前添加

browserContext.clearPermissions

清除浏览器上下文的所有权限覆盖。

用法

const context = await browser.newContext();
await context.grantPermissions(['clipboard-read']);
// do stuff ..
context.clearPermissions();

返回值

Promise<void>#

close

在 v1.9 之前添加

browserContext.close

关闭浏览器上下文。属于浏览器上下文的所有页面都将被关闭。

注意

默认浏览器上下文无法关闭。

用法

await browserContext.close();
await browserContext.close(options);

参数

options Object （可选）
- reason string （可选）添加于：v1.40#
  
  报告给上下文关闭中断的操作的原因。

返回值

Promise<void>#

cookies

在 v1.9 之前添加

browserContext.cookies

如果未指定 URL，则此方法返回所有 Cookie。如果指定了 URL，则仅返回影响这些 URL 的 Cookie。

用法

await browserContext.cookies();
await browserContext.cookies(urls);

参数

urls string | Array<string> （可选）#

可选的 URL 列表。

返回值

Promise<Array<Object>>#
- name string
- value string
- domain string
- path string
- expires number
  
  Unix 时间戳，以秒为单位。
- httpOnly boolean
- secure boolean
- sameSite "Strict" | "Lax" | "None"

exposeBinding

在 v1.9 之前添加

browserContext.exposeBinding

该方法在上下文中每个页面的每个框架的 window 对象上添加一个名为 name 的函数。调用时，该函数执行 callback 并返回一个 Promise，该 Promise 解析为 callback 的返回值。如果 callback 返回一个 Promise，它将被等待。

callback 函数的第一个参数包含有关调用者的信息：{ browserContext: BrowserContext, page: Page, frame: Frame }。

有关仅页面版本的更多信息，请参阅 page.exposeBinding()。

用法

将页面 URL 公开给上下文中所有页面的所有框架的示例

const { webkit } = require('playwright');  // Or 'chromium' or 'firefox'.

(async () => {
  const browser = await webkit.launch({ headless: false });
  const context = await browser.newContext();
  await context.exposeBinding('pageURL', ({ page }) => page.url());
  const page = await context.newPage();
  await page.setContent(`
    <script>
      async function onClick() {
        document.querySelector('div').textContent = await window.pageURL();
      }
    </script>
    <button onclick="onClick()">Click me</button>
    <div></div>
  `);
  await page.getByRole('button').click();
})();

参数

name string #

window 对象上函数的名称。
callback function #

将在 Playwright 的上下文中调用的回调函数。
options Object （可选）
- handle boolean （可选）#
  
  已弃用
  此选项将在未来版本中删除。
  
  是否将参数作为句柄传递，而不是按值传递。当传递句柄时，仅支持一个参数。当按值传递时，支持多个参数。

返回值

Promise<void>#

exposeFunction

在 v1.9 之前添加

browserContext.exposeFunction

该方法在上下文中每个页面的每个框架的 window 对象上添加一个名为 name 的函数。调用时，该函数执行 callback 并返回一个 Promise，该 Promise 解析为 callback 的返回值。

如果 callback 返回一个 Promise，它将被等待。

有关仅页面版本的更多信息，请参阅 page.exposeFunction()。

用法

向上下文中的所有页面添加 sha256 函数的示例

const { webkit } = require('playwright');  // Or 'chromium' or 'firefox'.
const crypto = require('crypto');

(async () => {
  const browser = await webkit.launch({ headless: false });
  const context = await browser.newContext();
  await context.exposeFunction('sha256', text =>
    crypto.createHash('sha256').update(text).digest('hex'),
  );
  const page = await context.newPage();
  await page.setContent(`
    <script>
      async function onClick() {
        document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');
      }
    </script>
    <button onclick="onClick()">Click me</button>
    <div></div>
  `);
  await page.getByRole('button').click();
})();

参数

name string #

window 对象上函数的名称。
callback function #

将在 Playwright 的上下文中调用的回调函数。

返回值

Promise<void>#

grantPermissions

在 v1.9 之前添加

browserContext.grantPermissions

向浏览器上下文授予指定的权限。如果指定，则仅向给定的来源授予相应的权限。

用法

await browserContext.grantPermissions(permissions);
await browserContext.grantPermissions(permissions, options);

参数

permissions Array<string>#

要授予的权限列表。

危险
支持的权限在浏览器之间甚至同一浏览器的不同版本之间有所不同。任何权限都可能在更新后停止工作。

以下是一些可能受某些浏览器支持的权限
- 'accelerometer'
- 'ambient-light-sensor'
- 'background-sync'
- 'camera'
- 'clipboard-read'
- 'clipboard-write'
- 'geolocation'
- 'gyroscope'
- 'magnetometer'
- 'microphone'
- 'midi-sysex' (系统独占 midi)
- 'midi'
- 'notifications'
- 'payment-handler'
- 'storage-access'
options Object （可选）
- origin string （可选）#
  
  要授予权限的来源，例如 "https://example.com"。

返回值

Promise<void>#

newCDPSession

添加于：v1.11

browserContext.newCDPSession

注意

CDP 会话仅在基于 Chromium 的浏览器上受支持。

返回新创建的会话。

用法

await browserContext.newCDPSession(page);

参数

page Page | Frame #

要为其创建新会话的目标。为了向后兼容，此参数名为 page，但它可以是 Page 或 Frame 类型。

返回值

Promise<CDPSession>#

newPage

在 v1.9 之前添加

browserContext.newPage

在浏览器上下文中创建一个新页面。

用法

await browserContext.newPage();

返回值

Promise<Page>#

pages

在 v1.9 之前添加

browserContext.pages

返回上下文中所有打开的页面。

用法

browserContext.pages();

返回值

Array<Page>#

removeAllListeners

添加于：v1.47

browserContext.removeAllListeners

删除给定类型的所有侦听器（如果未给定类型，则删除所有注册的侦听器）。允许等待异步侦听器完成或忽略来自这些侦听器的后续错误。

用法

await browserContext.removeAllListeners();
await browserContext.removeAllListeners(type, options);

参数

type string （可选）#
options Object （可选）
- behavior "wait" | "ignoreErrors" | "default" （可选）#
  
  指定是否等待已运行的侦听器以及如果它们抛出错误该怎么办
  - 'default' - 不等待当前的侦听器调用（如果有）完成，如果侦听器抛出错误，则可能导致未处理的错误
  - 'wait' - 等待当前的侦听器调用（如果有）完成
  - 'ignoreErrors' - 不等待当前的侦听器调用（如果有）完成，删除后侦听器抛出的所有错误都将被静默捕获

返回值

Promise<void>#

route

在 v1.9 之前添加

browserContext.route

路由提供了修改浏览器上下文中任何页面发出的网络请求的功能。启用路由后，每个与 url 模式匹配的请求都将暂停，除非它被继续、完成或中止。

注意

browserContext.route() 不会拦截 Service Worker 拦截的请求。请参阅此问题。我们建议在使用请求拦截时禁用 Service Worker，方法是将 serviceWorkers 设置为 'block'。

用法

中止所有图像请求的简单处理程序示例

const context = await browser.newContext();
await context.route('**/*.{png,jpg,jpeg}', route => route.abort());
const page = await context.newPage();
await page.goto('https://example.com');
await browser.close();

或使用正则表达式模式的相同代码片段

const context = await browser.newContext();
await context.route(/(\.png$)|(\.jpg$)/, route => route.abort());
const page = await context.newPage();
await page.goto('https://example.com');
await browser.close();

可以检查请求以决定路由操作。例如，模拟包含某些 post 数据的所有请求，并将所有其他请求保持原样

await context.route('/api/**', async route => {
  if (route.request().postData().includes('my-string'))
    await route.fulfill({ body: 'mocked-data' });
  else
    await route.continue();
});

当请求与两个处理程序都匹配时，页面路由（使用 page.route() 设置）优先于浏览器上下文路由。

要删除带有其处理程序的路由，您可以使用 browserContext.unroute()。

注意

启用路由会禁用 http 缓存。

参数

url string | RegExp | function(URL):boolean #

一个 glob 模式、正则表达式模式或谓词，接收 URL 以在路由时匹配。当通过上下文选项提供了 baseURL 且传递的 URL 是路径时，它会通过 new URL() 构造函数合并。
handler function(Route, Request):Promise<Object> | Object #

用于路由请求的处理函数。
options Object （可选）
- times number （可选）添加于：v1.15#
  
  路由应使用的频率。默认情况下，它将每次都使用。

返回值

Promise<void>#

routeFromHAR

添加于：v1.23

browserContext.routeFromHAR

如果指定，则上下文中发出的网络请求将从 HAR 文件提供。阅读更多关于从 HAR 文件回放的信息。

Playwright 不会从 HAR 文件中提供 Service Worker 拦截的请求。请参阅此问题。我们建议在使用请求拦截时禁用 Service Worker，方法是将 serviceWorkers 设置为 'block'。

用法

await browserContext.routeFromHAR(har);
await browserContext.routeFromHAR(har, options);

参数

har string #

具有预先录制的网络数据的 HAR 文件的路径。如果 path 是相对路径，则相对于当前工作目录解析。
options Object （可选）
- notFound "abort" | "fallback" （可选）#
  - 如果设置为 'abort'，则任何在 HAR 文件中找不到的请求都将被中止。
  - 如果设置为 'fallback'，则会回退到处理程序链中的下一个路由处理程序。
  默认为 abort。
- update boolean (可选)#
  
  如果指定，则使用实际的网络信息更新给定的 HAR，而不是从文件提供服务。当调用 browserContext.close() 时，该文件将被写入磁盘。
- updateContent "embed" | "attach" (可选)添加于: v1.32#
  
  用于控制资源内容管理的可选设置。如果指定 attach，资源将作为单独的文件或 ZIP 存档中的条目持久保存。如果指定 embed，内容将以内联方式存储在 HAR 文件中。
- updateMode "full" | "minimal" (可选)添加于: v1.32#
  
  当设置为 minimal 时，仅记录从 HAR 路由所需的信息。这会省略大小、时间、页面、cookies、安全和其他类型的 HAR 信息，这些信息在从 HAR 重放时不会使用。默认为 minimal。
- url string | RegExp (可选)#
  
  用于匹配请求 URL 的 glob 模式、正则表达式或谓词。只有 URL 与该模式匹配的请求才会从 HAR 文件提供服务。如果未指定，则所有请求都将从 HAR 文件提供服务。

返回值

Promise<void>#

routeWebSocket

添加于: v1.48

browserContext.routeWebSocket

此方法允许修改浏览器上下文中任何页面建立的 websocket 连接。

请注意，只有在此方法调用后创建的 WebSocket 才会被路由。建议在创建任何页面之前调用此方法。

用法

以下是一个简单的处理程序示例，用于阻止某些 websocket 消息。有关更多详细信息和示例，请参阅 WebSocketRoute。

await context.routeWebSocket('/ws', async ws => {
  ws.routeSend(message => {
    if (message === 'to-be-blocked')
      return;
    ws.send(message);
  });
  await ws.connect();
});

参数

url string | RegExp | function(URL):boolean #

只有 URL 与此模式匹配的 WebSocket 才会被路由。字符串模式可以是相对于 baseURL 上下文选项的相对路径。
handler function(WebSocketRoute):Promise<Object> | Object #

用于路由 WebSocket 的处理函数。

返回值

Promise<void>#

serviceWorkers

添加于：v1.11

browserContext.serviceWorkers

注意

Service workers 仅在基于 Chromium 的浏览器上受支持。

上下文中所有现有的 service workers。

用法

browserContext.serviceWorkers();

返回值

Array<Worker>#

在 v1.9 之前添加

browserContext.setDefaultNavigationTimeout

此设置将更改以下方法和相关快捷方式的默认最大导航时间

注意

page.setDefaultNavigationTimeout() 和 page.setDefaultTimeout() 的优先级高于 browserContext.setDefaultNavigationTimeout()。

用法

browserContext.setDefaultNavigationTimeout(timeout);

参数

timeout number #

最大导航时间，单位为毫秒

setDefaultTimeout

在 v1.9 之前添加

browserContext.setDefaultTimeout

此设置将更改所有接受 timeout 选项的方法的默认最大时间。

注意

page.setDefaultNavigationTimeout()、page.setDefaultTimeout() 和 browserContext.setDefaultNavigationTimeout() 的优先级高于 browserContext.setDefaultTimeout()。

用法

browserContext.setDefaultTimeout(timeout);

参数

timeout number #

最大时间，单位为毫秒。传递 0 以禁用超时。

setExtraHTTPHeaders

在 v1.9 之前添加

browserContext.setExtraHTTPHeaders

额外的 HTTP 标头将随上下文中任何页面发起的每个请求一起发送。这些标头与使用 page.setExtraHTTPHeaders() 设置的页面特定的额外 HTTP 标头合并。如果页面覆盖了特定的标头，则将使用页面特定的标头值而不是浏览器上下文标头值。

注意

browserContext.setExtraHTTPHeaders() 不保证传出请求中标头的顺序。

用法

await browserContext.setExtraHTTPHeaders(headers);

参数

headers Object<string, string>#

一个对象，其中包含要随每个请求一起发送的附加 HTTP 标头。所有标头值都必须是字符串。

返回值

Promise<void>#

setGeolocation

在 v1.9 之前添加

browserContext.setGeolocation

设置上下文的地理位置。传递 null 或 undefined 模拟位置不可用。

用法

await browserContext.setGeolocation({ latitude: 59.95, longitude: 30.31667 });

注意

考虑使用 browserContext.grantPermissions() 授予浏览器上下文页面读取其地理位置的权限。

参数

geolocation null | Object#
- latitude number
  
  纬度，介于 -90 和 90 之间。
- longitude number
  
  经度，介于 -180 和 180 之间。
- accuracy number (可选)
  
  非负精度值。默认为 0。

返回值

Promise<void>#

setOffline

在 v1.9 之前添加

browserContext.setOffline

用法

await browserContext.setOffline(offline);

参数

offline boolean #

是否为浏览器上下文模拟网络离线状态。

返回值

Promise<void>#

storageState

在 v1.9 之前添加

browserContext.storageState

返回此浏览器上下文的存储状态，包含当前 cookies、本地存储快照和 IndexedDB 快照。

用法

await browserContext.storageState();
await browserContext.storageState(options);

参数

options Object （可选）
- indexedDB boolean (可选)添加于: v1.51#
  
  设置为 true 以在存储状态快照中包含 IndexedDB。如果您的应用程序使用 IndexedDB 存储身份验证令牌（例如 Firebase Authentication），请启用此选项。
  
  注意
  目前不支持带有类型化数组的 IndexedDB。
- path string (可选)#
  
  用于保存存储状态的文件路径。如果 path 是相对路径，则它将相对于当前工作目录解析。如果未提供路径，则仍会返回存储状态，但不会保存到磁盘。

返回值

Promise<Object>#
- cookies Array<Object>
  - name string
  - value string
  - domain string
  - path string
  - expires number
    
    Unix 时间戳，以秒为单位。
  - httpOnly boolean
  - secure boolean
  - sameSite "Strict" | "Lax" | "None"
- origins Array<Object>
  - origin string
  - localStorage Array<Object>
    - name string
    - value string

unroute

在 v1.9 之前添加

browserContext.unroute

移除使用 browserContext.route() 创建的路由。当未指定 handler 时，移除 url 的所有路由。

用法

await browserContext.unroute(url);
await browserContext.unroute(url, handler);

参数

url string | RegExp | function(URL):boolean #

glob 模式、正则表达式模式或谓词，接收 URL，用于注册使用 browserContext.route() 的路由。
handler function(Route, Request):Promise<Object> | Object (可选)#

可选的处理函数，用于注册使用 browserContext.route() 的路由。

返回值

Promise<void>#

unrouteAll

添加于: v1.41

browserContext.unrouteAll

移除使用 browserContext.route() 和 browserContext.routeFromHAR() 创建的所有路由。

用法

await browserContext.unrouteAll();
await browserContext.unrouteAll(options);

参数

options Object （可选）
- behavior "wait" | "ignoreErrors" | "default" (可选)#
  
  指定是否等待已运行的处理程序以及如果它们抛出错误该如何处理
  - 'default' - 不等待当前处理程序调用（如果有）完成，如果未路由的处理程序抛出错误，则可能导致未处理的错误
  - 'wait' - 等待当前处理程序调用（如果有）完成
  - 'ignoreErrors' - 不等待当前处理程序调用（如果有）完成，取消路由后处理程序抛出的所有错误都将被静默捕获

返回值

Promise<void>#

waitForEvent

在 v1.9 之前添加

browserContext.waitForEvent

等待事件触发并将其值传递到谓词函数中。当谓词返回真值时返回。如果上下文在事件触发之前关闭，将抛出错误。返回事件数据值。

用法

const pagePromise = context.waitForEvent('page');
await page.getByRole('button').click();
const page = await pagePromise;

参数

event string #

事件名称，与传递到 browserContext.on(event) 中的名称相同。
optionsOrPredicate function | Object (可选)#
- predicate function
  
  接收事件数据，并在等待应该解决时解析为真值。
- timeout number (可选)
  
  最大等待时间，单位为毫秒。默认为 0 - 无超时。默认值可以通过配置中的 actionTimeout 选项更改，也可以通过使用 browserContext.setDefaultTimeout() 方法更改。
接收事件的谓词或选项对象。可选。
options Object （可选）
- predicate function (可选)#
  
  接收事件数据，并在等待应该解决时解析为真值。

返回值

Promise<Object>#

属性

clock

添加于: v1.45

browserContext.clock

Playwright 具有模拟时钟和时间流逝的能力。

用法

browserContext.clock

类型

时钟

request

添加于: v1.16

browserContext.request

与此上下文关联的 API 测试助手。使用此 API 发出的请求将使用上下文 cookies。

用法

browserContext.request

类型

APIRequestContext

tracing

添加于: v1.12

browserContext.tracing

用法

browserContext.tracing

类型

追踪

事件

on('backgroundpage')

添加于：v1.11

browserContext.on('backgroundpage')

注意

仅适用于 Chromium 浏览器的持久上下文。

当在上下文中创建新的后台页面时发出。

const backgroundPage = await context.waitForEvent('backgroundpage');

用法

browserContext.on('backgroundpage', data => {});

事件数据

页面

on('close')

在 v1.9 之前添加

browserContext.on('close')

当浏览器上下文关闭时发出。这可能是由于以下原因之一造成的

浏览器上下文已关闭。
浏览器应用程序已关闭或崩溃。
调用了 browser.close() 方法。

用法

browserContext.on('close', data => {});

事件数据

浏览器上下文

on('console')

添加于: v1.34

browserContext.on('console')

当页面内的 JavaScript 调用 console API 方法之一时发出，例如 console.log 或 console.dir。

传递到 console.log 中的参数和页面在 ConsoleMessage 事件处理程序参数中可用。

用法

context.on('console', async msg => {
  const values = [];
  for (const arg of msg.args())
    values.push(await arg.jsonValue());
  console.log(...values);
});
await page.evaluate(() => console.log('hello', 5, { foo: 'bar' }));

事件数据

控制台消息

on('dialog')

添加于: v1.34

browserContext.on('dialog')

当出现 JavaScript 对话框时发出，例如 alert、prompt、confirm 或 beforeunload。侦听器必须 dialog.accept() 或 dialog.dismiss() 对话框 - 否则页面将冻结等待对话框，并且像单击这样的操作将永远不会完成。

用法

context.on('dialog', dialog => {
  dialog.accept();
});

注意

当没有 page.on('dialog') 或 browserContext.on('dialog') 侦听器时，所有对话框都会自动关闭。

事件数据

对话框

on('page')

在 v1.9 之前添加

browserContext.on('page')

当在 BrowserContext 中创建新页面时，将发出此事件。页面可能仍在加载中。此事件也将在弹出页面上触发。另请参阅 page.on('popup') 以接收有关特定页面的弹出窗口的事件。

页面可用的最早时刻是它导航到初始 url 时。例如，当使用 window.open('http://example.com') 打开弹出窗口时，当对 "http://example.com" 的网络请求完成并且其响应已开始在弹出窗口中加载时，将触发此事件。如果您想路由/监听此网络请求，请分别使用 browserContext.route() 和 browserContext.on('request')，而不是 Page 上的类似方法。

const newPagePromise = context.waitForEvent('page');
await page.getByText('open new page').click();
const newPage = await newPagePromise;
console.log(await newPage.evaluate('location.href'));

注意

使用 page.waitForLoadState() 等待页面达到特定状态（在大多数情况下您不需要它）。

用法

browserContext.on('page', data => {});

事件数据

页面

on('request')

添加于: v1.12

browserContext.on('request')

当从此上下文创建的任何页面发出请求时发出。request 对象是只读的。要仅监听来自特定页面的请求，请使用 page.on('request')。

为了拦截和修改请求，请参阅 browserContext.route() 或 page.route()。

用法

browserContext.on('request', data => {});

事件数据

请求

on('requestfailed')

添加于: v1.12

browserContext.on('requestfailed')

当请求失败时发出，例如由于超时。要仅监听来自特定页面的失败请求，请使用 page.on('requestfailed')。

注意

HTTP 错误响应（例如 404 或 503）从 HTTP 的角度来看仍然是成功的响应，因此请求将通过 browserContext.on('requestfinished') 事件完成，而不是通过 browserContext.on('requestfailed') 完成。

用法

browserContext.on('requestfailed', data => {});

事件数据

请求

on('requestfinished')

添加于: v1.12

browserContext.on('requestfinished')

当请求在下载响应正文后成功完成时发出。对于成功的响应，事件序列为 request、response 和 requestfinished。要监听来自特定页面的成功请求，请使用 page.on('requestfinished')。

用法

browserContext.on('requestfinished', data => {});

事件数据

请求

on('response')

添加于: v1.12

browserContext.on('response')

当收到请求的 response 状态和标头时发出。对于成功的响应，事件序列为 request、response 和 requestfinished。要监听来自特定页面的响应事件，请使用 page.on('response')。

用法

browserContext.on('response', data => {});

事件数据

响应

on('serviceworker')

添加于：v1.11

browserContext.on('serviceworker')

注意

Service workers 仅在基于 Chromium 的浏览器上受支持。

当在上下文中创建新的 service worker 时发出。

用法

browserContext.on('serviceworker', data => {});

事件数据

Worker

on('weberror')

添加于: v1.38

browserContext.on('weberror')

当在此上下文中任何页面中发生未处理的异常时发出。要监听来自特定页面的错误，请改用 page.on('pageerror')。

用法

browserContext.on('weberror', data => {});

事件数据

WebError

已弃用

setHTTPCredentials

在 v1.9 之前添加

browserContext.setHTTPCredentials

已弃用

浏览器可能会在成功身份验证后缓存凭据。请创建一个新的浏览器上下文。

用法

await browserContext.setHTTPCredentials(httpCredentials);

参数

httpCredentials null | Object#
- username string
- password string

返回值

Promise<void>#

方法​

addCookies​

addInitScript​

backgroundPages​

browser​

clearCookies​

clearPermissions​

close​

cookies​

exposeBinding​

exposeFunction​

grantPermissions​

newCDPSession​

newPage​

pages​

removeAllListeners​

route​

routeFromHAR​

routeWebSocket​

serviceWorkers​

setDefaultNavigationTimeout​

setDefaultTimeout​

setExtraHTTPHeaders​

setGeolocation​

setOffline​

storageState​

unroute​

unrouteAll​

waitForEvent​

属性​

clock​

request​

tracing​

事件​

on('backgroundpage')​

on('close')​

on('console')​

on('dialog')​

on('page')​

on('request')​

on('requestfailed')​

on('requestfinished')​

on('response')​

on('serviceworker')​

on('weberror')​

已弃用​

setHTTPCredentials​

方法

addCookies

addInitScript

backgroundPages

browser

clearCookies

clearPermissions

close

cookies

exposeBinding

exposeFunction

grantPermissions

newCDPSession

newPage

pages

removeAllListeners

route

routeFromHAR

routeWebSocket

serviceWorkers

setDefaultNavigationTimeout

setDefaultTimeout

setExtraHTTPHeaders

setGeolocation

setOffline

storageState

unroute

unrouteAll

waitForEvent

属性

clock

request

tracing

事件

on('backgroundpage')

on('close')

on('console')

on('dialog')

on('page')

on('request')

on('requestfailed')

on('requestfinished')

on('response')

on('serviceworker')

on('weberror')

已弃用

setHTTPCredentials