WebSocketPeer
Defined in: packages/net-websocket/src/peer/websocket-peer.ts:100
One end of a WebSocket connection, over any Transport: after an
HTTP/1.1 Upgrade, or — the same way — over an HTTP/2 or HTTP/3 stream.
Messages are sent as single frames and received whole: fragments are
reassembled, up to maxMessageSize, and text is checked to be UTF-8. Pings
are answered automatically. Every protocol violation fails the connection
with the close code RFC 6455 assigns to it.
Closing follows §7: close sends a close frame and waits for the
peer’s, a close frame received is echoed, and the server end closes the
transport first. Either way close is emitted once.
acceptWebSocket and connectWebSocket for the opening handshake.
Extends
Section titled “Extends”EventDispatcherMapBase<WebSocketPeerEvents>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new WebSocketPeer(
options):WebSocketPeer
Defined in: packages/net-websocket/src/peer/websocket-peer.ts:116
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”WebSocketPeer
Overrides
Section titled “Overrides”EventDispatcherMapBase<WebSocketPeerEvents>.constructor
Properties
Section titled “Properties”protocol
Section titled “protocol”
readonlyprotocol:string|null
Defined in: packages/net-websocket/src/peer/websocket-peer.ts:102
The subprotocol the handshake settled on, or null.
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get state():
WebSocketState
Defined in: packages/net-websocket/src/peer/websocket-peer.ts:136
Returns
Section titled “Returns”Methods
Section titled “Methods”[asyncDispose]()
Section titled “[asyncDispose]()”[asyncDispose]():
Promise<void>
Defined in: packages/net-websocket/src/peer/websocket-peer.ts:203
Closes the peer, so it can be used with await using.
Returns
Section titled “Returns”Promise<void>
close()
Section titled “close()”close(
code?,reason?):Promise<void>
Defined in: packages/net-websocket/src/peer/websocket-peer.ts:183
Start the closing handshake and wait for it to complete, or for
closeTimeoutMs to pass, whichever comes first.
Parameters
Section titled “Parameters”number = 1000
A sendable close code; defaults to 1000.
reason?
Section titled “reason?”string = ""
At most 123 UTF-8 bytes.
Returns
Section titled “Returns”Promise<void>
Throws
Section titled “Throws”When code may not be sent or reason is too long.
destroy()
Section titled “destroy()”destroy(
error?):void
Defined in: packages/net-websocket/src/peer/websocket-peer.ts:197
Drop the connection without a closing handshake.
Parameters
Section titled “Parameters”error?
Section titled “error?”unknown
Returns
Section titled “Returns”void
isSubscribed()
Section titled “isSubscribed()”isSubscribed<
K>(event,listener):boolean
Defined in: packages/async/src/events/event-dispatcher-map-base.ts:38
Check if a callback is subscribed to a specific event.
Type Parameters
Section titled “Type Parameters”K extends keyof WebSocketPeerEvents
Parameters
Section titled “Parameters”K
The event name.
listener
Section titled “listener”Callable<WebSocketPeerEvents[K]>
The callback to check.
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”EventDispatcherMapBase.isSubscribed
ping()
Section titled “ping()”ping(
payload?,signal?):Promise<void>
Defined in: packages/net-websocket/src/peer/websocket-peer.ts:165
Send a ping. The peer answers with a pong carrying the same payload.
Parameters
Section titled “Parameters”payload?
Section titled “payload?”Uint8Array = ...
At most 125 bytes.
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<void>
Throws
Section titled “Throws”When the peer is closing or closed.
Throws
Section titled “Throws”When payload exceeds 125 bytes.
send()
Section titled “send()”send(
data,signal?):Promise<void>
Defined in: packages/net-websocket/src/peer/websocket-peer.ts:146
Send one message, as a single frame: a string as text, bytes as binary.
Parameters
Section titled “Parameters”string | Uint8Array<ArrayBufferLike>
signal?
Section titled “signal?”AbortSignal
Cancels the wait for transport capacity.
Returns
Section titled “Returns”Promise<void>
Throws
Section titled “Throws”When the peer is closing or closed.
subscribe()
Section titled “subscribe()”subscribe<
K>(event,listener,options?):Callable|null
Defined in: packages/async/src/events/event-dispatcher-map-base.ts:23
Type Parameters
Section titled “Type Parameters”K extends keyof WebSocketPeerEvents
Parameters
Section titled “Parameters”K
listener
Section titled “listener”Callable<WebSocketPeerEvents[K]>
options?
Section titled “options?”EventDispatcherSubscribeOptions
Returns
Section titled “Returns”Callable | null
Inherited from
Section titled “Inherited from”EventDispatcherMapBase.subscribe
unsubscribe()
Section titled “unsubscribe()”unsubscribe<
K>(event,listener):void
Defined in: packages/async/src/events/event-dispatcher-map-base.ts:31
Unsubscribe a callback from a specific event.
Type Parameters
Section titled “Type Parameters”K extends keyof WebSocketPeerEvents
Parameters
Section titled “Parameters”K
The event name.
listener
Section titled “listener”Callable<WebSocketPeerEvents[K]>
The callback to remove.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”EventDispatcherMapBase.unsubscribe
wait()
Section titled “wait()”wait<
K>(event,options?):Promise<WebSocketPeerEvents[K]>
Defined in: packages/async/src/events/event-dispatcher-map-base.ts:45
Wait for the next occurrence of a specific event, optionally matching a predicate.
This is a convenience method that subscribes to the dispatcher, waits for the next event that matches the predicate (if provided), and then unsubscribes automatically.
Type Parameters
Section titled “Type Parameters”K extends keyof WebSocketPeerEvents
Parameters
Section titled “Parameters”K
The event name to wait for.
options?
Section titled “options?”EventDispatcherWaitOptions<WebSocketPeerEvents[K]>
Optional settings including predicate and abort signal.
Returns
Section titled “Returns”Promise<WebSocketPeerEvents[K]>
A promise that resolves with the event arguments as an array.
Inherited from
Section titled “Inherited from”EventDispatcherMapBase.wait