TextDecoder.hx 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. /*
  2. * Copyright (C)2005-2019 Haxe Foundation
  3. *
  4. * Permission is hereby granted, free of charge, to any person obtaining a
  5. * copy of this software and associated documentation files (the "Software"),
  6. * to deal in the Software without restriction, including without limitation
  7. * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  8. * and/or sell copies of the Software, and to permit persons to whom the
  9. * Software is furnished to do so, subject to the following conditions:
  10. *
  11. * The above copyright notice and this permission notice shall be included in
  12. * all copies or substantial portions of the Software.
  13. *
  14. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  19. * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  20. * DEALINGS IN THE SOFTWARE.
  21. */
  22. // This file is generated from mozilla\TextDecoder.webidl. Do not edit!
  23. package js.html;
  24. /**
  25. The `TextDecoder` interface represents 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.
  26. Documentation [TextDecoder](https://developer.mozilla.org/en-US/docs/Web/API/TextDecoder) by [Mozilla Contributors](https://developer.mozilla.org/en-US/docs/Web/API/TextDecoder$history), licensed under [CC-BY-SA 2.5](https://creativecommons.org/licenses/by-sa/2.5/).
  27. @see <https://developer.mozilla.org/en-US/docs/Web/API/TextDecoder>
  28. **/
  29. @:native("TextDecoder")
  30. extern class TextDecoder {
  31. /**
  32. Is a `DOMString` containing the name of the decoder, that is a string describing the method the `TextDecoder` will use.
  33. **/
  34. var encoding(default,null) : String;
  35. /**
  36. Is a `Boolean` indicating whether the error mode is fatal.
  37. **/
  38. var fatal(default,null) : Bool;
  39. /**
  40. Is a `Boolean` indicating whether the byte order marker is ignored.
  41. **/
  42. var ignoreBOM(default,null) : Bool;
  43. /** @throws DOMError */
  44. function new( label : String = "utf-8", ?options : TextDecoderOptions ) : Void;
  45. /**
  46. Returns a `DOMString` containing the text decoded with the method of the specific `TextDecoder` object.
  47. @throws DOMError
  48. **/
  49. @:overload( function( ?input : js.lib.ArrayBuffer, ?options : TextDecodeOptions) : String {} )
  50. function decode( ?input : js.lib.ArrayBufferView, ?options : TextDecodeOptions ) : String;
  51. }