ReadableStreamDefaultController

E242824

ReadableStreamDefaultController is a Web Streams API interface that allows developers to control and manage the internal state, queuing, and data flow of a readable stream.

All labels observed (1)

Label Occurrences
ReadableStreamDefaultController canonical 4

How this entity was disambiguated

Statements (44)

Predicate Object
instanceOf Readable stream controller
Web API interface
availableInEnvironment Deno
Node.js
surface form: Node.js (when Web Streams API is enabled)

Web browsers
category java.nio
surface form: Streams and I/O
closeEffect prevents further enqueue() calls
controls ReadableStream
controlsType default readable stream
definedInSpecification WHATWG Streams Standard
enqueueConstraint cannot enqueue after close() or error()
errorEffect wakes pending read requests with an error
exposedOn Window
WorkerGlobalScope
governingBody WHATWG
hasExampleUsage new ReadableStream({ start(controller) { controller.enqueue(...); } })
hasMethod close()
enqueue()
error()
hasProperty desiredSize
introducedAround 2015s
lifecycle created internally by ReadableStream
manages backpressure of a readable stream
data flow of a readable stream
internal state of a readable stream
queue of a readable stream
methodPurpose close() signals that the stream will not produce more chunks
enqueue() adds a chunk to the stream’s internal queue
error() errors the stream and signals failure to consumers
notConstructibleDirectly true
partOf Web Streams API
propertyPurpose desiredSize indicates how much additional data the consumer can handle
queueType internal byte or value queue depending on stream type
relatedInterface ReadableByteStreamController
TransformStreamDefaultController
standardStatus Living standard
supportsBackpressure true
usedFor controlling when data is produced
implementing custom readable data sources
responding to consumer demand
usedIn underlying source cancel algorithm
underlying source pull algorithm
underlying source start algorithm
usedWith ReadableStream
surface form: ReadableStream constructor

How these facts were elicited

Referenced by (4)

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

Streams Standard definesConcept ReadableStreamDefaultController
ReadableByteStreamController relatedTo ReadableStreamDefaultController
TransformStreamDefaultController relatedInterface ReadableStreamDefaultController
ByteLengthQueuingStrategy relatedAPI ReadableStreamDefaultController