tupleson/lib/async/iterableUtils.d.ts

A hackable JSON serializer/deserializer

import { NodeJSReadableStreamEsque, WebReadableStreamEsque } from '../internals/esque.js';

declare function readableStreamToAsyncIterable<T>(stream: NodeJSReadableStreamEsque | ReadableStream<T> | WebReadableStreamEsque): AsyncIterable<T>;
declare function mapIterable<T, TValue>(iterable: AsyncIterable<T>, fn: (v: T) => TValue): AsyncIterable<TValue>;
declare function createReadableStream<TValue = unknown>(): readonly [ReadableStream<TValue>, ReadableStreamDefaultController<TValue>];
/**
 * Creates an event that adheres to the [Event Stream format](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#event_stream_format)
 *
 * When called without any arguments, it returns a keep-alive event.
 * @param opts {{ data?: TData; event?: TEvent; id?: TId; retry?: TRetry }}
 * @param opts.data The data to send to the client. This value will be serialized to JSON.
 * @param opts.event The type of event to send to the client. Defaults to `message`.
 * @param opts.id The id of the event to send to the client, used to resume the connection.
 * @param opts.retry The reconnection time. If the connection to the server is lost, the
 * browser will wait for the specified time before attempting to reconnect.
 */
declare function createServerEvent<const TData, const TEvent extends string, const TId extends string, const TRetry extends number>(opts: {
    data?: TData;
    /**
     * The type of event to send to the client. Defaults to `message`.
     * @default "message" when any other field is set, undefined otherwise
     * @example ```ts
     *  /// on the server
     * createServerEvent({ event: "answer", data: 42 })
     * createServerEvent({ event: "close" })
     * /// on the client
     * const eventSource = new EventSource("/sse");
     * let answer;
     * eventSource.addEventListener("answer", (e) => {
     * 	answer = e.data;
     * })
     * eventSource.addEventListener("close", () => {
     * 	eventSource.close();
     * })
     * ```
     */
    event?: TEvent;
    /**
     * The id of the event to send to the client, used to resume the connection.
     * When the EventSource client reconnects, it will send the last id it
     * received via the `Last-Event-ID` header (though the header can also be
     * set manually). The server will then resume the connection and send all
     * events that happened since the last event with that id.
     * @default undefined
     */
    id?: TId;
    /**
     * The reconnection time. If the connection to the server is lost, the
     * browser will wait for the specified time before attempting to reconnect.
     * This must be an integer, specifying the reconnection time in
     * milliseconds. If a non-integer value is specified it will be rounded
     * down to the nearest integer. The default value is 1000 ms (1 second).
     */
    retry?: TRetry;
}): string;

export { createReadableStream, createServerEvent, mapIterable, readableStreamToAsyncIterable };