mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00

fix: update documentation on configuring puppeteer (#9150 )

This PR updates the docs regarding configuring puppeteer. In addition,
some changes have been made to the documentation generator to show
default values on the documentation site.

Also fixes: https://github.com/puppeteer/puppeteer/pull/9144

2022-10-24 09:07:05 +02:00

2.5 KiB

Raw Blame History

sidebar_label
CDPSession

CDPSession class

The CDPSession instances are used to talk raw Chrome Devtools Protocol.

Signature:

export declare class CDPSession extends EventEmitter

Extends: EventEmitter

Remarks

Protocol methods can be called with CDPSession.send() method and protocol events can be subscribed to with CDPSession.on method.

Useful links: DevTools Protocol Viewer and Getting Started with DevTools Protocol.

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

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

Method	Modifiers	Description
connection()
detach()		Detaches the cdpSession from the target. Once detached, the cdpSession object won't emit any events and can't be used to send messages.
id()		Returns the session's id.
send(method, paramArgs)

2.5 KiB Raw Blame History