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 TextDecoderStream object.

Instance properties

TextDecoderStream.encodingRead only

An encoding.

TextDecoderStream.fatalRead only

A Boolean indicating if the error mode is fatal.

TextDecoderStream.ignoreBOMRead only

A Boolean indicating whether the byte order mark is ignored.

TextDecoderStream.readableRead only

Returns the ReadableStream instance controlled by this object.

TextDecoderStream.writableRead only

Returns the WritableStream instance controlled by this object.

Examples

Examples of streaming structured data and HTML

Specifications

Specification
Encoding
# interface-textdecoderstream

Browser compatibility

See also