kotlin-web/web.encoding/TextDecoder

TextDecoder

open external class TextDecoder(label: String = definedExternally, options: TextDecoderOptions = definedExternally) : TextDecoderCommon(source)

A decoder for a specific method, that is a specific character encoding, like utf-8, iso-8859-2, koi8, cp1261, gbk, etc. A decoder takes a stream of bytes as input and emits a stream of code points. For a more scalable, non-native library, see StringView – a C-like representation of strings based on typed arrays.

MDN Reference

Constructors

TextDecoder

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.

Functions

decode

fun decode(input: AllowSharedBufferSource = definedExternally, options: TextDecodeOptions = definedExternally): String

Returns the result of running encoding's decoder. The method can be invoked zero or more times with options's stream set to true, and then once without options's stream (or set to false), to process a fragmented input. If the invocation without options's stream (or set to false) has no input, it's clearest to omit both arguments.