0
Fork 0
mirror of https://github.com/TanStack/ai.git synced 2026-11-16 19:38:41 +00:00
ai/docs/reference/interfaces/WebSocketLike.md
github-actions[bot] f4f32bdcc2
docs: regenerate API documentation (#1195)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-08-22 08:16:20 +00:00

1.6 KiB

id title
WebSocketLike WebSocketLike

Interface: WebSocketLike

Defined in: packages/ai/src/stream-to-websocket.ts:15

The minimal WHATWG WebSocket surface the core needs. Cloudflare WebSocketPair server sockets, Deno's upgraded sockets, and ws (Node) sockets already satisfy it; Bun's ServerWebSocket (handler-object API) gets a ~10-line adapter at the call site.

Properties

addEventListener

addEventListener: {
  (type, handler): void;
  (type, handler): void;
};

Defined in: packages/ai/src/stream-to-websocket.ts:18

Call Signature

(type, handler): void;
Parameters
type

"message"

handler

(ev) => void

Returns

void

Call Signature

(type, handler): void;
Parameters
type

"error" | "close"

handler

() => void

Returns

void


close

close: (code?, reason?) => void;

Defined in: packages/ai/src/stream-to-websocket.ts:17

Parameters

code?

number

reason?

string

Returns

void


send

send: (data) => void;

Defined in: packages/ai/src/stream-to-websocket.ts:16

Parameters

data

string

Returns

void