WritableStreamSink
Defined in: packages/app-report/src/sink/writable-stream-sink.ts:23
Renders through a Formatter into a Web WritableStream<string>.
Portable — the Node adapter is Writable.toWeb. Applies backpressure by
awaiting the writer, so an AsyncQueueSink in front of this one is the
recommended way to decouple a slow destination, rather than buffering
internally here too.
Type Parameters
Section titled “Type Parameters”TData
Implements
Section titled “Implements”ISink<TData>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new WritableStreamSink<
TData>(stream,options):WritableStreamSink<TData>
Defined in: packages/app-report/src/sink/writable-stream-sink.ts:30
Parameters
Section titled “Parameters”stream
Section titled “stream”WritableStream<string>
options
Section titled “options”WritableStreamSinkOptions<TData>
Returns
Section titled “Returns”WritableStreamSink<TData>
Methods
Section titled “Methods”close()
Section titled “close()”close():
Promise<void>
Defined in: packages/app-report/src/sink/writable-stream-sink.ts:61
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”flush()
Section titled “flush()”flush():
Promise<void>
Defined in: packages/app-report/src/sink/writable-stream-sink.ts:57
Waits for the writer to catch up with backpressure.
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”write()
Section titled “write()”write(
event,signal?):Promise<void>
Defined in: packages/app-report/src/sink/writable-stream-sink.ts:40
Parameters
Section titled “Parameters”ReportEvent<TData>
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<void>