TextDecoder
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.
Note: This feature is available inWeb Workers.
TheTextDecoder interface represents a decoder for a specific text encoding, such asUTF-8,ISO-8859-2, orGBK. A decoder takes an array of bytes as input and returns a JavaScript string.
In this article
Constructor
TextDecoder()Creates and returns a new
TextDecoder.
Instance properties
TheTextDecoder interface doesn't inherit any properties.
TextDecoder.encodingRead onlyA string containing the name of the character encoding system that this
TextDecoderwill use.TextDecoder.fatalRead onlyA boolean indicating whether the error mode is fatal.
TextDecoder.ignoreBOMRead onlyA boolean indicating whether thebyte order mark is ignored.
Instance methods
TheTextDecoder interface doesn't inherit any methods.
TextDecoder.decode()Decodes the given bytes into a JavaScript string and returns it.
Examples
>Decoding UTF-8 text
This example shows how to decode the UTF-8 encoding of the character "𠮷".
<button>Decode</button><button>Reset</button><div></div>div { margin: 1rem 0;}const utf8decoder = new TextDecoder(); // default 'utf-8'const encodedText = new Uint8Array([240, 160, 174, 183]);const output = document.querySelector("#output");const decodeButton = document.querySelector("#decode");decodeButton.addEventListener("click", () => { output.textContent = utf8decoder.decode(encodedText);});const resetButton = document.querySelector("#reset");resetButton.addEventListener("click", () => { window.location.reload();});Decoding non-UTF8 text
In this example, we decode the Russian text "Привет, мир!", which means "Hello, world." In ourTextDecoder() constructor, we specify the Windows-1251 character encoding.
<button>Decode</button><button>Reset</button><div></div>div { margin: 1rem 0;}const win1251decoder = new TextDecoder("windows-1251");const encodedText = new Uint8Array([ 207, 240, 232, 226, 229, 242, 44, 32, 236, 232, 240, 33,]);const decoded = document.querySelector("#decoded");const decodeButton = document.querySelector("#decode");decodeButton.addEventListener("click", () => { decoded.textContent = win1251decoder.decode(encodedText);});const resetButton = document.querySelector("#reset");resetButton.addEventListener("click", () => { window.location.reload();});Specifications
| Specification |
|---|
| Encoding> # interface-textdecoder> |
Browser compatibility
See also
- The
TextEncoderinterface describing the inverse operation.