Interface CDPSession

extends: [EventEmitter]

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

protocol methods can be called with session.send method.
protocol events can be subscribed to with session.on method.

Useful links:

Documentation on DevTools Protocol can be found here: DevTools Protocol Viewer.
Getting Started with DevTools Protocol: https://github.com/aslushnikov/getting-started-with-cdp/blob/master/README.md

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
});

Hierarchy

CDPSession

Index

Properties

addListener off on once removeListener

Methods

detach send

Properties

addListener

addListener: (<T>(event: T, listener: ((payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]) => void)) => CDPSession)

Type declaration

- <T>(event: T, listener: ((payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]) => void)): CDPSession
- Type Parameters
  - T extends symbol | keyof Events
  Parameters
  - event: T
  - listener: ((payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]) => void)
    - (payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]): void
      
      Parameters
      
      payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]
      
      Returns void
  Returns CDPSession

off

off: (<T>(event: T, listener: ((payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]) => void)) => CDPSession)

Type declaration

- <T>(event: T, listener: ((payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]) => void)): CDPSession
- Type Parameters
  - T extends symbol | keyof Events
  Parameters
  - event: T
  - listener: ((payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]) => void)
    - (payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]): void
      
      Parameters
      
      payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]
      
      Returns void
  Returns CDPSession

on

on: (<T>(event: T, listener: ((payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]) => void)) => CDPSession)

Type declaration

- <T>(event: T, listener: ((payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]) => void)): CDPSession
- Type Parameters
  - T extends symbol | keyof Events
  Parameters
  - event: T
  - listener: ((payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]) => void)
    - (payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]): void
      
      Parameters
      
      payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]
      
      Returns void
  Returns CDPSession

once

once: (<T>(event: T, listener: ((payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]) => void)) => CDPSession)

Type declaration

- <T>(event: T, listener: ((payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]) => void)): CDPSession
- Type Parameters
  - T extends symbol | keyof Events
  Parameters
  - event: T
  - listener: ((payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]) => void)
    - (payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]): void
      
      Parameters
      
      payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]
      
      Returns void
  Returns CDPSession

removeListener

removeListener: (<T>(event: T, listener: ((payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]) => void)) => CDPSession)

Type declaration

- <T>(event: T, listener: ((payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]) => void)): CDPSession
- Type Parameters
  - T extends symbol | keyof Events
  Parameters
  - event: T
  - listener: ((payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]) => void)
    - (payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]): void
      
      Parameters
      
      payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]
      
      Returns void
  Returns CDPSession

Methods

detach

detach(): Promise<void>
Detaches the CDPSession from the target. Once detached, the CDPSession object won't emit any events and can't be used to send messages.

Returns Promise<void>
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12225

send

send<T>(method: T, params?: CommandParameters[T]): Promise<CommandReturnValues[T]>
Type Parameters
- T extends keyof CommandParameters
Parameters
- method: T
  
  Protocol method name.
- Optional params: CommandParameters[T]
  
  Optional method parameters.
Returns Promise<CommandReturnValues[T]>
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12217

Interface CDPSession

Hierarchy

Index

Properties

Methods

Properties

addListener

Type declaration

Type Parameters

T extends symbol | keyof Events

Parameters

event: T

listener: ((payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]) => void)

Parameters

payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]

Returns void

Returns CDPSession

off

Type declaration

Type Parameters

T extends symbol | keyof Events

Parameters

event: T

listener: ((payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]) => void)

Parameters

payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]

Returns void

Returns CDPSession

on

Type declaration

Type Parameters

T extends symbol | keyof Events

Parameters

event: T

listener: ((payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]) => void)

Parameters

payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]

Returns void

Returns CDPSession

once

Type declaration

Type Parameters

T extends symbol | keyof Events

Parameters

event: T

listener: ((payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]) => void)

Parameters

payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]

Returns void

Returns CDPSession

removeListener

Type declaration

Type Parameters

T extends symbol | keyof Events

Parameters

event: T

listener: ((payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]) => void)

Parameters

payload: T extends symbol ? any : Events[T extends keyof Events ? T : never]

Returns void

Returns CDPSession

Methods

detach

Returns Promise<void>

send

Type Parameters

T extends keyof CommandParameters

Parameters

method: T

Optional params: CommandParameters[T]

Returns Promise<CommandReturnValues[T]>

Settings

Member Visibility

Theme

`Optional` params: CommandParameters[T]