Primitives / foldkit-primitives/net

SocketHandle

interface · packages/primitives/src/net/websocket.ts:11

interface SocketHandle {
  readonly readyState: number
  send(data: string): void
  close(): void
  onopen: ((event: any) => void) | null
  onmessage: ((event: any) => void) | null
  onclose: ((event: any) => void) | null
  onerror: ((event: any) => void) | null
}

The slice of a WebSocket the bundle needs; satisfied by the platform socket and test doubles. Handler events are any: the DOM and ws type them differently, and only data is read.

Members

SocketHandle.readyState

property · packages/primitives/src/net/websocket.ts:12

readonly readyState: number

SocketHandle.send

method · packages/primitives/src/net/websocket.ts:13

send(data: string): void

SocketHandle.close

method · packages/primitives/src/net/websocket.ts:14

close(): void

SocketHandle.onopen

property · packages/primitives/src/net/websocket.ts:15

onopen: ((event: any) => void) | null

SocketHandle.onmessage

property · packages/primitives/src/net/websocket.ts:16

onmessage: ((event: any) => void) | null

SocketHandle.onclose

property · packages/primitives/src/net/websocket.ts:17

onclose: ((event: any) => void) | null

SocketHandle.onerror

property · packages/primitives/src/net/websocket.ts:18

onerror: ((event: any) => void) | null