Files
kiss-flixel/feedback-server/externs/js/html/ITextDecoder.hx

36 lines
1.5 KiB
Haxe
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

package js.html;
/**
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.
`TextDecoder` class is a global reference for `require('util').TextDecoder`
https://nodejs.org/api/globals.html#textdecoder
**/
typedef ITextDecoder = {
/**
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 stream. If the invocation without options's stream (or set to false) has no input, it's clearest to omit both arguments.
```
var string = "", decoder = new TextDecoder(encoding), buffer;
while(buffer = next_chunk()) {
string += decoder.decode(buffer, {stream:true});
}
string += decoder.decode(); // end-of-stream
```
If the error mode is "fatal" and encoding's decoder returns error, throws a TypeError.
**/
function decode(?input:node.crypto.webcrypto.BufferSource, ?options:js.html.TextDecodeOptions):String;
/**
Returns encoding's name, lowercased.
**/
final encoding : String;
/**
Returns true if error mode is "fatal", and false otherwise.
**/
final fatal : Bool;
/**
Returns true if ignore BOM flag is set, and false otherwise.
**/
final ignoreBOM : Bool;
};