kotlin-web/web.encoding/TextDecoderStream

TextDecoderStream

open class TextDecoderStream(label: String = definedExternally, options: TextDecoderOptions = definedExternally) : GenericTransformStream, TextDecoderCommon(source)

The TextDecoderStream interface of the Encoding API converts a stream of text in a binary encoding, such as UTF-8 etc., to a stream of strings. It is the streaming equivalent of TextDecoder. It implements the same shape as a TransformStream, allowing it to be used in ReadableStream.pipeThrough() and similar methods.

MDN Reference

Constructors

TextDecoderStream

constructor(label: String = definedExternally, options: TextDecoderOptions = definedExternally)

Properties

encoding

open val encoding: String

Returns encoding's name, lowercased.

fatal

open val fatal: Boolean

Returns true if error mode is "fatal", otherwise false.

ignoreBOM

open val ignoreBOM: Boolean

Returns the value of ignore BOM.

readable

open override val readable: ReadableStream<JsString>

The readable read-only property of the TextDecoderStream interface returns a ReadableStream that emits decoded strings.

writable

open override val writable: WritableStream<BufferSource>

The writable read-only property of the TextDecoderStream interface returns a WritableStream that accepts binary data, in the form of ArrayBuffer, TypedArray, or DataView chunks (SharedArrayBuffer and its views are also allowed), to be decoded into strings.