Class ProxiedWebSocket

Fake WebSocket implementation that proxies through postMessage. Implements the standard WebSocket API but communicates with the VS Code extension instead of directly connecting to a server.

Hierarchy

EventTarget
- ProxiedWebSocket

Index

Constructors

constructor

new ProxiedWebSocket(
url: string | URL,
protocols?: string | string[],
): ProxiedWebSocket
Parameters
- url: string | URL
- protocols: string | string[] = []
Returns ProxiedWebSocket
Overrides EventTarget.constructor
- Defined in webview/services/serviceManager.ts:355

Properties

`Private`_disposable

_disposable: { dispose(): void }

Disposable for cleaning up message handlers

`Private`_readyState

_readyState: number

Current connection state

binaryType

binaryType: BinaryType

Binary data type for received messages

`Readonly`bufferedAmount

bufferedAmount: number = 0

Amount of buffered data waiting to be sent

`Readonly`clientId

clientId: string

Unique identifier for this WebSocket instance

`Readonly`CLOSED

CLOSED: 3

WebSocket connection is closed

`Readonly`CLOSING

CLOSING: 2

WebSocket connection is closing

`Readonly`CONNECTING

CONNECTING: 0

WebSocket is connecting

`Readonly`extensions

extensions: string = ""

Extensions in use

`Protected`listeners

listeners: Map<string, Set<(...args: unknown[]) => void>> = ...

Map of event type to listener functions

`Readonly`OPEN

OPEN: 1

WebSocket connection is open and ready

`Readonly`protocol

protocol: string

Subprotocol in use

`Readonly`url

url: string

URL of the WebSocket endpoint

`Private` `Static`_clientCounter

_clientCounter: number = 0

Counter for generating unique client IDs

`Static` `Readonly`CLOSED

CLOSED: 3

WebSocket connection is closed

`Static` `Readonly`CLOSING

CLOSING: 2

WebSocket connection is closing

`Static` `Readonly`CONNECTING

CONNECTING: 0

WebSocket is connecting

`Static` `Readonly`OPEN

OPEN: 1

WebSocket connection is open and ready

Accessors

onclose

get onclose(): (this: WebSocket, ev: CloseEvent) => unknown
Returns (this: WebSocket, ev: CloseEvent) => unknown
- Defined in webview/services/serviceManager.ts:433
set onclose(listener: (...args: unknown[]) => void): void
Parameters
- listener: (...args: unknown[]) => void
Returns void
- Defined in webview/services/serviceManager.ts:455

onerror

get onerror(): (this: WebSocket, ev: Event) => unknown
Returns (this: WebSocket, ev: Event) => unknown
- Defined in webview/services/serviceManager.ts:439
set onerror(listener: (...args: unknown[]) => void): void
Parameters
- listener: (...args: unknown[]) => void
Returns void
- Defined in webview/services/serviceManager.ts:460

onmessage

get onmessage(): (this: WebSocket, ev: MessageEvent) => unknown
Returns (this: WebSocket, ev: MessageEvent) => unknown
- Defined in webview/services/serviceManager.ts:427
set onmessage(listener: (...args: unknown[]) => void): void
Parameters
- listener: (...args: unknown[]) => void
Returns void
- Defined in webview/services/serviceManager.ts:450

onopen

get onopen(): (this: WebSocket, ev: Event) => unknown
Returns (this: WebSocket, ev: Event) => unknown
- Defined in webview/services/serviceManager.ts:421
set onopen(listener: (...args: unknown[]) => void): void
Parameters
- listener: (...args: unknown[]) => void
Returns void
- Defined in webview/services/serviceManager.ts:445

readyState

get readyState(): number
Returns number
- Defined in webview/services/serviceManager.ts:417

Methods

`Private`_onExtensionMessage

_onExtensionMessage(message: ExtensionMessage): boolean
Parameters
- message: ExtensionMessage
Returns boolean
- Defined in webview/services/serviceManager.ts:541

`Private`_open

_open(): void
Returns void
- Defined in webview/services/serviceManager.ts:627

addEventListener

addEventListener(type: string, listener: (...args: unknown[]) => void): void
Parameters
- type: string
- listener: (...args: unknown[]) => void
Returns void
Inherited from EventTarget.addEventListener
- Defined in webview/services/serviceManager.ts:288

close

close(code?: number, reason?: string): void
Parameters
- Optionalcode: number
- Optionalreason: string
Returns void
- Defined in webview/services/serviceManager.ts:465

dispatchEvent

dispatchEvent(event: Event, ...customArguments: unknown[]): boolean
Parameters
- event: Event
- ...customArguments: unknown[]
Returns boolean
Inherited from EventTarget.dispatchEvent
- Defined in webview/services/serviceManager.ts:321

removeEventListener

removeEventListener(type: string, listener: (...args: unknown[]) => void): void
Parameters
- type: string
- listener: (...args: unknown[]) => void
Returns void
Inherited from EventTarget.removeEventListener
- Defined in webview/services/serviceManager.ts:308

send

send(data: unknown): void
Parameters
- data: unknown
Returns void
- Defined in webview/services/serviceManager.ts:522

Class ProxiedWebSocket

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ProxiedWebSocket

Properties

Private_disposable

Private_readyState

binaryType

ReadonlybufferedAmount

ReadonlyclientId

ReadonlyCLOSED

ReadonlyCLOSING

ReadonlyCONNECTING

Readonlyextensions

Protectedlisteners

ReadonlyOPEN

Readonlyprotocol

Readonlyurl

Private Static_clientCounter

Static ReadonlyCLOSED

Static ReadonlyCLOSING

Static ReadonlyCONNECTING

Static ReadonlyOPEN

Accessors

onclose

Returns (this: WebSocket, ev: CloseEvent) => unknown

Parameters

Returns void

onerror

Returns (this: WebSocket, ev: Event) => unknown

Parameters

Returns void

onmessage

Returns (this: WebSocket, ev: MessageEvent) => unknown

Parameters

Returns void

onopen

Returns (this: WebSocket, ev: Event) => unknown

Parameters

Returns void

readyState

Returns number

Methods

Private_onExtensionMessage

Parameters

Returns boolean

Private_open

Returns void

addEventListener

Parameters

Returns void

close

Parameters

Returns void

dispatchEvent

Parameters

Returns boolean

removeEventListener

Parameters

Returns void

send

Parameters

Returns void

Settings

On This Page

`Private`_disposable

`Private`_readyState

`Readonly`bufferedAmount

`Readonly`clientId

`Readonly`CLOSED

`Readonly`CLOSING

`Readonly`CONNECTING

`Readonly`extensions

`Protected`listeners

`Readonly`OPEN

`Readonly`protocol

`Readonly`url

`Private` `Static`_clientCounter

`Static` `Readonly`CLOSED

`Static` `Readonly`CLOSING

`Static` `Readonly`CONNECTING

`Static` `Readonly`OPEN

`Private`_onExtensionMessage

`Private`_open