mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
93e9acc410
Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Nikolay Vitkov <nvitkov@chromium.org>
96 lines
2.0 KiB
Markdown
96 lines
2.0 KiB
Markdown
---
|
|
sidebar_label: CDPSession
|
|
---
|
|
|
|
# CDPSession class
|
|
|
|
The `CDPSession` instances are used to talk raw Chrome Devtools Protocol.
|
|
|
|
#### Signature:
|
|
|
|
```typescript
|
|
export declare abstract class CDPSession extends EventEmitter<CDPSessionEvents>
|
|
```
|
|
|
|
**Extends:** [EventEmitter](./puppeteer.eventemitter.md)<[CDPSessionEvents](./puppeteer.cdpsessionevents.md)>
|
|
|
|
## Remarks
|
|
|
|
Protocol methods can be called with [CDPSession.send()](./puppeteer.cdpsession.send.md) method and protocol events can be subscribed to with `CDPSession.on` method.
|
|
|
|
Useful links: [DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/) and [Getting Started with DevTools Protocol](https://github.com/aslushnikov/getting-started-with-cdp/blob/HEAD/README.md).
|
|
|
|
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `CDPSession` class.
|
|
|
|
## Example
|
|
|
|
```ts
|
|
const client = await page.target().createCDPSession();
|
|
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,
|
|
});
|
|
```
|
|
|
|
## Methods
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Method
|
|
|
|
</th><th>
|
|
|
|
Modifiers
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
[connection()](./puppeteer.cdpsession.connection.md)
|
|
|
|
</td><td>
|
|
|
|
</td><td>
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[detach()](./puppeteer.cdpsession.detach.md)
|
|
|
|
</td><td>
|
|
|
|
</td><td>
|
|
|
|
Detaches the cdpSession from the target. Once detached, the cdpSession object won't emit any events and can't be used to send messages.
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[id()](./puppeteer.cdpsession.id.md)
|
|
|
|
</td><td>
|
|
|
|
</td><td>
|
|
|
|
Returns the session's id.
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[send(method, params, options)](./puppeteer.cdpsession.send.md)
|
|
|
|
</td><td>
|
|
|
|
</td><td>
|
|
|
|
</td></tr>
|
|
</tbody></table>
|