Class Subject<In, Out>

The base class for all subjects.

See

Type Parameters

In
Out = In

Hierarchy (view full)

Subject
- StatefulSubject

Implements

Subjectable<In, Out>

Index

Constructors

Properties

#controllable #controllers #forkable

Accessors

controllable finished forkable

Methods

#closeController control fork write

Constructors

constructor

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

Properties

`Private` #controllable

#controllable: ControllableReadableStream<In>

`Private` #controllers

#controllers: Set<ControllableReadableStream<In>> = ...

`Private` #forkable

#forkable: ForkableStream<Out>

Accessors

`Protected` controllable

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

finished

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

`Protected` forkable

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

Methods

`Private` #closeController

#closeController(controller): void
Parameters
- controller: ControllableReadableStream<In>
Returns void
- Defined in packages/stream/src/subjects/Subject.ts:131

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:115

fork

fork(): ReadableStream<Out>
Returns ReadableStream<Out>
Implementation of Subjectable.fork
- Defined in packages/stream/src/subjects/Subject.ts:89

write

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

Generated using TypeDoc