Class WritableStream<W>

This Streams API interface provides a standard abstraction for writing streaming data to a destination, known as a sink. This object comes with built-in backpressure and queuing.

Type Parameters

W = any

Hierarchy (View Summary)

WritableStream
- DigestStream

Index

Constructors

Accessors

Methods

abort close getWriter

Constructors

constructor

new WritableStream<W = any>(
underlyingSink?: UnderlyingSink<any>,
queuingStrategy?: QueuingStrategy<any>,
): WritableStream<W>
Type Parameters
- W = any
Parameters
- OptionalunderlyingSink: UnderlyingSink<any>
- OptionalqueuingStrategy: QueuingStrategy<any>
Returns WritableStream<W>

Accessors

locked

get locked(): boolean
Returns boolean

Methods

abort

abort(reason?: any): Promise<void>
Parameters
- Optionalreason: any
Returns Promise<void>

close

close(): Promise<void>
Returns Promise<void>

getWriter

getWriter(): WritableStreamDefaultWriter<W>
Returns WritableStreamDefaultWriter<W>