Class 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

Since

v8.3.0

Hierarchy

  • TextDecoder

Constructors

constructor

Properties

encoding fatal ignoreBOM

Methods

decode

Constructors

constructor

  • Parameters

    • Optional encoding: string
    • Optional options: {
          fatal?: boolean;
          ignoreBOM?: boolean;
      }
      • Optional fatal?: boolean
      • Optional ignoreBOM?: boolean

    Returns TextDecoder

Properties

Readonly encoding

encoding: string

The encoding supported by the TextDecoder instance.

Readonly fatal

fatal: boolean

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

Readonly ignoreBOM

ignoreBOM: boolean

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

Methods

decode

  • 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 aTypeError being thrown.

    Parameters

    • Optional input: null | ArrayBuffer | ArrayBufferView

      An ArrayBuffer, DataView or TypedArray instance containing the encoded data.

    • Optional options: {
          stream?: boolean;
      }
      • Optional stream?: boolean

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc