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, listener): WebSocket
Fired when the websocket closes.
Parameters
- event: "close"
- listener: ((webSocket) => void)
  - - (webSocket): void
    - Parameters
      
      webSocket: WebSocket
      
      Returns void
Returns WebSocket
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19607
addListener(event, listener): WebSocket
Fired when the websocket receives a frame.
Parameters
- event: "framereceived"
- listener: ((data) => void)
  - - (data): void
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns void
Returns WebSocket
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19612
addListener(event, listener): WebSocket
Fired when the websocket sends a frame.
Parameters
- event: "framesent"
- listener: ((data) => void)
  - - (data): void
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns void
Returns WebSocket
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19622
addListener(event, listener): WebSocket
Fired when the websocket has an error.
Parameters
- event: "socketerror"
- listener: ((string) => void)
  - - (string): void
    - Parameters
      
      string: string
      
      Returns void
Returns WebSocket
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19632

isClosed

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

Returns boolean
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19727

off

off(event, listener): WebSocket
Removes an event listener added by on or addListener.
Parameters
- event: "close"
- listener: ((webSocket) => void)
  - - (webSocket): void
    - Parameters
      
      webSocket: WebSocket
      
      Returns void
Returns WebSocket
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19667
off(event, listener): WebSocket
Removes an event listener added by on or addListener.
Parameters
- event: "framereceived"
- listener: ((data) => void)
  - - (data): void
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns void
Returns WebSocket
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19672
off(event, listener): WebSocket
Removes an event listener added by on or addListener.
Parameters
- event: "framesent"
- listener: ((data) => void)
  - - (data): void
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns void
Returns WebSocket
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19682
off(event, listener): WebSocket
Removes an event listener added by on or addListener.
Parameters
- event: "socketerror"
- listener: ((string) => void)
  - - (string): void
    - Parameters
      
      string: string
      
      Returns void
Returns WebSocket
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19692

on

on(event, listener): WebSocket
Fired when the websocket closes.
Parameters
- event: "close"
- listener: ((webSocket) => void)
  - - (webSocket): void
    - Parameters
      
      webSocket: WebSocket
      
      Returns void
Returns WebSocket
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19547
on(event, listener): WebSocket
Fired when the websocket receives a frame.
Parameters
- event: "framereceived"
- listener: ((data) => void)
  - - (data): void
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns void
Returns WebSocket
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19552
on(event, listener): WebSocket
Fired when the websocket sends a frame.
Parameters
- event: "framesent"
- listener: ((data) => void)
  - - (data): void
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns void
Returns WebSocket
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19562
on(event, listener): WebSocket
Fired when the websocket has an error.
Parameters
- event: "socketerror"
- listener: ((string) => void)
  - - (string): void
    - Parameters
      
      string: string
      
      Returns void
Returns WebSocket
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19572

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) => void)
  - - (webSocket): void
    - Parameters
      
      webSocket: WebSocket
      
      Returns void
Returns WebSocket
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19577
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) => void)
  - - (data): void
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns void
Returns WebSocket
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19582
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) => void)
  - - (data): void
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns void
Returns WebSocket
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19592
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) => void)
  - - (string): void
    - Parameters
      
      string: string
      
      Returns void
Returns WebSocket
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19602

prependListener

prependListener(event, listener): WebSocket
Fired when the websocket closes.
Parameters
- event: "close"
- listener: ((webSocket) => void)
  - - (webSocket): void
    - Parameters
      
      webSocket: WebSocket
      
      Returns void
Returns WebSocket
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19697
prependListener(event, listener): WebSocket
Fired when the websocket receives a frame.
Parameters
- event: "framereceived"
- listener: ((data) => void)
  - - (data): void
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns void
Returns WebSocket
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19702
prependListener(event, listener): WebSocket
Fired when the websocket sends a frame.
Parameters
- event: "framesent"
- listener: ((data) => void)
  - - (data): void
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns void
Returns WebSocket
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19712
prependListener(event, listener): WebSocket
Fired when the websocket has an error.
Parameters
- event: "socketerror"
- listener: ((string) => void)
  - - (string): void
    - Parameters
      
      string: string
      
      Returns void
Returns WebSocket
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19722

removeListener

removeListener(event, listener): WebSocket
Removes an event listener added by on or addListener.
Parameters
- event: "close"
- listener: ((webSocket) => void)
  - - (webSocket): void
    - Parameters
      
      webSocket: WebSocket
      
      Returns void
Returns WebSocket
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19637
removeListener(event, listener): WebSocket
Removes an event listener added by on or addListener.
Parameters
- event: "framereceived"
- listener: ((data) => void)
  - - (data): void
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns void
Returns WebSocket
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19642
removeListener(event, listener): WebSocket
Removes an event listener added by on or addListener.
Parameters
- event: "framesent"
- listener: ((data) => void)
  - - (data): void
    - Parameters
      
      data: {
      payload: string | Buffer;
      }
      
      payload: string | Buffer
      
      frame payload
      
      Returns void
Returns WebSocket
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19652
removeListener(event, listener): WebSocket
Removes an event listener added by on or addListener.
Parameters
- event: "socketerror"
- listener: ((string) => void)
  - - (string): void
    - Parameters
      
      string: string
      
      Returns void
Returns WebSocket
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19662

url

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

Returns string
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19732

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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19737
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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19742
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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19762
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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19782

Interface WebSocket

Hierarchy

Index

Methods

Methods

addListener

Parameters

event: "close"

listener: ((webSocket) => void)

Parameters

webSocket: WebSocket

Returns void

Returns WebSocket

Parameters

event: "framereceived"

listener: ((data) => void)

Parameters

data: { payload: string | Buffer; }

payload: string | Buffer

Returns void

Returns WebSocket

Parameters

event: "framesent"

listener: ((data) => void)

Parameters

data: { payload: string | Buffer; }

payload: string | Buffer

Returns void

Returns WebSocket

Parameters

event: "socketerror"

listener: ((string) => void)

Parameters

string: string

Returns void

Returns WebSocket

isClosed

Returns boolean

off

Parameters

event: "close"

listener: ((webSocket) => void)

Parameters

webSocket: WebSocket

Returns void

Returns WebSocket

Parameters

event: "framereceived"

listener: ((data) => void)

Parameters

data: { payload: string | Buffer; }

payload: string | Buffer

Returns void

Returns WebSocket

Parameters

event: "framesent"

listener: ((data) => void)

Parameters

data: { payload: string | Buffer; }

payload: string | Buffer

Returns void

Returns WebSocket

Parameters

event: "socketerror"

listener: ((string) => void)

Parameters

string: string

Returns void

Returns WebSocket

on

Parameters

event: "close"

listener: ((webSocket) => void)

Parameters

webSocket: WebSocket

Returns void

Returns WebSocket

Parameters

event: "framereceived"

listener: ((data) => void)

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