Text encoding and decoding

The TextDecoder.decode() method returns a string containing text decoded from the buffer passed as a parameter.

The TextDecoder.encoding read-only property returns a string containing the name of the character encoding that this decoder will use.

The fatal read-only property of the TextDecoder interface is a Boolean indicating whether the error mode is fatal.

The ignoreBOM read-only property of the TextDecoder interface is a Boolean indicating whether the byte order mark will be included in the output or skipped over. The value of the property is set in the ignoreBOM argument to the decoder's constructor.

The TextDecoder() constructor returns a new TextDecoder object.

Available in 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.

The encoding read-only property of the TextDecoderStream interface returns a string containing the name of the encoding algorithm used by the specific decoder.

The fatal read-only property of the TextDecoderStream interface is a Boolean indicating if the error mode of the TextDecoderStream object is set to fatal.

The ignoreBOM read-only property of the TextDecoderStream interface is a Boolean indicating whether the byte order mark will be included in the output or skipped over.

The readable read-only property of the TextDecoderStream interface returns a ReadableStream that emits decoded strings.

The TextDecoderStream() constructor creates a new TextDecoderStream object which is used to convert a stream of text in a binary encoding into strings.

The writable read-only property of the TextDecoderStream interface returns a WritableStream that accepts binary data, in the form of ArrayBuffer, TypedArray, or DataView chunks (SharedArrayBuffer and its views are also allowed), to be decoded into strings.

The TextEncoder interface enables you to character encoding a JavaScript string using UTF-8.

The TextEncoder.encode() method takes a string as input, and returns a Global_Objects/Uint8Array containing the string character encoding using UTF-8.

The TextEncoder.encodeInto() method takes a string to encode and a destination Uint8Array to put resulting UTF-8 encoded text into, and returns an object indicating the progress of the encoding. This is potentially more performant than the TextEncoder.encode() method — especially when the target buffer is a view into a Wasm heap.

The TextEncoder.encoding read-only property returns a string containing the name of the encoding algorithm used by the specific encoder.

The TextEncoder() constructor returns a newly created TextEncoder object.

Available in workers

The TextEncoderStream interface of the Encoding API converts a stream of strings into bytes in the UTF-8 encoding. It is the streaming equivalent of TextEncoder. It implements the same shape as a TransformStream, allowing it to be used in ReadableStream.pipeThrough() and similar methods.

The encoding read-only property of the TextEncoderStream interface returns a string containing the name of the encoding algorithm used by the current TextEncoderStream object.

The readable read-only property of the TextEncoderStream interface returns a ReadableStream that emits encoded binary data as Uint8Array chunks.

The TextEncoderStream() constructor creates a new TextEncoderStream object which is used to convert a stream of strings into bytes using UTF-8 encoding.

The writable read-only property of the TextEncoderStream interface returns a WritableStream that accepts strings to be encoded into binary data.