@johngw/stream/dist/es/sinks/ForkableSink.d.ts

Reactive programming tools using the WHATWG Streams API.

import { Forkable } from '@johngw/stream/sinks/Forkable';
import { Controllable } from '@johngw/stream/sources/Controllable';
import { ControllableSource } from '@johngw/stream/sources/ControllableSource';
/**
 * A ForkableSink is the underlying logic for "1 Writable to many Readables".
 *
 * @group Sinks
 * @see {@link ForkableStream:class}
 * @example
 * ```
 * const forkable = new ForkableStream<T>()
 * const writable = new WritableStream(forkable)
 *
 * fromCollection([1, 2, 3, 4, 5, 6, 7]).pipeTo(writable)
 *
 * forkable.fork().pipeTo(write(x => console.info('fork1', x)))
 * // fork1 1, fork1 2, fork1 3, fork1 4, fork1 5, fork1 6, fork1 7
 *
 * forkable.fork().pipeTo(write(x => console.info('fork2', x)))
 * // fork2 1, fork2 2, fork2 3, fork2 4, fork2 5, fork2 6, fork2 7
 * ```
 */
export declare class ForkableSink<T> implements UnderlyingSink<T>, Forkable<T> {
    #private;
    abort(reason: unknown): void;
    close(): void;
    write(chunk: T): void;
    get finished(): boolean;
    fork(underlyingSource?: UnderlyingDefaultSource<T>, queuingStrategy?: QueuingStrategy<T>): ReadableStream<T>;
    protected _addController(underlyingSource?: UnderlyingDefaultSource<T>, queuingStrategy?: QueuingStrategy<T>): readonly [ControllableSource<T>, ReadableStream<T>];
    protected _pipeThroughController([controller, stream]: readonly [
        Controllable<T>,
        ReadableStream<T>
    ]): ReadableStream<T>;
}