title: Client. Stream Options

A2A Node SDK - v0.1.0 / Modules / Client / StreamOptions

Interface: StreamOptions

Client.StreamOptions

Options for streaming operations

This interface defines callbacks and configuration for streaming connections, including handling messages, errors, and connection lifecycle.

Example

const streamOptions: StreamOptions = {
  onMessage: (data) => console.log('Received:', data),
  onError: (error) => console.error('Stream error:', error),
  onComplete: () => console.log('Stream completed'),
  heartbeatInterval: 30000,  // 30 seconds
  heartbeatTimeout: 10000     // 10 seconds
};

Table of contents

Properties

• heartbeatInterval
• heartbeatTimeout
• onComplete
• onError
• onMessage

Properties

heartbeatInterval

• Optional heartbeatInterval: number

Interval in milliseconds between heartbeat messages (default: 30000)

heartbeatTimeout

• Optional heartbeatTimeout: number

Timeout in milliseconds to wait for heartbeat response (default: 10000)

onComplete

• Optional onComplete: () => void

Optional callback function when stream completes

Type declaration

▸ (): void

Returns

void

onError

• Optional onError: (error: Error) => void

Optional callback function for stream errors

Type declaration

▸ (error): void

Parameters

Returns

void

onMessage

• onMessage: (data: JsonRpcStreamResponse) => void

Callback function for received messages

Type declaration

▸ (data): void

Parameters

Returns

void