Class BaseForkableStream<T, Sink>`Abstract`

Abstract logic for Forkable streams.

Type Parameters

T
Sink extends ForkableSink<T> = ForkableSink<T>

Hierarchy (View Summary)

WritableStream<T>
- BaseForkableStream

Implements

Forkable<T>

Index

Constructors

Properties

Accessors

Methods

abort close fork getWriter

Constructors

constructor

new BaseForkableStream<T, Sink extends ForkableSink<T> = ForkableSink<T>>(
sink: Sink,
queuingStrategy?: QueuingStrategy<T>,
): BaseForkableStream<T, Sink>
Type Parameters
- T
- Sink extends ForkableSink<T> = ForkableSink<T>
Parameters
- sink: Sink
- OptionalqueuingStrategy: QueuingStrategy<T>
Returns BaseForkableStream<T, Sink>
Overrides WritableStream<T>.constructor
- Defined in packages/stream/src/sinks/BaseForkableStream.ts:19

Properties

`Readonly`locked

locked: boolean

Accessors

finished

get finished(): boolean
Returns boolean
Implementation of Forkable.finished
- Defined in packages/stream/src/sinks/BaseForkableStream.ts:24

`Protected`sink

get sink(): Sink
Returns Sink
- Defined in packages/stream/src/sinks/BaseForkableStream.ts:35

Methods

abort

abort(reason?: any): Promise<void>
Parameters
- Optionalreason: any
Returns Promise<void>
Inherited from WritableStream.abort
- Defined in node_modules/@types/node/stream/web.d.ts:268

close

close(): Promise<void>
Returns Promise<void>
Inherited from WritableStream.close
- Defined in node_modules/@types/node/stream/web.d.ts:269

fork

fork(
underlyingSource?: UnderlyingDefaultSource<T>,
queuingStrategy?: QueuingStrategy<T>,
): ReadableStream<T>
Parameters
- OptionalunderlyingSource: UnderlyingDefaultSource<T>
- OptionalqueuingStrategy: QueuingStrategy<T>
Returns ReadableStream<T>
Implementation of Forkable.fork
- Defined in packages/stream/src/sinks/BaseForkableStream.ts:28

getWriter

getWriter(): WritableStreamDefaultWriter<T>
Returns WritableStreamDefaultWriter<T>
Inherited from WritableStream.getWriter
- Defined in node_modules/@types/node/stream/web.d.ts:270