effect-playwright
    Preparing search index...

    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.

    interface WebSocket {
        addListener(
            event: "close",
            listener: (webSocket: WebSocket) => any,
        ): this;
        addListener(
            event: "framereceived",
            listener: (data: { payload: string | Buffer<ArrayBufferLike> }) => any,
        ): this;
        addListener(
            event: "framesent",
            listener: (data: { payload: string | Buffer<ArrayBufferLike> }) => any,
        ): this;
        addListener(event: "socketerror", listener: (string: string) => any): this;
        isClosed(): boolean;
        off(event: "close", listener: (webSocket: WebSocket) => any): this;
        off(
            event: "framereceived",
            listener: (data: { payload: string | Buffer<ArrayBufferLike> }) => any,
        ): this;
        off(
            event: "framesent",
            listener: (data: { payload: string | Buffer<ArrayBufferLike> }) => any,
        ): this;
        off(event: "socketerror", listener: (string: string) => any): this;
        on(event: "close", listener: (webSocket: WebSocket) => any): this;
        on(
            event: "framereceived",
            listener: (data: { payload: string | Buffer<ArrayBufferLike> }) => any,
        ): this;
        on(
            event: "framesent",
            listener: (data: { payload: string | Buffer<ArrayBufferLike> }) => any,
        ): this;
        on(event: "socketerror", listener: (string: string) => any): this;
        once(event: "close", listener: (webSocket: WebSocket) => any): this;
        once(
            event: "framereceived",
            listener: (data: { payload: string | Buffer<ArrayBufferLike> }) => any,
        ): this;
        once(
            event: "framesent",
            listener: (data: { payload: string | Buffer<ArrayBufferLike> }) => any,
        ): this;
        once(event: "socketerror", listener: (string: string) => any): this;
        prependListener(
            event: "close",
            listener: (webSocket: WebSocket) => any,
        ): this;
        prependListener(
            event: "framereceived",
            listener: (data: { payload: string | Buffer<ArrayBufferLike> }) => any,
        ): this;
        prependListener(
            event: "framesent",
            listener: (data: { payload: string | Buffer<ArrayBufferLike> }) => any,
        ): this;
        prependListener(
            event: "socketerror",
            listener: (string: string) => any,
        ): this;
        removeListener(
            event: "close",
            listener: (webSocket: WebSocket) => any,
        ): this;
        removeListener(
            event: "framereceived",
            listener: (data: { payload: string | Buffer<ArrayBufferLike> }) => any,
        ): this;
        removeListener(
            event: "framesent",
            listener: (data: { payload: string | Buffer<ArrayBufferLike> }) => any,
        ): this;
        removeListener(
            event: "socketerror",
            listener: (string: string) => any,
        ): this;
        url(): string;
        waitForEvent(
            event: "close",
            optionsOrPredicate?:
                | {
                    predicate?: (webSocket: WebSocket) => boolean | Promise<boolean>;
                    signal?: AbortSignal;
                    timeout?: number;
                }
                | ((webSocket: WebSocket) => boolean | Promise<boolean>),
        ): Promise<WebSocket>;
        waitForEvent(
            event: "framereceived",
            optionsOrPredicate?:
                | {
                    predicate?: (
                        data: { payload: string | Buffer<ArrayBufferLike> },
                    ) => boolean | Promise<boolean>;
                    signal?: AbortSignal;
                    timeout?: number;
                }
                | (
                    (
                        data: { payload: string | Buffer<ArrayBufferLike> },
                    ) => boolean | Promise<boolean>
                ),
        ): Promise<{ payload: string | Buffer<ArrayBufferLike> }>;
        waitForEvent(
            event: "framesent",
            optionsOrPredicate?:
                | {
                    predicate?: (
                        data: { payload: string | Buffer<ArrayBufferLike> },
                    ) => boolean | Promise<boolean>;
                    signal?: AbortSignal;
                    timeout?: number;
                }
                | (
                    (
                        data: { payload: string | Buffer<ArrayBufferLike> },
                    ) => boolean | Promise<boolean>
                ),
        ): Promise<{ payload: string | Buffer<ArrayBufferLike> }>;
        waitForEvent(
            event: "socketerror",
            optionsOrPredicate?:
                | {
                    predicate?: (string: string) => boolean | Promise<boolean>;
                    signal?: AbortSignal;
                    timeout?: number;
                }
                | ((string: string) => boolean | Promise<boolean>),
        ): Promise<string>;
    }
    Index
    addListener isClosed off on once prependListener removeListener url waitForEvent

    • Fired when the websocket closes.

      Parameters

      • event: "close"
      • listener: (webSocket: WebSocket) => any

      Returns this

    • Fired when the websocket receives a frame.

      Parameters

      • event: "framereceived"
      • listener: (data: { payload: string | Buffer<ArrayBufferLike> }) => any

      Returns this

    • Fired when the websocket sends a frame.

      Parameters

      • event: "framesent"
      • listener: (data: { payload: string | Buffer<ArrayBufferLike> }) => any

      Returns this

    • Fired when the websocket has an error.

      Parameters

      • event: "socketerror"
      • listener: (string: string) => any

      Returns this

    • Indicates that the web socket has been closed.

      Returns boolean

    • Removes an event listener added by on or addListener.

      Parameters

      • event: "close"
      • listener: (webSocket: WebSocket) => any

      Returns this

    • Removes an event listener added by on or addListener.

      Parameters

      • event: "framereceived"
      • listener: (data: { payload: string | Buffer<ArrayBufferLike> }) => any

      Returns this

    • Removes an event listener added by on or addListener.

      Parameters

      • event: "framesent"
      • listener: (data: { payload: string | Buffer<ArrayBufferLike> }) => any

      Returns this

    • Removes an event listener added by on or addListener.

      Parameters

      • event: "socketerror"
      • listener: (string: string) => any

      Returns this

    • Fired when the websocket closes.

      Parameters

      • event: "close"
      • listener: (webSocket: WebSocket) => any

      Returns this

    • Fired when the websocket receives a frame.

      Parameters

      • event: "framereceived"
      • listener: (data: { payload: string | Buffer<ArrayBufferLike> }) => any

      Returns this

    • Fired when the websocket sends a frame.

      Parameters

      • event: "framesent"
      • listener: (data: { payload: string | Buffer<ArrayBufferLike> }) => any

      Returns this

    • Fired when the websocket has an error.

      Parameters

      • event: "socketerror"
      • listener: (string: string) => any

      Returns this

    • 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: WebSocket) => any

      Returns this

    • 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: { payload: string | Buffer<ArrayBufferLike> }) => any

      Returns this

    • 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: { payload: string | Buffer<ArrayBufferLike> }) => any

      Returns this

    • 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: string) => any

      Returns this

    • Fired when the websocket closes.

      Parameters

      • event: "close"
      • listener: (webSocket: WebSocket) => any

      Returns this

    • Fired when the websocket receives a frame.

      Parameters

      • event: "framereceived"
      • listener: (data: { payload: string | Buffer<ArrayBufferLike> }) => any

      Returns this

    • Fired when the websocket sends a frame.

      Parameters

      • event: "framesent"
      • listener: (data: { payload: string | Buffer<ArrayBufferLike> }) => any

      Returns this

    • Fired when the websocket has an error.

      Parameters

      • event: "socketerror"
      • listener: (string: string) => any

      Returns this

    • Removes an event listener added by on or addListener.

      Parameters

      • event: "close"
      • listener: (webSocket: WebSocket) => any

      Returns this

    • Removes an event listener added by on or addListener.

      Parameters

      • event: "framereceived"
      • listener: (data: { payload: string | Buffer<ArrayBufferLike> }) => any

      Returns this

    • Removes an event listener added by on or addListener.

      Parameters

      • event: "framesent"
      • listener: (data: { payload: string | Buffer<ArrayBufferLike> }) => any

      Returns this

    • Removes an event listener added by on or addListener.

      Parameters

      • event: "socketerror"
      • listener: (string: string) => any

      Returns this

    • Contains the URL of the WebSocket.

      Returns string

    • Fired when the websocket closes.

      Parameters

      • event: "close"
      • OptionaloptionsOrPredicate:
            | {
                predicate?: (webSocket: WebSocket) => boolean | Promise<boolean>;
                signal?: AbortSignal;
                timeout?: number;
            }
            | ((webSocket: WebSocket) => boolean | Promise<boolean>)

      Returns Promise<WebSocket>

    • Fired when the websocket receives a frame.

      Parameters

      • event: "framereceived"
      • OptionaloptionsOrPredicate:
            | {
                predicate?: (
                    data: { payload: string | Buffer<ArrayBufferLike> },
                ) => boolean | Promise<boolean>;
                signal?: AbortSignal;
                timeout?: number;
            }
            | (
                (
                    data: { payload: string | Buffer<ArrayBufferLike> },
                ) => boolean | Promise<boolean>
            )

      Returns Promise<{ payload: string | Buffer<ArrayBufferLike> }>

    • Fired when the websocket sends a frame.

      Parameters

      • event: "framesent"
      • OptionaloptionsOrPredicate:
            | {
                predicate?: (
                    data: { payload: string | Buffer<ArrayBufferLike> },
                ) => boolean | Promise<boolean>;
                signal?: AbortSignal;
                timeout?: number;
            }
            | (
                (
                    data: { payload: string | Buffer<ArrayBufferLike> },
                ) => boolean | Promise<boolean>
            )

      Returns Promise<{ payload: string | Buffer<ArrayBufferLike> }>

    • Fired when the websocket has an error.

      Parameters

      • event: "socketerror"
      • OptionaloptionsOrPredicate:
            | {
                predicate?: (string: string) => boolean | Promise<boolean>;
                signal?: AbortSignal;
                timeout?: number;
            }
            | ((string: string) => boolean | Promise<boolean>)

      Returns Promise<string>

    Settings
    Member Visibility

    On This Page
    Methods