Interface WebSocket

The [WebSocket] class represents websocket connections in the page.

Hierarchy

WebSocket

Index

Methods

addListener isClosed off on once prependListener removeListener url waitForEvent

Methods

addListener

addListener(event: "close", listener: ((webSocket: WebSocket) => void)): WebSocket
Fired when the websocket closes.
Parameters
- event: "close"
- listener: ((webSocket: WebSocket) => void)
  - - (webSocket: WebSocket): void
    - Parameters
      
      webSocket: WebSocket
      
      Returns void
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:17706
addListener(event: "framereceived", listener: ((data: {
payload: string | Buffer;
}) => void)): WebSocket
Fired when the websocket receives a frame.
Parameters
- event: "framereceived"
- listener: ((data: {
  payload: string | Buffer;
  }) => void)
  - - (data: {
      payload: string | Buffer;
      }): void
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns void
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:17711
addListener(event: "framesent", listener: ((data: {
payload: string | Buffer;
}) => void)): WebSocket
Fired when the websocket sends a frame.
Parameters
- event: "framesent"
- listener: ((data: {
  payload: string | Buffer;
  }) => void)
  - - (data: {
      payload: string | Buffer;
      }): void
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns void
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:17721
addListener(event: "socketerror", listener: ((string: String) => void)): WebSocket
Fired when the websocket has an error.
Parameters
- event: "socketerror"
- listener: ((string: String) => void)
  - - (string: String): void
    - Parameters
      
      string: String
      
      Returns void
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:17731

isClosed

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

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

off

off(event: "close", listener: ((webSocket: WebSocket) => void)): WebSocket
Removes an event listener added by on or addListener.
Parameters
- event: "close"
- listener: ((webSocket: WebSocket) => void)
  - - (webSocket: WebSocket): void
    - Parameters
      
      webSocket: WebSocket
      
      Returns void
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:17766
off(event: "framereceived", listener: ((data: {
payload: string | Buffer;
}) => void)): WebSocket
Removes an event listener added by on or addListener.
Parameters
- event: "framereceived"
- listener: ((data: {
  payload: string | Buffer;
  }) => void)
  - - (data: {
      payload: string | Buffer;
      }): void
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns void
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:17771
off(event: "framesent", listener: ((data: {
payload: string | Buffer;
}) => void)): WebSocket
Removes an event listener added by on or addListener.
Parameters
- event: "framesent"
- listener: ((data: {
  payload: string | Buffer;
  }) => void)
  - - (data: {
      payload: string | Buffer;
      }): void
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns void
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:17781
off(event: "socketerror", listener: ((string: String) => void)): WebSocket
Removes an event listener added by on or addListener.
Parameters
- event: "socketerror"
- listener: ((string: String) => void)
  - - (string: String): void
    - Parameters
      
      string: String
      
      Returns void
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:17791

on

on(event: "close", listener: ((webSocket: WebSocket) => void)): WebSocket
Fired when the websocket closes.
Parameters
- event: "close"
- listener: ((webSocket: WebSocket) => void)
  - - (webSocket: WebSocket): void
    - Parameters
      
      webSocket: WebSocket
      
      Returns void
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:17646
on(event: "framereceived", listener: ((data: {
payload: string | Buffer;
}) => void)): WebSocket
Fired when the websocket receives a frame.
Parameters
- event: "framereceived"
- listener: ((data: {
  payload: string | Buffer;
  }) => void)
  - - (data: {
      payload: string | Buffer;
      }): void
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns void
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:17651
on(event: "framesent", listener: ((data: {
payload: string | Buffer;
}) => void)): WebSocket
Fired when the websocket sends a frame.
Parameters
- event: "framesent"
- listener: ((data: {
  payload: string | Buffer;
  }) => void)
  - - (data: {
      payload: string | Buffer;
      }): void
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns void
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:17661
on(event: "socketerror", listener: ((string: String) => void)): WebSocket
Fired when the websocket has an error.
Parameters
- event: "socketerror"
- listener: ((string: String) => void)
  - - (string: String): void
    - Parameters
      
      string: String
      
      Returns void
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:17671

once

once(event: "close", listener: ((webSocket: WebSocket) => void)): 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: WebSocket) => void)
  - - (webSocket: WebSocket): void
    - Parameters
      
      webSocket: WebSocket
      
      Returns void
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:17676
once(event: "framereceived", listener: ((data: {
payload: string | Buffer;
}) => void)): 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: {
  payload: string | Buffer;
  }) => void)
  - - (data: {
      payload: string | Buffer;
      }): void
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns void
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:17681
once(event: "framesent", listener: ((data: {
payload: string | Buffer;
}) => void)): 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: {
  payload: string | Buffer;
  }) => void)
  - - (data: {
      payload: string | Buffer;
      }): void
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns void
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:17691
once(event: "socketerror", listener: ((string: String) => void)): 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: String) => void)
  - - (string: String): void
    - Parameters
      
      string: String
      
      Returns void
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:17701

prependListener

prependListener(event: "close", listener: ((webSocket: WebSocket) => void)): WebSocket
Fired when the websocket closes.
Parameters
- event: "close"
- listener: ((webSocket: WebSocket) => void)
  - - (webSocket: WebSocket): void
    - Parameters
      
      webSocket: WebSocket
      
      Returns void
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:17796
prependListener(event: "framereceived", listener: ((data: {
payload: string | Buffer;
}) => void)): WebSocket
Fired when the websocket receives a frame.
Parameters
- event: "framereceived"
- listener: ((data: {
  payload: string | Buffer;
  }) => void)
  - - (data: {
      payload: string | Buffer;
      }): void
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns void
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:17801
prependListener(event: "framesent", listener: ((data: {
payload: string | Buffer;
}) => void)): WebSocket
Fired when the websocket sends a frame.
Parameters
- event: "framesent"
- listener: ((data: {
  payload: string | Buffer;
  }) => void)
  - - (data: {
      payload: string | Buffer;
      }): void
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns void
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:17811
prependListener(event: "socketerror", listener: ((string: String) => void)): WebSocket
Fired when the websocket has an error.
Parameters
- event: "socketerror"
- listener: ((string: String) => void)
  - - (string: String): void
    - Parameters
      
      string: String
      
      Returns void
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:17821

removeListener

removeListener(event: "close", listener: ((webSocket: WebSocket) => void)): WebSocket
Removes an event listener added by on or addListener.
Parameters
- event: "close"
- listener: ((webSocket: WebSocket) => void)
  - - (webSocket: WebSocket): void
    - Parameters
      
      webSocket: WebSocket
      
      Returns void
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:17736
removeListener(event: "framereceived", listener: ((data: {
payload: string | Buffer;
}) => void)): WebSocket
Removes an event listener added by on or addListener.
Parameters
- event: "framereceived"
- listener: ((data: {
  payload: string | Buffer;
  }) => void)
  - - (data: {
      payload: string | Buffer;
      }): void
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns void
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:17741
removeListener(event: "framesent", listener: ((data: {
payload: string | Buffer;
}) => void)): WebSocket
Removes an event listener added by on or addListener.
Parameters
- event: "framesent"
- listener: ((data: {
  payload: string | Buffer;
  }) => void)
  - - (data: {
      payload: string | Buffer;
      }): void
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns void
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:17751
removeListener(event: "socketerror", listener: ((string: String) => void)): WebSocket
Removes an event listener added by on or addListener.
Parameters
- event: "socketerror"
- listener: ((string: String) => void)
  - - (string: String): void
    - Parameters
      
      string: String
      
      Returns void
Returns WebSocket
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:17761

url

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

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

waitForEvent

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

Interface WebSocket

Hierarchy

Index

Methods

Methods

addListener

Parameters

event: "close"

listener: ((webSocket: WebSocket) => void)

Parameters

webSocket: WebSocket

Returns void

Returns WebSocket

Parameters

event: "framereceived"

listener: ((data: { payload: string | Buffer; }) => void)

Parameters

data: { payload: string | Buffer; }

payload: string | Buffer

Returns void

Returns WebSocket

Parameters

event: "framesent"

listener: ((data: { payload: string | Buffer; }) => void)

Parameters

data: { payload: string | Buffer; }

payload: string | Buffer

Returns void

Returns WebSocket

Parameters

event: "socketerror"

listener: ((string: String) => void)

Parameters

string: String

Returns void

Returns WebSocket

isClosed

Returns boolean

off

Parameters

event: "close"

listener: ((webSocket: WebSocket) => void)

Parameters

webSocket: WebSocket

Returns void

Returns WebSocket

Parameters

event: "framereceived"

listener: ((data: { payload: string | Buffer; }) => void)

Parameters

data: { payload: string | Buffer; }

payload: string | Buffer

Returns void

Returns WebSocket

Parameters

event: "framesent"

listener: ((data: { payload: string | Buffer; }) => void)

Parameters

data: { payload: string | Buffer; }

payload: string | Buffer

Returns void

Returns WebSocket

Parameters

event: "socketerror"

listener: ((string: String) => void)

Parameters

string: String

Returns void

Returns WebSocket

on

Parameters

event: "close"

listener: ((webSocket: WebSocket) => void)

Parameters

webSocket: WebSocket

Returns void

Returns WebSocket

Parameters

event: "framereceived"

listener: ((data: { payload: string | Buffer; }) => void)

listener: ((data: {
payload: string | Buffer;
}) => void)

data: {
payload: string | Buffer;
}

listener: ((data: {
payload: string | Buffer;
}) => void)

data: {
payload: string | Buffer;
}

listener: ((data: {
payload: string | Buffer;
}) => void)

data: {
payload: string | Buffer;
}

listener: ((data: {
payload: string | Buffer;
}) => void)

data: {
payload: string | Buffer;
}

listener: ((data: {
payload: string | Buffer;
}) => void)

data: {
payload: string | Buffer;
}

listener: ((data: {
payload: string | Buffer;
}) => void)

data: {
payload: string | Buffer;
}

listener: ((data: {
payload: string | Buffer;
}) => void)

data: {
payload: string | Buffer;
}

listener: ((data: {
payload: string | Buffer;
}) => void)

data: {
payload: string | Buffer;
}

listener: ((data: {
payload: string | Buffer;
}) => void)

data: {
payload: string | Buffer;
}

listener: ((data: {
payload: string | Buffer;
}) => void)