StreamConfig

Defined in: packages/core/src/data/streaming/stream-manager.ts:21

Configuration for a streaming connection.

Example

const config: StreamConfig = {
  type: 'sse',
  url: 'https://api.example.com/events',
  onData: (data) => console.log('Received:', data),
  reconnect: { enabled: true, maxRetries: 10 }
};

Properties

Property	Type	Description	Defined in
eventTypes?	string[]	Event types to listen for (SSE only)	packages/core/src/data/streaming/stream-manager.ts:46
onData	(data) => void	Callback for incoming data	packages/core/src/data/streaming/stream-manager.ts:29
onError?	(error) => void	Callback for errors	packages/core/src/data/streaming/stream-manager.ts:35
onStateChange?	(state) => void	Callback for connection state changes	packages/core/src/data/streaming/stream-manager.ts:32
protocols?	string | string[]	WebSocket protocols (WebSocket only)	packages/core/src/data/streaming/stream-manager.ts:49
reconnect?	object	Reconnection configuration	packages/core/src/data/streaming/stream-manager.ts:38
reconnect.enabled?	boolean	-	packages/core/src/data/streaming/stream-manager.ts:39
reconnect.initialDelay?	number	-	packages/core/src/data/streaming/stream-manager.ts:41
reconnect.maxDelay?	number	-	packages/core/src/data/streaming/stream-manager.ts:42
reconnect.maxRetries?	number	-	packages/core/src/data/streaming/stream-manager.ts:40
type	"websocket" | "sse"	Type of streaming connection	packages/core/src/data/streaming/stream-manager.ts:23
url	string	URL for the streaming connection	packages/core/src/data/streaming/stream-manager.ts:26