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) => any)
  - - (webSocket): any
    - Parameters
      
      webSocket: WebSocket
      
      Returns any
Returns WebSocket
- Defined in packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19761
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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19766
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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19776
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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19786

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:19881

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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19821
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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19826
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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19836
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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19846

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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19701
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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19706
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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19716
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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19726

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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19731
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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19736
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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19746
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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19756

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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19851
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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19856
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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19866
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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19876

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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19791
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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19796
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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19806
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 packages/@biorate/playwright/node_modules/playwright-core/types/types.d.ts:19816

url

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

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

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:19891
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:19896
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:19916
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:19936

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