TextDecoder: TextDecoder() constructor
BaselineWidely 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()
constructor returns a newTextDecoder
object.
Syntax
new TextDecoder()new TextDecoder(label)new TextDecoder(label, options)
Parameters
label
OptionalA string identifying the character encoding that this decoder will use. This may beany valid label.
Defaults to
"utf-8"
.options
OptionalAn object with the following properties:
fatal
OptionalA boolean value indicating if the
TextDecoder.decode()
method must throw aTypeError
when decoding invalid data.It defaults tofalse
, which means that the decoder will substitute malformed data with a replacement character.ignoreBOM
OptionalA boolean value indicating whether thebyte order mark will be included in the output or skipped over.It defaults to
false
, which means that the byte order mark will be skipped over when decoding and will not be included in the decoded text.
Exceptions
RangeError
Thrown if the value of
label
is unknown, or is one of the values leading to a'replacement'
decoding algorithm ("iso-2022-cn"
or"iso-2022-cn-ext"
).
Examples
const textDecoder1 = new TextDecoder("iso-8859-2");const textDecoder2 = new TextDecoder();const textDecoder3 = new TextDecoder("csiso2022kr", { fatal: true });// Allows TypeError exception to be thrown.const textDecoder4 = new TextDecoder("iso-2022-cn");// Throws a RangeError exception.
Specifications
Specification |
---|
Encoding # ref-for-dom-textdecoder① |
Browser compatibility
See also
- The
TextDecoder
interface it belongs to.