ReadableStreamBYOBRequest

E244401

ReadableStreamBYOBRequest is a Web Streams API interface that represents a pull request allowing developers to supply their own buffer for efficiently reading binary data.

All labels observed (2)

How this entity was disambiguated

Statements (39)

Predicate Object
instanceOf Web API interface
interface
associatedWith ReadableByteStreamController
ReadableStream
availability supported in modern browsers
availableInContext Window
Worker
bufferOwnershipModel consumer-provided buffer
category binary data streaming
dataModel pull-based streaming
definedInSpecification WHATWG Streams Standard
designGoal improve performance of binary reads
reduce buffer allocations
errorHandling respond() after stream close or error throws TypeError in most implementations
exposedIn JavaScript
hasMethod respond()
respondWithNewView()
hasProperty view
introducedFor byte-oriented readable streams
lifecycle ReadableByteStreamController
surface form: created by ReadableByteStreamController

represents a single pending BYOB read request
namePattern BYOB stands for Bring Your Own Buffer
namespace globalThis
partOf Streams API
Web Streams API
relatedConcept ReadableStreamBYOBRequest self-linksurface differs
surface form: ReadableByteStreamController.byobRequest

ReadableStreamBYOBReader
ReadableStreamDefaultReader
requires underlying byte source
respondUsage signals how many bytes were written into the view
respondWithNewViewUsage provides a new ArrayBufferView containing the read data
typicalUsage file and network streaming with custom buffers
low-level binary protocols over streams
usedFor BYOB (bring your own buffer) reads
reading binary data efficiently
supplying caller-provided buffers
viewIs typed array view
viewType DataView
surface form: ArrayBufferView
webPlatformStatus standardized

How these facts were elicited

Referenced by (2)

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

Streams Standard definesConcept ReadableStreamBYOBRequest
ReadableStreamBYOBRequest relatedConcept ReadableStreamBYOBRequest self-linksurface differs
this entity surface form: ReadableByteStreamController.byobRequest