@designerstrust/remix-utils/browser/server/event-stream.d.ts

This package contains simple utility functions to use with [Remix.run](https://remix.run).

interface SendFunctionArgs {
    /**
     * @default "message"
     */
    event?: string;
    data: string;
}
interface SendFunction {
    (args: SendFunctionArgs): void;
}
interface CleanupFunction {
    (): void;
}
interface InitFunction {
    (send: SendFunction): CleanupFunction;
}
/**
 * A response holper to use Server Sent Events server-side
 * @param signal The AbortSignal used to close the stream
 * @param init The function that will be called to initialize the stream, here you can subscribe to your events
 * @returns A Response object that can be returned from a loader
 */
export declare function eventStream(signal: AbortSignal, init: InitFunction): Response;
export {};