Skip to main content
Version: 3.28.0

TextDecoder.decode()

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

The decoding method is defined in the current TextDecoder object. This includes the expected encoding of the data, and how decoding errors are handled.

Syntax

decode()
decode(buffer)
decode(buffer, options)

Parameters

  • buffer optional

    • : Is an ArrayBuffer, a TypedArray or a DataView object containing the encoded text to decode.
  • options optional

    • : An object with the property:

      • stream
        • : A boolean flag indicating that additional data will follow in subsequent calls to decode(). Set to true if processing the data in chunks, and false for the final chunk or if the data is not chunked. It defaults to false.

Exceptions

  • TypeError
    • : Thrown if there is a decoding error when the property TextDecoder.fatal is true.

Return value

A string.