ReadableStreamDefaultReader

E242822

ReadableStreamDefaultReader is a Web Streams API interface that provides exclusive, sequential access to the chunks of a ReadableStream in JavaScript.

All labels observed (3)

How this entity was disambiguated

Statements (47)

Predicate Object
instanceOf Readable stream reader
Web API interface
accessType exclusive
sequential
alternativeReader ReadableStreamBYOBReader
availableInEnvironment Deno
Node.js
Web browsers
availableInLanguage JavaScript
cancelArgument optional reason value
cancelPurpose signals that the reader no longer needs the stream
canReadFrom default readable streams
closedPromiseResolvesWhen stream closes or reader releases lock
createdByMethod ReadableStreamDefaultReader self-linksurface differs
surface form: ReadableStream.prototype.getReader
definedIn WHATWG Streams Standard
errorOnMultipleReaders true
errorPropagation propagates stream errors to read() and closed promise
exclusiveLock true
hasConstructor ReadableStreamDefaultReader()
hasMethod cancel
closed
read
releaseLock
introducedFor standardized streaming data consumption in web platform
lockBehavior locks the stream while reader is active
methodType closed returns a Promise
read returns a Promise
namespace global Window scope in browsers
notFor byte streams
partOf Streams API
Web Streams API
providesAccessTo ReadableStream
readBehavior queues read requests until chunks are available
readReturns object with value and done properties
relatedConcept ReadableStream locking mechanism
releaseLockPurpose releases exclusive access to the stream
requires locked ReadableStream
securityContext secure contexts recommended
specSection ReadableStreamDefaultReader self-linksurface differs
surface form: Readable stream default reader
standardStatus living standard
supportsAsyncIteration indirectly via ReadableStream async iterator
supportsBackpressure true
unlockBehavior stream becomes unlocked after releaseLock
usedFor reading chunks from a ReadableStream
usedIn custom streaming protocols in web apps
fetch API response.body reading
webIDLType interface ReadableStreamDefaultReader

How these facts were elicited

Referenced by (5)

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

Streams Standard definesConcept ReadableStreamDefaultReader
ReadableStreamDefaultReader createdByMethod ReadableStreamDefaultReader self-linksurface differs
this entity surface form: ReadableStream.prototype.getReader
ReadableStreamDefaultReader specSection ReadableStreamDefaultReader self-linksurface differs
this entity surface form: Readable stream default reader
WritableStreamDefaultWriter relatedConcept ReadableStreamDefaultReader
ReadableStreamBYOBRequest relatedConcept ReadableStreamDefaultReader