title | short-title | slug | page-type | browser-compat |
---|---|---|---|---|
TextDecoder: decode() method |
decode() |
Web/API/TextDecoder/decode |
web-api-instance-method |
api.TextDecoder.decode |
{{APIRef("Encoding API")}}
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 {{domxref("TextDecoder")}} object. This includes the expected encoding of the data, and how decoding errors are handled.
decode()
decode(buffer)
decode(buffer, options)
-
buffer
{{Optional_Inline}}- : An
ArrayBuffer
, a {{jsxref("TypedArray")}}, or a {{jsxref("DataView")}} object containing the encoded text to decode.
- : An
-
options
{{Optional_Inline}}-
: An object with the property:
stream
- : A boolean flag indicating whether additional data will follow in subsequent calls to
decode()
. Set totrue
if processing the data in chunks, andfalse
for the final chunk or if the data is not chunked. It defaults tofalse
.
- : A boolean flag indicating whether additional data will follow in subsequent calls to
-
- {{jsxref("TypeError")}}
- : Thrown if there is a decoding error when the property {{DOMxRef("TextDecoder.fatal")}} is
true
.
- : Thrown if there is a decoding error when the property {{DOMxRef("TextDecoder.fatal")}} is
A string.
This example encodes and decodes the euro symbol, €.
<p>Encoded value: <span id="encoded-value"></span></p>
<p>Decoded value: <span id="decoded-value"></span></p>
const encoder = new TextEncoder();
const array = encoder.encode("€"); // Uint8Array(3) [226, 130, 172]
document.getElementById("encoded-value").textContent = array;
const decoder = new TextDecoder();
const str = decoder.decode(array); // String "€"
document.getElementById("decoded-value").textContent = str;
{{EmbedLiveSample("Examples")}}
{{Specifications}}
{{Compat}}
- The {{DOMxRef("TextDecoder")}} interface it belongs to.