Interface StartSSEOptions

Options for starting or authenticating an SSE connection

interface StartSSEOptions {
    onresumptiontoken?: (token: string) => void;
    replayMessageId?: string | number;
    resumptionToken?: string;
}

Properties

onresumptiontoken?: (token: string) => void

A callback that is invoked when the resumption token changes.

This allows clients to persist the latest token for potential reconnection.

replayMessageId?: string | number

Override Message ID to associate with the replay message so that response can be associate with the new resumed request.

resumptionToken?: string

The resumption token used to continue long-running requests that were interrupted.

This allows clients to reconnect and continue from where they left off.