TextDecoderStream
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2022.
Note: This feature is available in Web Workers.
The TextDecoderStream interface of the Encoding API converts a stream of text in a binary encoding, such as UTF-8 etc., to a stream of strings.
It is the streaming equivalent of TextDecoder.
It implements the same shape as a TransformStream, allowing it to be used in ReadableStream.pipeThrough() and similar methods.
Constructor
TextDecoderStream()-
Creates a new
TextDecoderStreamobject.
Instance properties
TextDecoderStream.encodingRead only-
An encoding.
TextDecoderStream.fatalRead only-
A
booleanindicating if the error mode is fatal. TextDecoderStream.ignoreBOMRead only-
A
booleanindicating whether the byte order mark is ignored. TextDecoderStream.readableRead only-
Returns the
ReadableStreaminstance controlled by this object. TextDecoderStream.writableRead only-
Returns the
WritableStreaminstance controlled by this object.
Examples
Specifications
| Specification |
|---|
| Encoding # interface-textdecoderstream |
Browser compatibility
| desktop | mobile | server | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TextDecoderStream
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
TextDecoderStream() constructor
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
encoding
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
fatal
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
ignoreBOM
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
readable
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
writable
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- Partial support
- Partial support
- Has more compatibility info.
See also
TextEncoderStreamTextDecoderTransformStream- Streams API Concepts
- Experimenting with the Streams API
- Streaming requests with the fetch API, developer.chrome.com (2020)