class: WebSocket

• since: v1.8

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].

event: WebSocket.close

• since: v1.8

• argument: <[WebSocket]>

Fired when the websocket closes.

event: WebSocket.frameReceived

• since: v1.9

• argument: <[Object]>
  • payload <[string]|[Buffer]> frame payload

Fired when the websocket receives a frame.

event: WebSocket.frameReceived

• since: v1.9
• langs: python

• argument: <[string]|[Buffer]> frame payload

event: WebSocket.frameReceived

• since: v1.9
• langs: csharp, java

• argument: <[WebSocketFrame]>

event: WebSocket.frameSent

• since: v1.9

• argument: <[Object]>
  • payload <[string]|[Buffer]> frame payload

Fired when the websocket sends a frame.

event: WebSocket.frameSent

• since: v1.9
• langs: python

• argument: <[string]|[Buffer]> frame payload

event: WebSocket.frameSent

• since: v1.9
• langs: csharp, java

• argument: <[WebSocketFrame]>

event: WebSocket.socketError

• since: v1.9

• argument: <[string]>

Fired when the websocket has an error.

method: WebSocket.isClosed

• since: v1.8

• returns: <[boolean]>

Indicates that the web socket has been closed.

method: WebSocket.url

• since: v1.8

• returns: <[string]>

Contains the URL of the WebSocket.

async method: WebSocket.waitForEvent

• since: v1.8
• langs: js, python
  • alias-python: expect_event

• returns: <[any]>

Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy value. Will throw an error if the webSocket is closed before the event is fired. Returns the event data value.

async method: WebSocket.waitForEvent

• since: v1.8
• langs: python

• returns: <[EventContextManager]>

Usage

async with ws.expect_event("framereceived") as event_info:
    await page.get_by_text("Send message").click()

payload = await event_info.value
print(payload)

with ws.expect_event("framereceived") as event_info:
    page.get_by_text("Send message").click()

payload = event_info.value
print(payload)

param: WebSocket.waitForEvent.event

• since: v1.8

• event <[string]>

Event name, same one would pass into webSocket.on(event).

param: WebSocket.waitForEvent.optionsOrPredicate

• since: v1.8
• langs: js

• optionsOrPredicate ?<[function]|[Object]>
  • predicate <[function]> Receives the event data and resolves to truthy value when the waiting should resolve.
  • timeout ?<[float]> Maximum time to wait for in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the [method: BrowserContext.setDefaultTimeout] or [method: Page.setDefaultTimeout] methods.

Either a predicate that receives an event or an options object. Optional.

option: WebSocket.waitForEvent.predicate = %%-wait-for-event-predicate-%%

• since: v1.8

option: WebSocket.waitForEvent.timeout = %%-wait-for-event-timeout-%%

• since: v1.8

option: WebSocket.waitForEvent.signal = %%-wait-for-event-signal-%%

async method: WebSocket.waitForFrameReceived

• since: v1.10
• langs: java

• returns: <[WebSocketFrame]>

Performs action and waits for a frame to be sent. If predicate is provided, it passes [WebSocketFrame] value into the predicate function and waits for predicate(webSocketFrame) to return a truthy value. Will throw an error if the WebSocket or Page is closed before the frame is received.

option: WebSocket.waitForFrameReceived.predicate

• since: v1.9

• predicate <[function]([WebSocketFrame]):[boolean]>

Receives the [WebSocketFrame] object and resolves to truthy value when the waiting should resolve.

option: WebSocket.waitForFrameReceived.timeout = %%-wait-for-event-timeout-%%

• since: v1.9

option: WebSocket.waitForFrameReceived.signal = %%-wait-for-event-signal-%%

param: WebSocket.waitForFrameReceived.callback = %%-java-wait-for-event-callback-%%

• since: v1.9

async method: WebSocket.waitForFrameSent

• since: v1.10
• langs: java

• returns: <[WebSocketFrame]>

Performs action and waits for a frame to be sent. If predicate is provided, it passes [WebSocketFrame] value into the predicate function and waits for predicate(webSocketFrame) to return a truthy value. Will throw an error if the WebSocket or Page is closed before the frame is sent.

option: WebSocket.waitForFrameSent.predicate

• since: v1.9

• predicate <[function]([WebSocketFrame]):[boolean]>

Receives the [WebSocketFrame] object and resolves to truthy value when the waiting should resolve.

option: WebSocket.waitForFrameSent.timeout = %%-wait-for-event-timeout-%%

• since: v1.9

option: WebSocket.waitForFrameSent.signal = %%-wait-for-event-signal-%%

param: WebSocket.waitForFrameSent.callback = %%-java-wait-for-event-callback-%%

• since: v1.9

async method: WebSocket.waitForEvent2

• since: v1.8
• langs: python
  • alias-python: wait_for_event

• returns: <[any]>

:::note In most cases, you should use [method: WebSocket.waitForEvent]. :::

Waits for given event to fire. If predicate is provided, it passes event's value into the predicate function and waits for predicate(event) to return a truthy value. Will throw an error if the socket is closed before the event is fired.

param: WebSocket.waitForEvent2.event = %%-wait-for-event-event-%%

• since: v1.8

option: WebSocket.waitForEvent2.predicate = %%-wait-for-event-predicate-%%

• since: v1.8

option: WebSocket.waitForEvent2.timeout = %%-wait-for-event-timeout-%%

• since: v1.8

option: WebSocket.waitForEvent2.signal = %%-wait-for-event-signal-%%

Source: docs/src/api/class-websocket.md