Class Subject<In, Out>

The base class for all subjects.

See

Type Parameters

In
Out = In

Hierarchy (View Summary)

Subject
- StatefulSubject

Implements

Subjectable<In, Out>

Index

Constructors

Accessors

controllable finished forkable

Methods

control fork write

Constructors

constructor

new Subject<In, Out = In>(options?: SubjectOptions<In, Out>): Subject<In, Out>
Type Parameters
- In
- Out = In
Parameters
- options: SubjectOptions<In, Out> = {}
Returns Subject<In, Out>
- Defined in packages/stream/src/subjects/Subject.ts:67

Accessors

`Protected`controllable

get controllable(): ControllableReadableStream<In>
Returns ControllableReadableStream<In>
- Defined in packages/stream/src/subjects/Subject.ts:108

finished

get finished(): boolean
Returns boolean
Implementation of Subjectable.finished
- Defined in packages/stream/src/subjects/Subject.ts:112

`Protected`forkable

get forkable(): ForkableStream<Out>
Returns ForkableStream<Out>
- Defined in packages/stream/src/subjects/Subject.ts:116

Methods

control

control(): ControllableReadableStream<In>
Returns a proxy to the ControllableStream. Once all proxies have been closed, then the source is also closed.

Returns ControllableReadableStream<In>
Implementation of Subjectable.control
- Defined in packages/stream/src/subjects/Subject.ts:149

fork

fork(
underlyingSource?: UnderlyingDefaultSource<Out>,
queuingStrategy?: QueuingStrategy<Out>,
): ReadableStream<Out>
Parameters
- OptionalunderlyingSource: UnderlyingDefaultSource<Out>
- OptionalqueuingStrategy: QueuingStrategy<Out>
Returns ReadableStream<Out>
Implementation of Subjectable.fork
- Defined in packages/stream/src/subjects/Subject.ts:120

write

write(queuingStrategy?: QueuingStrategy<In>): WritableStream<In>
Parameters
- OptionalqueuingStrategy: QueuingStrategy<In>
Returns WritableStream<In>
- Defined in packages/stream/src/subjects/Subject.ts:127