kinetex - v1.0.0-rc.1
    Preparing search index...

    Class SSERouter

    Route SSE events by type to registered handlers, similar to EventSource.addEventListener.

    Index

    Constructors

    Methods

    • Register a handler for a specific SSE event type.

      Parameters

      • eventType: string

        The event name to match (e.g. "message", "update").

      • handler: SSEEventHandler

        Async function called with event data and the raw SSEEvent.

      Returns this

      this for chaining.

    • Register a handler for events of a given type, automatically parsing data as JSON.

      Note: JSON parse errors are silently ignored — if the event data is not valid JSON, the handler is not called and no error is thrown. To handle parse errors, use on() with a try/catch inside your handler.

      Type Parameters

      • T

      Parameters

      • eventType: string

        The SSE event type to match (e.g., "update", "message").

      • handler: SSEEventHandler<T>

        Async function called with parsed JSON data and the raw event.

      Returns this

      this for chaining.

    • Register a handler for "message" events (default event type).

      Parameters

      • handler: SSEEventHandler

      Returns this

    • Handle any event not matched by a specific handler.

      Parameters

      • handler: SSEEventHandler

      Returns this

    • Dispatch a single SSE event to the appropriate handler(s).

      Parameters

      • event: SSEEvent

        The parsed SSE event to dispatch.

      Returns Promise<void>

    • Consume an async iterable of SSE events, routing each one.

      Parameters

      • source: AsyncIterable<SSEEvent>

        An async iterable of SSEEvent (e.g. from SSEClient).

      Returns Promise<void>