@thi.ng/rstream/iterable.d.ts

Reactive streams & subscription primitives for constructing dataflow graphs / pipelines

import type { CommonOpts } from "./api.js";
export interface FromIterableOpts extends CommonOpts {
    /**
     * Time delay (in ms) between emitted values. The default value of
     * 0, means as fast as possible (but still via `setInterval`).
     *
     * @defaultValue 0
     */
    delay: number;
}
/**
 * Returns a {@link Stream} of values from provided iterable, emitted at
 * the given `delay` interval.
 *
 * @remarks
 * Asynchronously starts pulling values from source iterable when the
 * first subscriber becomes available. The values are processed &
 * emitted via `setInterval()`, using the given `delay` value (default:
 * 0). By default, once the iterable is exhausted (if finite), calls
 * {@link ISubscriber.done} to close the stream, but this can be
 * re-configured via provided {@link CommonOpts | options}.
 *
 * @param src -
 * @param opts -
 */
export declare const fromIterable: <T>(src: Iterable<T>, opts?: Partial<FromIterableOpts>) => import("./stream.js").Stream<T>;
/**
 * Creates a new {@link Stream} of given iterable which synchronously calls
 * {@link ISubscriber.next} for each item of the iterable when the first (and in
 * this case the only one) subscriber becomes available. Once the iterable is
 * exhausted (MUST be finite!), then calls {@link ISubscriber.done} by default,
 * but can be avoided by passing `false` as last argument.
 *
 * @param src -
 * @param opts -
 */
export declare const fromIterableSync: <T>(src: Iterable<T>, opts?: Partial<CommonOpts>) => import("./stream.js").Stream<T>;
//# sourceMappingURL=iterable.d.ts.map