TextDecoderStream

E856194

TextDecoderStream is a Web Streams API interface that converts a stream of binary data (such as Uint8Array chunks) into a stream of decoded text using a specified character encoding.

Jump to: Statements Referenced by

Statements (48)

Predicate Object
instanceOf Web API interface
transform stream
availableIn Web browsers NERFINISHED
secure contexts
canBeUsedWith ReadableStream NERFINISHED
WritableStream NERFINISHED
pipeThrough()
pipeTo()
constructorParameter label
options
convertsFrom Uint8Array chunks
binary data stream
convertsTo text stream
defaultEncoding utf-8
definedIn WHATWG Encoding Standard NERFINISHED
errorBehaviorWhenFatalFalse replaces malformed data with U+FFFD
errorBehaviorWhenFatalTrue throws TypeError on decoding error
exposedOn Window NERFINISHED
Worker NERFINISHED
handles incomplete byte sequences across chunks
streaming decoding of multi-byte characters
hasConstructor TextDecoderStream() NERFINISHED
hasProperty readable
writable
implementsConcept TransformStream NERFINISHED
introducedFor streaming text decoding
option fatal
ignoreBOM
optionDefault fatal: false
ignoreBOM: false
partOf Encoding API NERFINISHED
Web Streams API NERFINISHED
pattern byteStream.pipeThrough(new TextDecoderStream())
propertyType readable: ReadableStream<string>
writable: WritableStream<Uint8Array>
relatedInterface TextDecoder NERFINISHED
TextEncoderStream NERFINISHED
TransformStream NERFINISHED
specURL https://encoding.spec.whatwg.org/#interface-textdecoderstream
status living standard
supportsEncoding ISO-8859-1 NERFINISHED
UTF-16BE
UTF-16LE
UTF-8
Windows-1252
useCase decoding WebSocket binary messages to text
decoding fetch Response body as text stream
decoding readable byte streams from other APIs

Referenced by (1)

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

TransformStream oftenUsedWith TextDecoderStream