Interface SSEConfig

SSE configuration

interface SSEConfig {
    data?: unknown;
    headers?: Record<string, string>;
    onClose?: (() => void);
    onError?: ((error) => void);
    onMessage?: ((event) => void);
    onOpen?: (() => void);
    sse: true;
}

Hierarchy (view full)

Properties

data?: unknown

Request body for POST SSE

headers?: Record<string, string>

Custom headers for SSE request

onClose?: (() => void)

Called when the connection is closed

Type declaration

    • (): void
    • Returns void

onError?: ((error) => void)

Called when an error occurs

Type declaration

    • (error): void
    • Parameters

      • error: unknown

      Returns void

onMessage?: ((event) => void)

Called when a message is received

Type declaration

onOpen?: (() => void)

Called when the connection is opened

Type declaration

    • (): void
    • Returns void

sse: true

Enable SSE mode