jsheaders.html 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <!-- This file is generated by Nim. -->
  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
  5. <head>
  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8. <title>std/jsheaders</title>
  9. <!-- Google fonts -->
  10. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
  11. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
  12. <!-- Favicon -->
  13. <link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
  14. <link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
  15. <!-- CSS -->
  16. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
  17. <!-- JS -->
  18. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
  19. </head>
  20. <body>
  21. <div class="document" id="documentId">
  22. <div class="container">
  23. <h1 class="title">std/jsheaders</h1>
  24. <div class="row">
  25. <div class="three columns">
  26. <div class="theme-select-wrapper">
  27. <label for="theme-select">Theme:&nbsp;</label>
  28. <select id="theme-select" onchange="setTheme(this.value)">
  29. <option value="auto">🌗 Match OS</option>
  30. <option value="dark">🌑 Dark</option>
  31. <option value="light">🌕 Light</option>
  32. </select>
  33. </div>
  34. <div id="global-links">
  35. <ul class="simple-boot">
  36. <li><a href="manual.html">Manual</a></li>
  37. <li><a href="lib.html">Standard library</a></li>
  38. <li> <a id="indexLink" href="theindex.html">Index</a></li>
  39. <li><a href="compiler/theindex.html">Compiler docs</a></li>
  40. <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
  41. <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
  42. </ul>
  43. </div>
  44. <div id="searchInputDiv">
  45. Search: <input type="search" id="searchInput"
  46. oninput="search()" />
  47. </div>
  48. <ul class="simple simple-toc" id="toc-list">
  49. <li>
  50. <details open>
  51. <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
  52. <ul class="simple simple-toc-section">
  53. <li><a class="reference" href="#Headers" title="Headers = ref object of JsRoot">Headers</a></li>
  54. </ul>
  55. </details>
  56. </li>
  57. <li>
  58. <details open>
  59. <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
  60. <ul class="simple simple-toc-section">
  61. <ul class="simple nested-toc-section">$
  62. <li><a class="reference" href="#%24%2CHeaders" title="`$`(self: Headers): string">`$`(self: Headers): string</a></li>
  63. </ul>
  64. <ul class="simple nested-toc-section">[]
  65. <li><a class="reference" href="#%5B%5D%2CHeaders%2Ccstring" title="`[]`(self: Headers; key: cstring): cstring">`[]`(self: Headers; key: cstring): cstring</a></li>
  66. </ul>
  67. <ul class="simple nested-toc-section">[]=
  68. <li><a class="reference" href="#%5B%5D%3D%2CHeaders%2Ccstring%2Ccstring" title="`[]=`(self: Headers; key: cstring; value: cstring)">`[]=`(self: Headers; key: cstring; value: cstring)</a></li>
  69. </ul>
  70. <ul class="simple nested-toc-section">add
  71. <li><a class="reference" href="#add%2CHeaders%2Ccstring%2Ccstring" title="add(self: Headers; key: cstring; value: cstring)">add(self: Headers; key: cstring; value: cstring)</a></li>
  72. </ul>
  73. <ul class="simple nested-toc-section">clear
  74. <li><a class="reference" href="#clear%2CHeaders" title="clear(self: Headers)">clear(self: Headers)</a></li>
  75. </ul>
  76. <ul class="simple nested-toc-section">delete
  77. <li><a class="reference" href="#delete%2CHeaders%2Ccstring" title="delete(self: Headers; key: cstring)">delete(self: Headers; key: cstring)</a></li>
  78. </ul>
  79. <ul class="simple nested-toc-section">entries
  80. <li><a class="reference" href="#entries%2CHeaders" title="entries(self: Headers): seq[tuple[key, value: cstring]]">entries(self: Headers): seq[tuple[key, value: cstring]]</a></li>
  81. </ul>
  82. <ul class="simple nested-toc-section">hasKey
  83. <li><a class="reference" href="#hasKey%2CHeaders%2Ccstring" title="hasKey(self: Headers; key: cstring): bool">hasKey(self: Headers; key: cstring): bool</a></li>
  84. </ul>
  85. <ul class="simple nested-toc-section">keys
  86. <li><a class="reference" href="#keys%2CHeaders" title="keys(self: Headers): seq[cstring]">keys(self: Headers): seq[cstring]</a></li>
  87. </ul>
  88. <ul class="simple nested-toc-section">len
  89. <li><a class="reference" href="#len%2CHeaders" title="len(self: Headers): int">len(self: Headers): int</a></li>
  90. </ul>
  91. <ul class="simple nested-toc-section">newHeaders
  92. <li><a class="reference" href="#newHeaders" title="newHeaders(): Headers">newHeaders(): Headers</a></li>
  93. </ul>
  94. <ul class="simple nested-toc-section">toCstring
  95. <li><a class="reference" href="#toCstring%2CHeaders" title="toCstring(self: Headers): cstring">toCstring(self: Headers): cstring</a></li>
  96. </ul>
  97. <ul class="simple nested-toc-section">values
  98. <li><a class="reference" href="#values%2CHeaders" title="values(self: Headers): seq[cstring]">values(self: Headers): seq[cstring]</a></li>
  99. </ul>
  100. </ul>
  101. </details>
  102. </li>
  103. </ul>
  104. </div>
  105. <div class="nine columns" id="content">
  106. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsheaders.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  107. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsheaders.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  108. <div id="tocRoot"></div>
  109. <p class="module-desc"><ul class="simple"><li>HTTP Headers for the JavaScript target: <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/API/Headers">https://developer.mozilla.org/en-US/docs/Web/API/Headers</a></li>
  110. </ul>
  111. <p><strong class="examples_text">Example: cmd: -r:off</strong></p>
  112. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">jsheaders</span>
  113. <span class="Keyword">block</span><span class="Punctuation">:</span>
  114. <span class="Keyword">let</span> <span class="Identifier">header</span><span class="Punctuation">:</span> <span class="Identifier">Headers</span> <span class="Operator">=</span> <span class="Identifier">newHeaders</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
  115. <span class="Identifier">header</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="StringLit">&quot;key&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;value&quot;</span><span class="Punctuation">)</span>
  116. <span class="Identifier">assert</span> <span class="Identifier">header</span><span class="Operator">.</span><span class="Identifier">hasKey</span><span class="Punctuation">(</span><span class="StringLit">&quot;key&quot;</span><span class="Punctuation">)</span>
  117. <span class="Identifier">assert</span> <span class="Identifier">header</span><span class="Operator">.</span><span class="Identifier">keys</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;key&quot;</span><span class="Operator">.</span><span class="Identifier">cstring</span><span class="Punctuation">]</span>
  118. <span class="Identifier">assert</span> <span class="Identifier">header</span><span class="Operator">.</span><span class="Identifier">values</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;value&quot;</span><span class="Operator">.</span><span class="Identifier">cstring</span><span class="Punctuation">]</span>
  119. <span class="Identifier">assert</span> <span class="Identifier">header</span><span class="Punctuation">[</span><span class="StringLit">&quot;key&quot;</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="StringLit">&quot;value&quot;</span><span class="Operator">.</span><span class="Identifier">cstring</span>
  120. <span class="Identifier">header</span><span class="Punctuation">[</span><span class="StringLit">&quot;other&quot;</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="StringLit">&quot;another&quot;</span><span class="Operator">.</span><span class="Identifier">cstring</span>
  121. <span class="Identifier">assert</span> <span class="Identifier">header</span><span class="Punctuation">[</span><span class="StringLit">&quot;other&quot;</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="StringLit">&quot;another&quot;</span><span class="Operator">.</span><span class="Identifier">cstring</span>
  122. <span class="Identifier">assert</span> <span class="Identifier">header</span><span class="Operator">.</span><span class="Identifier">entries</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="Punctuation">(</span><span class="StringLit">&quot;key&quot;</span><span class="Operator">.</span><span class="Identifier">cstring</span><span class="Punctuation">,</span> <span class="StringLit">&quot;value&quot;</span><span class="Operator">.</span><span class="Identifier">cstring</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Punctuation">(</span><span class="StringLit">&quot;other&quot;</span><span class="Operator">.</span><span class="Identifier">cstring</span><span class="Punctuation">,</span> <span class="StringLit">&quot;another&quot;</span><span class="Operator">.</span><span class="Identifier">cstring</span><span class="Punctuation">)</span><span class="Punctuation">]</span>
  123. <span class="Identifier">assert</span> <span class="Identifier">header</span><span class="Operator">.</span><span class="Identifier">toCstring</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="LongStringLit">&quot;&quot;&quot;[[&quot;key&quot;,&quot;value&quot;],[&quot;other&quot;,&quot;another&quot;]]&quot;&quot;&quot;</span><span class="Operator">.</span><span class="Identifier">cstring</span>
  124. <span class="Identifier">header</span><span class="Operator">.</span><span class="Identifier">delete</span><span class="Punctuation">(</span><span class="StringLit">&quot;other&quot;</span><span class="Punctuation">)</span>
  125. <span class="Identifier">assert</span> <span class="Identifier">header</span><span class="Operator">.</span><span class="Identifier">entries</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="Punctuation">(</span><span class="StringLit">&quot;key&quot;</span><span class="Operator">.</span><span class="Identifier">cstring</span><span class="Punctuation">,</span> <span class="StringLit">&quot;value&quot;</span><span class="Operator">.</span><span class="Identifier">cstring</span><span class="Punctuation">)</span><span class="Punctuation">]</span>
  126. <span class="Identifier">header</span><span class="Operator">.</span><span class="Identifier">clear</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
  127. <span class="Identifier">assert</span> <span class="Identifier">header</span><span class="Operator">.</span><span class="Identifier">entries</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="Punctuation">]</span>
  128. <span class="Identifier">assert</span> <span class="Identifier">header</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
  129. <span class="Keyword">block</span><span class="Punctuation">:</span>
  130. <span class="Keyword">let</span> <span class="Identifier">header</span><span class="Punctuation">:</span> <span class="Identifier">Headers</span> <span class="Operator">=</span> <span class="Identifier">newHeaders</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
  131. <span class="Identifier">header</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="StringLit">&quot;key&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;a&quot;</span><span class="Punctuation">)</span>
  132. <span class="Identifier">header</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="StringLit">&quot;key&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;b&quot;</span><span class="Punctuation">)</span> <span class="Comment">## Duplicated.</span>
  133. <span class="Identifier">header</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="StringLit">&quot;key&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;c&quot;</span><span class="Punctuation">)</span> <span class="Comment">## Duplicated.</span>
  134. <span class="Identifier">assert</span> <span class="Identifier">header</span><span class="Punctuation">[</span><span class="StringLit">&quot;key&quot;</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="StringLit">&quot;a, b, c&quot;</span><span class="Operator">.</span><span class="Identifier">cstring</span>
  135. <span class="Identifier">header</span><span class="Punctuation">[</span><span class="StringLit">&quot;key&quot;</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="StringLit">&quot;value&quot;</span><span class="Operator">.</span><span class="Identifier">cstring</span>
  136. <span class="Identifier">assert</span> <span class="Identifier">header</span><span class="Punctuation">[</span><span class="StringLit">&quot;key&quot;</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="StringLit">&quot;value&quot;</span><span class="Operator">.</span><span class="Identifier">cstring</span>
  137. <span class="Keyword">block</span><span class="Punctuation">:</span>
  138. <span class="Keyword">let</span> <span class="Identifier">header</span><span class="Punctuation">:</span> <span class="Identifier">Headers</span> <span class="Operator">=</span> <span class="Identifier">newHeaders</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
  139. <span class="Identifier">header</span><span class="Punctuation">[</span><span class="StringLit">&quot;key&quot;</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="StringLit">&quot;a&quot;</span>
  140. <span class="Identifier">header</span><span class="Punctuation">[</span><span class="StringLit">&quot;key&quot;</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="StringLit">&quot;b&quot;</span> <span class="Comment">## Overwrites.</span>
  141. <span class="Identifier">assert</span> <span class="Identifier">header</span><span class="Punctuation">[</span><span class="StringLit">&quot;key&quot;</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="StringLit">&quot;b&quot;</span><span class="Operator">.</span><span class="Identifier">cstring</span></pre></p>
  142. <div class="section" id="7">
  143. <h1><a class="toc-backref" href="#7">Types</a></h1>
  144. <dl class="item">
  145. <div id="Headers">
  146. <dt><pre><a href="jsheaders.html#Headers"><span class="Identifier">Headers</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="system.html#JsRoot"><span class="Identifier">JsRoot</span></a></pre></dt>
  147. <dd>
  148. HTTP Headers API.
  149. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsheaders.nim#L5" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  150. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsheaders.nim#L5" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  151. </dd>
  152. </div>
  153. </dl>
  154. </div>
  155. <div class="section" id="12">
  156. <h1><a class="toc-backref" href="#12">Procs</a></h1>
  157. <dl class="item">
  158. <div id="$-procs-all">
  159. <div id="$,Headers">
  160. <dt><pre><span class="Keyword">func</span> <a href="#%24%2CHeaders"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="jsheaders.html#Headers"><span class="Identifier">Headers</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  161. <dd>
  162. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsheaders.nim#L46" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  163. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsheaders.nim#L46" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  164. </dd>
  165. </div>
  166. </div>
  167. <div id="[]-procs-all">
  168. <div id="[],Headers,cstring">
  169. <dt><pre><span class="Keyword">func</span> <a href="#%5B%5D%2CHeaders%2Ccstring"><span class="Identifier">`[]`</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="jsheaders.html#Headers"><span class="Identifier">Headers</span></a><span class="Other">;</span> <span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a> {.<span class="Identifier">importjs</span><span class="Other">:</span> <span class="StringLit">&quot;#.get(#)&quot;</span><span class="Other">,</span>
  170. <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  171. <dd>
  172. Get <em>all</em> items with <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> from the headers, including duplicated values. <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/API/Headers/get">https://developer.mozilla.org/en-US/docs/Web/API/Headers/get</a>
  173. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsheaders.nim#L31" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  174. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsheaders.nim#L31" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  175. </dd>
  176. </div>
  177. </div>
  178. <div id="[]=-procs-all">
  179. <div id="[]=,Headers,cstring,cstring">
  180. <dt><pre><span class="Keyword">func</span> <a href="#%5B%5D%3D%2CHeaders%2Ccstring%2Ccstring"><span class="Identifier">`[]=`</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="jsheaders.html#Headers"><span class="Identifier">Headers</span></a><span class="Other">;</span> <span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">;</span> <span class="Identifier">value</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">)</span> {.
  181. <span class="Identifier">importjs</span><span class="Other">:</span> <span class="StringLit">&quot;#.set(#, #)&quot;</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  182. <dd>
  183. Do <em>not</em> allow duplicated keys, overwrites duplicated keys. <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/API/Headers/set">https://developer.mozilla.org/en-US/docs/Web/API/Headers/set</a>
  184. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsheaders.nim#L35" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  185. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsheaders.nim#L35" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  186. </dd>
  187. </div>
  188. </div>
  189. <div id="add-procs-all">
  190. <div id="add,Headers,cstring,cstring">
  191. <dt><pre><span class="Keyword">func</span> <a href="#add%2CHeaders%2Ccstring%2Ccstring"><span class="Identifier">add</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="jsheaders.html#Headers"><span class="Identifier">Headers</span></a><span class="Other">;</span> <span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">;</span> <span class="Identifier">value</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">)</span> {.
  192. <span class="Identifier">importjs</span><span class="Other">:</span> <span class="StringLit">&quot;#.append(#, #)&quot;</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  193. <dd>
  194. Allows duplicated keys. <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/API/Headers/append">https://developer.mozilla.org/en-US/docs/Web/API/Headers/append</a>
  195. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsheaders.nim#L10" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  196. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsheaders.nim#L10" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  197. </dd>
  198. </div>
  199. </div>
  200. <div id="clear-procs-all">
  201. <div id="clear,Headers">
  202. <dt><pre><span class="Keyword">func</span> <a href="#clear%2CHeaders"><span class="Identifier">clear</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="jsheaders.html#Headers"><span class="Identifier">Headers</span></a><span class="Other">)</span> {.<span class="Identifier">importjs</span><span class="Other">:</span> <span class="StringLit">&quot;(() =&gt; { const header = #; Array.from(header.keys()).forEach((key) =&gt; header.delete(key)) })()&quot;</span><span class="Other">,</span>
  203. <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  204. <dd>
  205. Convenience func to delete all items from <tt class="docutils literal"><span class="pre"><span class="Identifier">Headers</span></span></tt>.
  206. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsheaders.nim#L39" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  207. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsheaders.nim#L39" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  208. </dd>
  209. </div>
  210. </div>
  211. <div id="delete-procs-all">
  212. <div id="delete,Headers,cstring">
  213. <dt><pre><span class="Keyword">func</span> <a href="#delete%2CHeaders%2Ccstring"><span class="Identifier">delete</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="jsheaders.html#Headers"><span class="Identifier">Headers</span></a><span class="Other">;</span> <span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">)</span> {.<span class="Identifier">importjs</span><span class="Other">:</span> <span class="StringLit">&quot;#.$1(#)&quot;</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
  214. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  215. <dd>
  216. <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/API/Headers/delete">https://developer.mozilla.org/en-US/docs/Web/API/Headers/delete</a><div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
  217. Delete <em>all</em> items with <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> from the headers, including duplicated keys.</div>
  218. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsheaders.nim#L14" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  219. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsheaders.nim#L14" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  220. </dd>
  221. </div>
  222. </div>
  223. <div id="entries-procs-all">
  224. <div id="entries,Headers">
  225. <dt><pre><span class="Keyword">func</span> <a href="#entries%2CHeaders"><span class="Identifier">entries</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="jsheaders.html#Headers"><span class="Identifier">Headers</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">key</span><span class="Other">,</span> <span class="Identifier">value</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">]</span><span class="Other">]</span> {.
  226. <span class="Identifier">importjs</span><span class="Other">:</span> <span class="StringLit">&quot;Array.from(#.$1())&quot;</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  227. <dd>
  228. <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/API/Headers/entries">https://developer.mozilla.org/en-US/docs/Web/API/Headers/entries</a>
  229. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsheaders.nim#L28" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  230. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsheaders.nim#L28" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  231. </dd>
  232. </div>
  233. </div>
  234. <div id="hasKey-procs-all">
  235. <div id="hasKey,Headers,cstring">
  236. <dt><pre><span class="Keyword">func</span> <a href="#hasKey%2CHeaders%2Ccstring"><span class="Identifier">hasKey</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="jsheaders.html#Headers"><span class="Identifier">Headers</span></a><span class="Other">;</span> <span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">importjs</span><span class="Other">:</span> <span class="StringLit">&quot;#.has(#)&quot;</span><span class="Other">,</span>
  237. <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  238. <dd>
  239. <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/API/Headers/has">https://developer.mozilla.org/en-US/docs/Web/API/Headers/has</a>
  240. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsheaders.nim#L19" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  241. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsheaders.nim#L19" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  242. </dd>
  243. </div>
  244. </div>
  245. <div id="keys-procs-all">
  246. <div id="keys,Headers">
  247. <dt><pre><span class="Keyword">func</span> <a href="#keys%2CHeaders"><span class="Identifier">keys</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="jsheaders.html#Headers"><span class="Identifier">Headers</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">]</span> {.<span class="Identifier">importjs</span><span class="Other">:</span> <span class="StringLit">&quot;Array.from(#.$1())&quot;</span><span class="Other">,</span>
  248. <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  249. <dd>
  250. <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/API/Headers/keys">https://developer.mozilla.org/en-US/docs/Web/API/Headers/keys</a>
  251. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsheaders.nim#L22" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  252. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsheaders.nim#L22" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  253. </dd>
  254. </div>
  255. </div>
  256. <div id="len-procs-all">
  257. <div id="len,Headers">
  258. <dt><pre><span class="Keyword">func</span> <a href="#len%2CHeaders"><span class="Identifier">len</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="jsheaders.html#Headers"><span class="Identifier">Headers</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">importjs</span><span class="Other">:</span> <span class="StringLit">&quot;Array.from(#.entries()).length&quot;</span><span class="Other">,</span>
  259. <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  260. <dd>
  261. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsheaders.nim#L48" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  262. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsheaders.nim#L48" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  263. </dd>
  264. </div>
  265. </div>
  266. <div id="newHeaders-procs-all">
  267. <div id="newHeaders">
  268. <dt><pre><span class="Keyword">func</span> <a href="#newHeaders"><span class="Identifier">newHeaders</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="jsheaders.html#Headers"><span class="Identifier">Headers</span></a> {.<span class="Identifier">importjs</span><span class="Other">:</span> <span class="StringLit">&quot;new Headers()&quot;</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
  269. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  270. <dd>
  271. <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/API/Headers">https://developer.mozilla.org/en-US/docs/Web/API/Headers</a>
  272. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsheaders.nim#L7" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  273. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsheaders.nim#L7" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  274. </dd>
  275. </div>
  276. </div>
  277. <div id="toCstring-procs-all">
  278. <div id="toCstring,Headers">
  279. <dt><pre><span class="Keyword">func</span> <a href="#toCstring%2CHeaders"><span class="Identifier">toCstring</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="jsheaders.html#Headers"><span class="Identifier">Headers</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a> {.
  280. <span class="Identifier">importjs</span><span class="Other">:</span> <span class="StringLit">&quot;JSON.stringify(Array.from(#.entries()))&quot;</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
  281. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  282. <dd>
  283. Returns a <tt class="docutils literal"><span class="pre"><span class="Identifier">cstring</span></span></tt> representation of <tt class="docutils literal"><span class="pre"><span class="Identifier">Headers</span></span></tt>.
  284. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsheaders.nim#L43" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  285. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsheaders.nim#L43" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  286. </dd>
  287. </div>
  288. </div>
  289. <div id="values-procs-all">
  290. <div id="values,Headers">
  291. <dt><pre><span class="Keyword">func</span> <a href="#values%2CHeaders"><span class="Identifier">values</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="jsheaders.html#Headers"><span class="Identifier">Headers</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">]</span> {.<span class="Identifier">importjs</span><span class="Other">:</span> <span class="StringLit">&quot;Array.from(#.$1())&quot;</span><span class="Other">,</span>
  292. <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  293. <dd>
  294. <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/API/Headers/values">https://developer.mozilla.org/en-US/docs/Web/API/Headers/values</a>
  295. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsheaders.nim#L25" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  296. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsheaders.nim#L25" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  297. </dd>
  298. </div>
  299. </div>
  300. </dl>
  301. </div>
  302. </div>
  303. </div>
  304. <div class="twelve-columns footer">
  305. <span class="nim-sprite"></span>
  306. <br>
  307. <small style="color: var(--hint);">Made with Nim. Generated: 2025-02-03 14:57:27 UTC</small>
  308. </div>
  309. </div>
  310. </div>
  311. <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
  312. </body>
  313. </html>