util.TextDecoder

An implementation of the WHATWG Encoding Standard TextDecoder API.

const decoder = new TextDecoder();
const u8arr = new Uint8Array([72, 101, 108, 108, 111]);
console.log(decoder.decode(u8arr)); // Hello

Per the WHATWG Encoding Standard, the encodings supported by the TextDecoder API are outlined in the tables below. For each encoding, one or more aliases may be used.

Different Node.js build configurations support different sets of encodings. (see Internationalization)

The 'iso-8859-16' encoding listed in the WHATWG Encoding Standard is not supported.

new TextDecoder(encoding?, options?): TextDecoder

Creates a new TextDecoder instance. The encoding may specify one of the supported encodings or an alias.

The TextDecoder class is also available on the global object.

textDecoder.decode(input?, options?): string

Decodes the input and returns a string. If options.stream is true, any incomplete byte sequences occurring at the end of the input are buffered internally and emitted after the next call to textDecoder.decode().

If textDecoder.fatal is true, decoding errors that occur will result in a TypeError being thrown.

The encoding supported by the TextDecoder instance.

The value will be true if decoding errors result in a TypeError being thrown.

The value will be true if the decoding result will include the byte order mark.