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? headers? onClose? onError? onMessage? onOpen? sse

Properties

Optional data

data?: unknown

Request body for POST SSE

Optional headers

headers?: Record<string, string>

Custom headers for SSE request

Optional onClose

onClose?: (() => void)

Called when the connection is closed

Type declaration

    • (): void

    • Returns void

Optional onError

onError?: ((error) => void)

Called when an error occurs

Type declaration

    • (error): void

    • Parameters

      • error: unknown

      Returns void

Optional onMessage

onMessage?: ((event) => void)

Called when a message is received

Type declaration

Optional onOpen

onOpen?: (() => void)

Called when the connection is opened

Type declaration

    • (): void

    • Returns void

sse

sse: true

Enable SSE mode

Settings

Member Visibility

Theme

On This Page

dataheadersonCloseonErroronMessageonOpensse