ReadableStream

E242819

ReadableStream is a web platform interface representing a source of streaming data that can be read incrementally, commonly used for handling network responses and other asynchronous data flows in JavaScript.

All labels observed (2)

Label Occurrences
ReadableStream canonical 8
ReadableStream constructor 1

How this entity was disambiguated

Statements (51)

Predicate Object
instanceOf JavaScript built-in object
Web API interface
availableIn Deno
Node.js
Web browsers
canBeClosedBy controller.close()
canBeDisturbedBy cancel()
errors in underlying source
canBeLocked true
cancelReason any JavaScript value
canErrorWith stored error state
chunkType arbitrary JavaScript values for default streams
usually Uint8Array for byte streams
constructorAccepts strategy object
underlyingSource object
definedInSpecification WHATWG Streams Standard
designedFor non-blocking I/O in web platform
hasConstructor ReadableStream()
hasMethod [Symbol.asyncIterator]()
cancel()
getReader()
locked (getter)
pipeThrough()
pipeTo()
tee()
values()
integratesWith Request.body
TransformStream
WritableStream via piping
fetch() Response.body
introducedIn HTML Living Standard ecosystem
lockedMeans a reader is active on the stream
partOf Web Streams API
pipeThroughAccepts a transform pair with writable and readable
pipeToAccepts WritableStream
represents a source of streaming data
returns ReadableStreamDefaultReader from getReader()
two ReadableStream instances from tee()
standardizedBy WHATWG
supports incremental reading of data
supportsAsynchronousPull true
supportsBackpressure true
supportsBYOB true in byte streams
supportsPattern async iteration over chunks
usedFor asynchronous data flows in JavaScript
handling network responses
processing large data streams
progressive consumption of data
streaming JSON or text data
streaming file data
streaming media data

How these facts were elicited

Referenced by (9)

Full triples — surface form annotated when it differs from this entity's canonical label.

Streams Standard definesConcept ReadableStream
WritableStream relatedInterface ReadableStream
ReadableStreamBYOBReader usedWith ReadableStream
ReadableStreamDefaultController usedWith ReadableStream
this entity surface form: ReadableStream constructor
CountQueuingStrategy usedWith ReadableStream
ByteLengthQueuingStrategy usedWith ReadableStream