Interface WebSocket

The WebSocket class represents WebSocket connections within a page. It provides the ability to inspect and manipulate the data being transmitted and received.

If you want to intercept or modify WebSocket frames, consider using WebSocketRoute.

Hierarchy

WebSocket

Index

Methods

addListener isClosed off on once prependListener removeListener url waitForEvent

Methods

addListener

addListener(event, listener): WebSocket
Fired when the websocket closes.
Parameters
- event: "close"
- listener: ((webSocket) => any)
  - - (webSocket): any
    - Parameters
      
      webSocket: WebSocket
      
      Returns any
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21548
addListener(event, listener): WebSocket
Fired when the websocket receives a frame.
Parameters
- event: "framereceived"
- listener: ((data) => any)
  - - (data): any
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns any
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21553
addListener(event, listener): WebSocket
Fired when the websocket sends a frame.
Parameters
- event: "framesent"
- listener: ((data) => any)
  - - (data): any
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns any
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21563
addListener(event, listener): WebSocket
Fired when the websocket has an error.
Parameters
- event: "socketerror"
- listener: ((string) => any)
  - - (string): any
    - Parameters
      
      string: string
      
      Returns any
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21573

isClosed

isClosed(): boolean
Indicates that the web socket has been closed.

Returns boolean
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21668

off

off(event, listener): WebSocket
Removes an event listener added by on or addListener.
Parameters
- event: "close"
- listener: ((webSocket) => any)
  - - (webSocket): any
    - Parameters
      
      webSocket: WebSocket
      
      Returns any
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21608
off(event, listener): WebSocket
Removes an event listener added by on or addListener.
Parameters
- event: "framereceived"
- listener: ((data) => any)
  - - (data): any
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns any
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21613
off(event, listener): WebSocket
Removes an event listener added by on or addListener.
Parameters
- event: "framesent"
- listener: ((data) => any)
  - - (data): any
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns any
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21623
off(event, listener): WebSocket
Removes an event listener added by on or addListener.
Parameters
- event: "socketerror"
- listener: ((string) => any)
  - - (string): any
    - Parameters
      
      string: string
      
      Returns any
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21633

on

on(event, listener): WebSocket
Fired when the websocket closes.
Parameters
- event: "close"
- listener: ((webSocket) => any)
  - - (webSocket): any
    - Parameters
      
      webSocket: WebSocket
      
      Returns any
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21488
on(event, listener): WebSocket
Fired when the websocket receives a frame.
Parameters
- event: "framereceived"
- listener: ((data) => any)
  - - (data): any
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns any
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21493
on(event, listener): WebSocket
Fired when the websocket sends a frame.
Parameters
- event: "framesent"
- listener: ((data) => any)
  - - (data): any
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns any
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21503
on(event, listener): WebSocket
Fired when the websocket has an error.
Parameters
- event: "socketerror"
- listener: ((string) => any)
  - - (string): any
    - Parameters
      
      string: string
      
      Returns any
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21513

once

once(event, listener): WebSocket
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Parameters
- event: "close"
- listener: ((webSocket) => any)
  - - (webSocket): any
    - Parameters
      
      webSocket: WebSocket
      
      Returns any
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21518
once(event, listener): WebSocket
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Parameters
- event: "framereceived"
- listener: ((data) => any)
  - - (data): any
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns any
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21523
once(event, listener): WebSocket
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Parameters
- event: "framesent"
- listener: ((data) => any)
  - - (data): any
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns any
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21533
once(event, listener): WebSocket
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Parameters
- event: "socketerror"
- listener: ((string) => any)
  - - (string): any
    - Parameters
      
      string: string
      
      Returns any
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21543

prependListener

prependListener(event, listener): WebSocket
Fired when the websocket closes.
Parameters
- event: "close"
- listener: ((webSocket) => any)
  - - (webSocket): any
    - Parameters
      
      webSocket: WebSocket
      
      Returns any
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21638
prependListener(event, listener): WebSocket
Fired when the websocket receives a frame.
Parameters
- event: "framereceived"
- listener: ((data) => any)
  - - (data): any
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns any
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21643
prependListener(event, listener): WebSocket
Fired when the websocket sends a frame.
Parameters
- event: "framesent"
- listener: ((data) => any)
  - - (data): any
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns any
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21653
prependListener(event, listener): WebSocket
Fired when the websocket has an error.
Parameters
- event: "socketerror"
- listener: ((string) => any)
  - - (string): any
    - Parameters
      
      string: string
      
      Returns any
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21663

removeListener

removeListener(event, listener): WebSocket
Removes an event listener added by on or addListener.
Parameters
- event: "close"
- listener: ((webSocket) => any)
  - - (webSocket): any
    - Parameters
      
      webSocket: WebSocket
      
      Returns any
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21578
removeListener(event, listener): WebSocket
Removes an event listener added by on or addListener.
Parameters
- event: "framereceived"
- listener: ((data) => any)
  - - (data): any
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns any
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21583
removeListener(event, listener): WebSocket
Removes an event listener added by on or addListener.
Parameters
- event: "framesent"
- listener: ((data) => any)
  - - (data): any
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns any
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21593
removeListener(event, listener): WebSocket
Removes an event listener added by on or addListener.
Parameters
- event: "socketerror"
- listener: ((string) => any)
  - - (string): any
    - Parameters
      
      string: string
      
      Returns any
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21603

url

url(): string
Contains the URL of the WebSocket.

Returns string
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21673

waitForEvent

waitForEvent(event, optionsOrPredicate?): Promise<WebSocket>
Fired when the websocket closes.
Parameters
- event: "close"
- Optional optionsOrPredicate: {
  predicate?: ((webSocket) => boolean | Promise<boolean>);
  timeout?: number;
  } | ((webSocket) => boolean | Promise<boolean>)
  Optional
Returns Promise<WebSocket>
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21678
waitForEvent(event, optionsOrPredicate?): Promise<{
payload: string | Buffer;
}>
Fired when the websocket receives a frame.
Parameters
- event: "framereceived"
- Optional optionsOrPredicate: {
  predicate?: ((data) => boolean | Promise<boolean>);
  timeout?: number;
  } | ((data) => boolean | Promise<boolean>)
  Optional
Returns Promise<{
payload: string | Buffer;
}>
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21683
waitForEvent(event, optionsOrPredicate?): Promise<{
payload: string | Buffer;
}>
Fired when the websocket sends a frame.
Parameters
- event: "framesent"
- Optional optionsOrPredicate: {
  predicate?: ((data) => boolean | Promise<boolean>);
  timeout?: number;
  } | ((data) => boolean | Promise<boolean>)
  Optional
Returns Promise<{
payload: string | Buffer;
}>
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21703
waitForEvent(event, optionsOrPredicate?): Promise<string>
Fired when the websocket has an error.
Parameters
- event: "socketerror"
- Optional optionsOrPredicate: {
  predicate?: ((string) => boolean | Promise<boolean>);
  timeout?: number;
  } | ((string) => boolean | Promise<boolean>)
  Optional
Returns Promise<string>
- Defined in node_modules/.pnpm/playwright-core@1.56.1/node_modules/playwright-core/types/types.d.ts:21723

Interface WebSocket

Hierarchy

Index

Methods

Methods

addListener

Parameters

event: "close"

listener: ((webSocket) => any)

Parameters

webSocket: WebSocket

Returns any

Returns WebSocket

Parameters

event: "framereceived"

listener: ((data) => any)

Parameters

data: { payload: string | Buffer; }

payload: string | Buffer

Returns any

Returns WebSocket

Parameters

event: "framesent"

listener: ((data) => any)

Parameters

data: { payload: string | Buffer; }

payload: string | Buffer

Returns any

Returns WebSocket

Parameters

event: "socketerror"

listener: ((string) => any)

Parameters

string: string

Returns any

Returns WebSocket

isClosed

Returns boolean

off

Parameters

event: "close"

listener: ((webSocket) => any)

Parameters

webSocket: WebSocket

Returns any

Returns WebSocket

Parameters

event: "framereceived"

listener: ((data) => any)

Parameters

data: { payload: string | Buffer; }

payload: string | Buffer

Returns any

Returns WebSocket

Parameters

event: "framesent"

listener: ((data) => any)

Parameters

data: { payload: string | Buffer; }

payload: string | Buffer

Returns any

Returns WebSocket

Parameters

event: "socketerror"

listener: ((string) => any)

Parameters

string: string

Returns any

Returns WebSocket

on

Parameters

event: "close"

listener: ((webSocket) => any)

Parameters

webSocket: WebSocket

Returns any

Returns WebSocket

Parameters

event: "framereceived"

listener: ((data) => any)

data: {
payload: string | Buffer;
}

data: {
payload: string | Buffer;
}

data: {
payload: string | Buffer;
}

data: {
payload: string | Buffer;
}

data: {
payload: string | Buffer;
}

data: {
payload: string | Buffer;
}

data: {
payload: string | Buffer;
}

data: {
payload: string | Buffer;
}

data: {
payload: string | Buffer;
}