sveltekit-eventsource - v1.0.0
    Preparing search index...

    Type Alias SSEConfiguration<S>

    Configuration options for the server-side EventSource.

    type SSEConfiguration<S extends keyof App.Events = keyof App.Events> = {
        debug?: DebugLogger | boolean;
        name: S;
        ping_interval?: number;
        retry_interval?: number;
        serializer?: <E extends keyof App.Events[S] = keyof App.Events[S]>(
            event: E | undefined,
            val: App.Events[S][E],
        ) => string;
    }

    Type Parameters

    • S extends keyof App.Events = keyof App.Events

      Stream name (key of App.Events) that determines the typed event map.

    Index

    Properties

    debug? name ping_interval? retry_interval? serializer?

    Properties

    debug?: DebugLogger | boolean

    Optional debug logger.

    • true uses console
    • a DebugLogger object uses its provided methods
    • undefined disables debug output
    name: S

    Stream name (must be a key of App.Events).

    This value is only used for typing and debugging; the SSE endpoint URL defines routing.

    ping_interval?: number

    Keep-alive interval in milliseconds. A comment line : ping is emitted periodically to keep proxies/connections alive.

    30000
    retry_interval?: number

    Suggested browser reconnect delay in milliseconds. Written as an SSE retry: directive when the stream starts.

    15000
    serializer?: <E extends keyof App.Events[S] = keyof App.Events[S]>(
        event: E | undefined,
        val: App.Events[S][E],
    ) => string

    Serializer used for application events emitted via EventSource.emit.

    If omitted, JSON.stringify is used.

    IMPORTANT: Control/protocol ("magic") messages bypass this serializer and always use the library-defined wire format.

    Settings

    Member Visibility

    On This Page

    Properties