TextDecoderStream: ignoreBOM property

{{APIRef("Encoding API")}}{{AvailableInWorkers}}

The ignoreBOM read-only property of the {{domxref("TextDecoderStream")}} interface is a {{jsxref('Boolean')}} indicating whether the byte order mark will be included in the output or skipped over.

Value

true if the byte order mark will be included in the decoded text; false if it will be skipped over when decoding and omitted.

Examples

stream = new TextDecoderStream();
console.log(stream.ignoreBOM); // returns false

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}