Headers.hx 3.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. /*
  2. * Copyright (C)2005-2018 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\Headers.webidl. Do not edit!
  23. package js.html;
  24. /**
  25. The `Headers` interface of the Fetch API allows you to perform various actions on HTTP request and response headers. These actions include retrieving, setting, adding to, and removing. A `Headers` object has an associated header list, which is initially empty and consists of zero or more name and value pairs.  You can add to this using methods like `append()` (see Examples.) In all methods of this interface, header names are matched by case-insensitive byte sequence.
  26. Documentation [Headers](https://developer.mozilla.org/en-US/docs/Web/API/Headers) by [Mozilla Contributors](https://developer.mozilla.org/en-US/docs/Web/API/Headers$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/Headers>
  28. **/
  29. @:native("Headers")
  30. extern class Headers
  31. {
  32. /** @throws DOMError */
  33. function new( ?init : haxe.extern.EitherType<Headers,haxe.extern.EitherType<Array<Array<String>>,Dynamic/*MISSING ByteStringMozMap*/>> ) : Void;
  34. /** @throws DOMError */
  35. /**
  36. Appends a new value onto an existing header inside a `Headers` object, or adds the header if it does not already exist.
  37. **/
  38. function append( name : String, value : String ) : Void;
  39. /** @throws DOMError */
  40. @:native("delete")
  41. function delete_( name : String ) : Void;
  42. /** @throws DOMError */
  43. /**
  44. Returns the first value of a given header from within a `Headers` object.
  45. **/
  46. function get( name : String ) : String;
  47. /** @throws DOMError */
  48. /**
  49. Returns an array of all the values of a header within a `Headers` object with a given name.
  50. **/
  51. function getAll( name : String ) : Array<String>;
  52. /** @throws DOMError */
  53. /**
  54. Returns a boolean stating whether a `Headers` object contains a certain header.
  55. **/
  56. function has( name : String ) : Bool;
  57. /** @throws DOMError */
  58. /**
  59. Sets a new value for an existing header inside a `Headers` object, or adds the header if it does not already exist.
  60. **/
  61. function set( name : String, value : String ) : Void;
  62. /** @throws DOMError */
  63. /**
  64. Returns an `Iteration_protocols` allowing to go through all key/value pairs contained in this object.
  65. **/
  66. function entries() : HeadersIterator;
  67. /** @throws DOMError */
  68. /**
  69. Returns an `Iteration_protocols` allowing to go through all keys f the key/value pairs contained in this object.
  70. **/
  71. function keys() : HeadersIterator;
  72. /** @throws DOMError */
  73. /**
  74. Returns an `Iteration_protocols` allowing to go through all values of the key/value pairs contained in this object.
  75. **/
  76. function values() : HeadersIterator;
  77. /** @throws DOMError */
  78. function forEach( callback : Dynamic, ?thisArg : Dynamic ) : Void;
  79. }