Setu-TS
    Preparing search index...

    Interface SseClientOptions<TEvents>

    Configuration for createSseClient.

    interface SseClientOptions<TEvents extends SseEventMap = SseEventMap> {
        fetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>;
        headers?: HeadersInit;
        onError?: (error: unknown) => void;
        onEvent: (
            event: SseEvent<keyof TEvents & string, TEvents[keyof TEvents]>,
        ) => void | Promise<void>;
        onStateChange?: (state: SseClientState) => void;
        parse?: (event: RawSseEvent) => TEvents[keyof TEvents];
        reconnect?: SseReconnectOptions;
        signal?: AbortSignal;
        timing?: IClientTiming;
        url: string;
    }

    Type Parameters

    Index
    fetch? headers? onError? onEvent onStateChange? parse? reconnect? signal? timing? url
    fetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>

    Injectable streaming transport. Defaults to global fetch.

    headers?: HeadersInit

    Headers cloned into every initial and reconnect request.

    onError?: (error: unknown) => void

    Receives recoverable transport or parse errors before a reconnect attempt.

    onEvent: (
        event: SseEvent<keyof TEvents & string, TEvents[keyof TEvents]>,
    ) => void | Promise<void>

    Receives every parsed data-bearing event in stream order.

    onStateChange?: (state: SseClientState) => void

    Receives each state transition.

    parse?: (event: RawSseEvent) => TEvents[keyof TEvents]

    Parses one raw SSE event. Defaults to JSON.parse and is typed against the event map so applications can refine payloads by event name.

    reconnect?: SseReconnectOptions

    Reconnect behavior after an ended or failed stream.

    signal?: AbortSignal

    External signal that closes the stream and prevents reconnects.

    timing?: IClientTiming

    Injectable clock and sleep seam. Defaults to createDefaultClientTiming().

    url: string

    Absolute SSE endpoint URL.

    Settings
    Member Visibility

    On This Page
    Properties