@nostr-fetch/kernel/dist/adapterHelpers.d.ts

Kernel of nostr-fetch

import type { ChannelSender } from "./channel";
import { type FetchTillEoseOptions } from "./fetcherBackend";
import type { NostrEvent } from "./nostr";
/**
 * Helper that sets up two types of subscription abortions:
 *
 * - Auto-abortion when time (specified by `abortSubBeforeEoseTimeoutMs`) has passed without receiving any event since the last event was received
 * - Abortion by an AbortController (if enabled by `abortSignal`)
 *
 * Returns a function to reset the timer for the auto-abortion. Implementers of the `NostrFetcherBackend` **MUST** make sure that the function is called each time received an event from a relay.
 * Otherwise, the auto-abortion will not work collectly.
 *
 * @param closeSub A function that specify the logic of closing subscriptions.
 * @param tx A sender endpoint of {@linkcode Channel}. It will be used to signal the abortion to the caller of this `NostrFetcherBackend`.
 * @param options Pass `FetcherTillEoseOptions` down here.
 * @returns A function which resets the timer for the auto-abortion.
 *
 * @example
 * ```
 * const [tx, chIter] = Channel.make<NostrEvent>();
 * const sub = ...; // initializing subscription
 * const closeSub = () => {
 *   sub.close();
 *   // any cleanups for subscription go here
 * }
 * const resetAutoAbortTimer = setupSubscriptionAutoAbortion(closeSub, tx, options);
 *
 * // make sure that you call the function returned from
 * // `setupSubscriptionAutoAbortion` each time you received an event!
 * sub.on("event", (ev: NostrEvent) => {
 *   tx.send(ev);
 *   resetAutoAbortion();
 * });
 * ...
 * ```
 */
export declare const setupSubscriptionAutoAbortion: (closeSub: () => void, tx: ChannelSender<NostrEvent>, options: FetchTillEoseOptions) => (() => void);
//# sourceMappingURL=adapterHelpers.d.ts.map