Interface SubjectOptions<In, Out>

A Subject is a combination of a :class and a :class giving the developer the ability to both queue items and fork the stream from the same object.

Example

const subject = new Subject<number>()

subject.enqueue(1)
subject.enqueue(2)
subject.enqueue(3)

subject.fork().pipeTo(write(chunk => console.info(chunk)))
interface SubjectOptions<In, Out> {
    controllable?: ControllableReadableStream<In>;
    forkable?: ForkableStream<Out>;
    pipeThroughOptions?: StreamPipeOptions;
    pipeToOptions?: StreamPipeOptions;
    post?: TransformStream<Out, Out>[];
    pre?: TransformStream<In, In>[];
    transform?: TransformStream<In, Out>;
}

Type Parameters

  • In

  • Out = In

Properties

controllable? forkable? pipeThroughOptions? pipeToOptions? post? pre? transform?

Properties

Optional controllable

controllable?: ControllableReadableStream<In>

Optional forkable

forkable?: ForkableStream<Out>

Optional pipeThroughOptions

pipeThroughOptions?: StreamPipeOptions

Optional pipeToOptions

pipeToOptions?: StreamPipeOptions

Optional post

post?: TransformStream<Out, Out>[]

Optional pre

pre?: TransformStream<In, In>[]

Optional transform

transform?: TransformStream<In, Out>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc