Interface StreamableApi<S, L>

Streamable Agent API.

interface StreamableApi<
    S extends
        SseOptions = { args: Record<string, any>; streamName: "default" },
    L extends SseListener = SseListener,
> {
    stream(
        opts: S,
        handler: SseHandler<L>,
    ): Promise<{ close: () => void; readyState: number }>;
}

Type Parameters

S extends SseOptions = { args: Record<string, any>; streamName: "default" }
L extends SseListener = SseListener

Implemented by

OcelloidsAgentApi

Index

Methods

Methods

stream

stream(
opts: S,
handler: SseHandler<L>,
): Promise<{ close: () => void; readyState: number }>
Parameters
- opts: S
- handler: SseHandler<L>
Returns Promise<{ close: () => void; readyState: number }>
- Defined in client/src/client.ts:113