Перейти к основному содержимому

CDPSession

Экземпляры CDPSession используются для работы с сырым протоколом Chrome DevTools:

  • методы протокола могут быть вызваны с помощью метода session.send.
  • события протокола могут быть подписаны с помощью метода session.on.

Полезные ссылки:

const client = await page.context().newCDPSession(page);
await client.send('Animation.enable');
client.on('Animation.animationCreated', () => console.log('Animation created!'));
const response = await client.send('Animation.getPlaybackRate');
console.log('playback rate is ' + response.playbackRate);
await client.send('Animation.setPlaybackRate', {
playbackRate: response.playbackRate / 2
});

Методы​

detach​

Добавлено до v1.9 cdpSession.detach

Отсоединяет CDPSession от цели. После отсоединения объект CDPSession не будет генерировать события и не сможет использоваться для отправки сообщений.

Использование

await cdpSession.detach();

Возвращает


send​

Добавлено до v1.9 cdpSession.send

Использование

await cdpSession.send(method);
await cdpSession.send(method, params, options);

Аргументы

  • method string#

    Имя метода протокола.

  • params Object (необязательно)#

Необязательные параметры метода.

  • options Object (необязательно)
    • signal AbortSignal (необязательно) Добавлено в: v1.65#

      Позволяет отменить операцию с помощью AbortSignal. Если сигнал отменён, операция будет прервана и завершится с ошибкой.

    • timeout number (необязательно) Добавлено в: v1.65#

      Максимальное время ожидания ответа в миллисекундах. По умолчанию — 0, то есть без ограничения времени ожидания.

Возвращает


События​

on('close')​

Добавлено в: v1.59 cdpSession.on('close')

Генерируется при закрытии сессии: либо из-за закрытия целевого объекта, либо в результате вызова session.detach().

Использование

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

Данные события

  • [CDPSession]

on('event')​

Добавлено в: v1.59 cdpSession.on('event')

Генерируется для каждого события CDP, полученного от сессии. Позволяет подписаться сразу на все события CDP, не зная заранее их названий.

Использование

session.on('event', ({ method, params }) => {
console.log(`CDP event: ${method}`, params);
});

Данные события

  • Object
    • method string

      Название события CDP.

    • params Object (необязательно)

      Параметры события CDP. [APIRequest]: /api/class-apirequest.mdx "APIRequest" [APIRequestContext]: /api/class-apirequestcontext.mdx "APIRequestContext" [APIResponse]: /api/class-apiresponse.mdx "APIResponse" [APIResponseAssertions]: /api/class-apiresponseassertions.mdx "APIResponseAssertions" [Browser]: /api/class-browser.mdx "Browser" [BrowserContext]: /api/class-browsercontext.mdx "BrowserContext" [BrowserServer]: /api/class-browserserver.mdx "BrowserServer" [BrowserType]: /api/class-browsertype.mdx "BrowserType" [CDPSession]: /api/class-cdpsession.mdx "CDPSession" [Clock]: /api/class-clock.mdx "Clock" [ConsoleMessage]: /api/class-consolemessage.mdx "ConsoleMessage" [Coverage]: /api/class-coverage.mdx "Coverage" [Credentials]: /api/class-credentials.mdx "Credentials" [Debugger]: /api/class-debugger.mdx "Debugger" [Dialog]: /api/class-dialog.mdx "Dialog" [Disposable]: /api/class-disposable.mdx "Disposable" [Download]: /api/class-download.mdx "Download" [ElementHandle]: /api/class-elementhandle.mdx "ElementHandle" [FileChooser]: /api/class-filechooser.mdx "FileChooser" [Frame]: /api/class-frame.mdx "Frame" [FrameLocator]: /api/class-framelocator.mdx "FrameLocator" [GenericAssertions]: /api/class-genericassertions.mdx "GenericAssertions" [JSHandle]: /api/class-jshandle.mdx "JSHandle" [Keyboard]: /api/class-keyboard.mdx "Keyboard" [Locator]: /api/class-locator.mdx "Locator" [LocatorAssertions]: /api/class-locatorassertions.mdx "LocatorAssertions" [Logger]: /api/class-logger.mdx "Logger" [Mouse]: /api/class-mouse.mdx "Mouse" [Page]: /api/class-page.mdx "Page" [PageAssertions]: /api/class-pageassertions.mdx "PageAssertions" [Playwright]: /api/class-playwright.mdx "Playwright" [PlaywrightAssertions]: /api/class-playwrightassertions.mdx "PlaywrightAssertions" [Request]: /api/class-request.mdx "Request" [Response]: /api/class-response.mdx "Response" [Route]: /api/class-route.mdx "Route" [Screencast]: /api/class-screencast.mdx "Screencast" [Selectors]: /api/class-selectors.mdx "Selectors" [SnapshotAssertions]: /api/class-snapshotassertions.mdx "SnapshotAssertions" [TimeoutError]: /api/class-timeouterror.mdx "TimeoutError" [Touchscreen]: /api/class-touchscreen.mdx "Touchscreen" [Tracing]: /api/class-tracing.mdx "Tracing" [Video]: /api/class-video.mdx "Video" [WebError]: /api/class-weberror.mdx "WebError" [WebMCP]: /api/class-webmcp.mdx "WebMCP" [WebSocket]: /api/class-websocket.mdx "WebSocket" [WebSocketRoute]: /api/class-websocketroute.mdx "WebSocketRoute" [WebStorage]: /api/class-webstorage.mdx "WebStorage" [Worker]: /api/class-worker.mdx "Worker" [Electron]: /api/class-electron.mdx "Electron" [ElectronApplication]: /api/class-electronapplication.mdx "ElectronApplication" [Android]: /api/class-android.mdx "Android" [AndroidDevice]: /api/class-androiddevice.mdx "AndroidDevice" [AndroidInput]: /api/class-androidinput.mdx "AndroidInput" [AndroidSocket]: /api/class-androidsocket.mdx "AndroidSocket" [AndroidWebView]: /api/class-androidwebview.mdx "AndroidWebView" [Fixtures]: /api/class-fixtures.mdx "Fixtures" [FullConfig]: /api/class-fullconfig.mdx "FullConfig" [FullProject]: /api/class-fullproject.mdx "FullProject" [Location]: /api/class-location.mdx "Location" [Test]: /api/class-test.mdx "Test" [TestConfig]: /api/class-testconfig.mdx "TestConfig" [TestInfo]: /api/class-testinfo.mdx "TestInfo" [TestInfoError]: /api/class-testinfoerror.mdx "TestInfoError" [TestOptions]: /api/class-testoptions.mdx "TestOptions" [TestProject]: /api/class-testproject.mdx "TestProject" [TestStepInfo]: /api/class-teststepinfo.mdx "TestStepInfo" [WorkerInfo]: /api/class-workerinfo.mdx "WorkerInfo" [Reporter]: /api/class-reporter.mdx "Reporter" [Suite]: /api/class-suite.mdx "Suite" [TestCase]: /api/class-testcase.mdx "TestCase" [TestError]: /api/class-testerror.mdx "TestError" [TestResult]: /api/class-testresult.mdx "TestResult" [TestRun]: /api/class-testrun.mdx "TestRun" [TestStep]: /api/class-teststep.mdx "TestStep" [Element]: https://developer.mozilla.org/en-US/docs/Web/API/element "Element" [EvaluationArgument]: /evaluating.mdx#evaluation-argument "EvaluationArgument" Promise: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise "Promise" [iterator]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols "Iterator" [origin]: https://developer.mozilla.org/en-US/docs/Glossary/Origin "Origin" [selector]: https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors "selector" [Serializable]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Description "Serializable" [UIEvent.detail]: https://developer.mozilla.org/en-US/docs/Web/API/UIEvent/detail "UIEvent.detail" [UnixTime]: https://en.wikipedia.org/wiki/Unix_time "Unix Time" [xpath]: https://developer.mozilla.org/en-US/docs/Web/XPath "xpath"