123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589 |
- <?xml version="1.0" encoding="utf-8" ?>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <!-- This file is generated by Nim. -->
- <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>std/jsfetch</title>
- <!-- Google fonts -->
- <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
- <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
- <!-- Favicon -->
- <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=="/>
- <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=">
- <!-- CSS -->
- <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
- <!-- JS -->
- <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
- </head>
- <body>
- <div class="document" id="documentId">
- <div class="container">
- <h1 class="title">std/jsfetch</h1>
- <div class="row">
- <div class="three columns">
- <div class="theme-select-wrapper">
- <label for="theme-select">Theme: </label>
- <select id="theme-select" onchange="setTheme(this.value)">
- <option value="auto">🌗 Match OS</option>
- <option value="dark">🌑 Dark</option>
- <option value="light">🌕 Light</option>
- </select>
- </div>
- <div id="global-links">
- <ul class="simple-boot">
- <li><a href="manual.html">Manual</a></li>
- <li><a href="lib.html">Standard library</a></li>
- <li> <a id="indexLink" href="theindex.html">Index</a></li>
- <li><a href="compiler/theindex.html">Compiler docs</a></li>
- <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
- <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
- </ul>
- </div>
- <div id="searchInputDiv">
- Search: <input type="search" id="searchInput"
- oninput="search()" />
- </div>
-
- <ul class="simple simple-toc" id="toc-list">
- <li>
- <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
- </li>
- <li>
- <details open>
- <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
- <ul class="simple simple-toc-section">
- <li><a class="reference" href="#FetchCaches" title="FetchCaches = enum
- fchDefault = "default", fchNoStore = "no-store", fchReload = "reload",
- fchNoCache = "no-cache", fchForceCache = "force-cache"">FetchCaches</a></li>
- <li><a class="reference" href="#FetchCredentials" title="FetchCredentials = enum
- fcInclude = "include", fcSameOrigin = "same-origin", fcOmit = "omit"">FetchCredentials</a></li>
- <li><a class="reference" href="#FetchModes" title="FetchModes = enum
- fmCors = "cors", fmNoCors = "no-cors", fmSameOrigin = "same-origin"">FetchModes</a></li>
- <li><a class="reference" href="#FetchOptions" title="FetchOptions = ref object of JsRoot
- keepalive*: bool
- metod* {.importjs: "method".}: cstring
- body*, integrity*, referrer*, mode*, credentials*, cache*, redirect*,
- referrerPolicy*: cstring
- headers*: Headers">FetchOptions</a></li>
- <li><a class="reference" href="#FetchRedirects" title="FetchRedirects = enum
- frFollow = "follow", frError = "error", frManual = "manual"">FetchRedirects</a></li>
- <li><a class="reference" href="#FetchReferrerPolicies" title="FetchReferrerPolicies = enum
- frpNoReferrer = "no-referrer",
- frpNoReferrerWhenDowngrade = "no-referrer-when-downgrade",
- frpOrigin = "origin", frpOriginWhenCrossOrigin = "origin-when-cross-origin",
- frpUnsafeUrl = "unsafe-url"">FetchReferrerPolicies</a></li>
- <li><a class="reference" href="#Request" title="Request = ref object of JsRoot
- bodyUsed*, ok*, redirected*: bool
- typ* {.importjs: "type".}: cstring
- url*, statusText*: cstring
- status*: cint
- headers*: Headers
- body*: cstring">Request</a></li>
- <li><a class="reference" href="#Response" title="Response = ref object of JsRoot
- bodyUsed*, ok*, redirected*: bool
- typ* {.importjs: "type".}: cstring
- url*, statusText*: cstring
- status*: cint
- headers*: Headers
- body*: cstring">Response</a></li>
- </ul>
- </details>
- </li>
- <li>
- <details open>
- <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
- <ul class="simple simple-toc-section">
- <ul class="simple nested-toc-section">$
- <li><a class="reference" href="#%24" title="`$`(self: Request | Response | FetchOptions): string">`$`(self: Request | Response | FetchOptions): string</a></li>
- </ul>
- <ul class="simple nested-toc-section">clone
- <li><a class="reference" href="#clone" title="clone(self: Response | Request): Response">clone(self: Response | Request): Response</a></li>
- </ul>
- <ul class="simple nested-toc-section">fetch
- <li><a class="reference" href="#fetch" title="fetch(url: cstring | Request): Future[Response]">fetch(url: cstring | Request): Future[Response]</a></li>
- <li><a class="reference" href="#fetch%2C%2CFetchOptions" title="fetch(url: cstring | Request; options: FetchOptions): Future[Response]">fetch(url: cstring | Request; options: FetchOptions): Future[Response]</a></li>
- </ul>
- <ul class="simple nested-toc-section">formData
- <li><a class="reference" href="#formData%2CResponse" title="formData(self: Response): Future[FormData]">formData(self: Response): Future[FormData]</a></li>
- </ul>
- <ul class="simple nested-toc-section">json
- <li><a class="reference" href="#json%2CResponse" title="json(self: Response): Future[JsObject]">json(self: Response): Future[JsObject]</a></li>
- </ul>
- <ul class="simple nested-toc-section">newfetchOptions
- <li><a class="reference" href="#newfetchOptions%2Ccstring%2CHeaders" title="newfetchOptions(metod = HttpGet; body: cstring = nil; mode = fmCors;
- credentials = fcSameOrigin; cache = fchDefault;
- referrerPolicy = frpNoReferrerWhenDowngrade; keepalive = false;
- redirect = frFollow; referrer = "client".cstring;
- integrity = "".cstring; headers: Headers = newHeaders()): FetchOptions">newfetchOptions(metod = HttpGet; body: cstring = nil; mode = fmCors;
- credentials = fcSameOrigin; cache = fchDefault;
- referrerPolicy = frpNoReferrerWhenDowngrade; keepalive = false;
- redirect = frFollow; referrer = "client".cstring;
- integrity = "".cstring; headers: Headers = newHeaders()): FetchOptions</a></li>
- </ul>
- <ul class="simple nested-toc-section">newRequest
- <li><a class="reference" href="#newRequest%2Ccstring" title="newRequest(url: cstring): Request">newRequest(url: cstring): Request</a></li>
- <li><a class="reference" href="#newRequest%2Ccstring%2CFetchOptions" title="newRequest(url: cstring; fetchOptions: FetchOptions): Request">newRequest(url: cstring; fetchOptions: FetchOptions): Request</a></li>
- </ul>
- <ul class="simple nested-toc-section">newResponse
- <li><a class="reference" href="#newResponse" title="newResponse(body: cstring | FormData): Response">newResponse(body: cstring | FormData): Response</a></li>
- </ul>
- <ul class="simple nested-toc-section">text
- <li><a class="reference" href="#text%2CResponse" title="text(self: Response): Future[cstring]">text(self: Response): Future[cstring]</a></li>
- </ul>
- <ul class="simple nested-toc-section">toCstring
- <li><a class="reference" href="#toCstring" title="toCstring(self: Request | Response | FetchOptions): cstring">toCstring(self: Request | Response | FetchOptions): cstring</a></li>
- </ul>
- <ul class="simple nested-toc-section">unsafeNewFetchOptions
- <li><a class="reference" href="#unsafeNewFetchOptions%2Ccstring%2Ccstring%2Ccstring%2Ccstring%2Ccstring%2Ccstring%2Cbool%2CHeaders" title="unsafeNewFetchOptions(metod, body, mode, credentials, cache, referrerPolicy: cstring;
- keepalive: bool; redirect = "follow".cstring;
- referrer = "client".cstring; integrity = "".cstring;
- headers: Headers = newHeaders()): FetchOptions">unsafeNewFetchOptions(metod, body, mode, credentials, cache, referrerPolicy: cstring;
- keepalive: bool; redirect = "follow".cstring;
- referrer = "client".cstring; integrity = "".cstring;
- headers: Headers = newHeaders()): FetchOptions</a></li>
- </ul>
- </ul>
- </details>
- </li>
- </ul>
- </div>
- <div class="nine columns" id="content">
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsfetch.nim#L1" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsfetch.nim#L1" class="link-seesrc" target="_blank" >Edit</a>
- <div id="tocRoot"></div>
-
- <p class="module-desc"><ul class="simple"><li>Fetch for the JavaScript target: <a class="reference external" href="https://developer.mozilla.org/docs/Web/API/Fetch_API">https://developer.mozilla.org/docs/Web/API/Fetch_API</a></li>
- </ul>
- <p><strong class="examples_text">Example: cmd: -r:off</strong></p>
- <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">jsfetch</span>
- <span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Punctuation">[</span><span class="Identifier">asyncjs</span><span class="Punctuation">,</span> <span class="Identifier">jsconsole</span><span class="Punctuation">,</span> <span class="Identifier">jsformdata</span><span class="Punctuation">,</span> <span class="Identifier">jsheaders</span><span class="Punctuation">]</span>
- <span class="Keyword">from</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">httpcore</span> <span class="Keyword">import</span> <span class="Identifier">HttpMethod</span>
- <span class="Keyword">from</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">jsffi</span> <span class="Keyword">import</span> <span class="Identifier">JsObject</span>
- <span class="Keyword">from</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">sugar</span> <span class="Keyword">import</span> <span class="Punctuation">`</span><span class="Operator">=></span><span class="Punctuation">`</span>
- <span class="Keyword">block</span><span class="Punctuation">:</span>
- <span class="Keyword">let</span> <span class="Identifier">options0</span><span class="Punctuation">:</span> <span class="Identifier">FetchOptions</span> <span class="Operator">=</span> <span class="Identifier">unsafeNewFetchOptions</span><span class="Punctuation">(</span>
- <span class="Identifier">metod</span> <span class="Operator">=</span> <span class="StringLit">"POST"</span><span class="Operator">.</span><span class="Identifier">cstring</span><span class="Punctuation">,</span>
- <span class="Identifier">body</span> <span class="Operator">=</span> <span class="LongStringLit">"""{"key": "value"}"""</span><span class="Operator">.</span><span class="Identifier">cstring</span><span class="Punctuation">,</span>
- <span class="Identifier">mode</span> <span class="Operator">=</span> <span class="StringLit">"no-cors"</span><span class="Operator">.</span><span class="Identifier">cstring</span><span class="Punctuation">,</span>
- <span class="Identifier">credentials</span> <span class="Operator">=</span> <span class="StringLit">"omit"</span><span class="Operator">.</span><span class="Identifier">cstring</span><span class="Punctuation">,</span>
- <span class="Identifier">cache</span> <span class="Operator">=</span> <span class="StringLit">"no-cache"</span><span class="Operator">.</span><span class="Identifier">cstring</span><span class="Punctuation">,</span>
- <span class="Identifier">referrerPolicy</span> <span class="Operator">=</span> <span class="StringLit">"no-referrer"</span><span class="Operator">.</span><span class="Identifier">cstring</span><span class="Punctuation">,</span>
- <span class="Identifier">keepalive</span> <span class="Operator">=</span> <span class="Identifier">false</span><span class="Punctuation">,</span>
- <span class="Identifier">redirect</span> <span class="Operator">=</span> <span class="StringLit">"follow"</span><span class="Operator">.</span><span class="Identifier">cstring</span><span class="Punctuation">,</span>
- <span class="Identifier">referrer</span> <span class="Operator">=</span> <span class="StringLit">"client"</span><span class="Operator">.</span><span class="Identifier">cstring</span><span class="Punctuation">,</span>
- <span class="Identifier">integrity</span> <span class="Operator">=</span> <span class="StringLit">""</span><span class="Operator">.</span><span class="Identifier">cstring</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>
- <span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">options0</span><span class="Operator">.</span><span class="Identifier">keepalive</span> <span class="Operator">==</span> <span class="Identifier">false</span>
- <span class="Identifier">assert</span> <span class="Identifier">options0</span><span class="Operator">.</span><span class="Identifier">metod</span> <span class="Operator">==</span> <span class="StringLit">"POST"</span><span class="Operator">.</span><span class="Identifier">cstring</span>
- <span class="Identifier">assert</span> <span class="Identifier">options0</span><span class="Operator">.</span><span class="Identifier">body</span> <span class="Operator">==</span> <span class="LongStringLit">"""{"key": "value"}"""</span><span class="Operator">.</span><span class="Identifier">cstring</span>
- <span class="Identifier">assert</span> <span class="Identifier">options0</span><span class="Operator">.</span><span class="Identifier">mode</span> <span class="Operator">==</span> <span class="StringLit">"no-cors"</span><span class="Operator">.</span><span class="Identifier">cstring</span>
- <span class="Identifier">assert</span> <span class="Identifier">options0</span><span class="Operator">.</span><span class="Identifier">credentials</span> <span class="Operator">==</span> <span class="StringLit">"omit"</span><span class="Operator">.</span><span class="Identifier">cstring</span>
- <span class="Identifier">assert</span> <span class="Identifier">options0</span><span class="Operator">.</span><span class="Identifier">cache</span> <span class="Operator">==</span> <span class="StringLit">"no-cache"</span><span class="Operator">.</span><span class="Identifier">cstring</span>
- <span class="Identifier">assert</span> <span class="Identifier">options0</span><span class="Operator">.</span><span class="Identifier">referrerPolicy</span> <span class="Operator">==</span> <span class="StringLit">"no-referrer"</span><span class="Operator">.</span><span class="Identifier">cstring</span>
- <span class="Identifier">assert</span> <span class="Identifier">options0</span><span class="Operator">.</span><span class="Identifier">redirect</span> <span class="Operator">==</span> <span class="StringLit">"follow"</span><span class="Operator">.</span><span class="Identifier">cstring</span>
- <span class="Identifier">assert</span> <span class="Identifier">options0</span><span class="Operator">.</span><span class="Identifier">referrer</span> <span class="Operator">==</span> <span class="StringLit">"client"</span><span class="Operator">.</span><span class="Identifier">cstring</span>
- <span class="Identifier">assert</span> <span class="Identifier">options0</span><span class="Operator">.</span><span class="Identifier">integrity</span> <span class="Operator">==</span> <span class="StringLit">""</span><span class="Operator">.</span><span class="Identifier">cstring</span>
- <span class="Identifier">assert</span> <span class="Identifier">options0</span><span class="Operator">.</span><span class="Identifier">headers</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
- <span class="Keyword">block</span><span class="Punctuation">:</span>
- <span class="Keyword">let</span> <span class="Identifier">options1</span><span class="Punctuation">:</span> <span class="Identifier">FetchOptions</span> <span class="Operator">=</span> <span class="Identifier">newFetchOptions</span><span class="Punctuation">(</span>
- <span class="Identifier">metod</span> <span class="Operator">=</span> <span class="Identifier">HttpPost</span><span class="Punctuation">,</span>
- <span class="Identifier">body</span> <span class="Operator">=</span> <span class="LongStringLit">"""{"key": "value"}"""</span><span class="Operator">.</span><span class="Identifier">cstring</span><span class="Punctuation">,</span>
- <span class="Identifier">mode</span> <span class="Operator">=</span> <span class="Identifier">fmNoCors</span><span class="Punctuation">,</span>
- <span class="Identifier">credentials</span> <span class="Operator">=</span> <span class="Identifier">fcOmit</span><span class="Punctuation">,</span>
- <span class="Identifier">cache</span> <span class="Operator">=</span> <span class="Identifier">fchNoCache</span><span class="Punctuation">,</span>
- <span class="Identifier">referrerPolicy</span> <span class="Operator">=</span> <span class="Identifier">frpNoReferrer</span><span class="Punctuation">,</span>
- <span class="Identifier">keepalive</span> <span class="Operator">=</span> <span class="Identifier">false</span><span class="Punctuation">,</span>
- <span class="Identifier">redirect</span> <span class="Operator">=</span> <span class="Identifier">frFollow</span><span class="Punctuation">,</span>
- <span class="Identifier">referrer</span> <span class="Operator">=</span> <span class="StringLit">"client"</span><span class="Operator">.</span><span class="Identifier">cstring</span><span class="Punctuation">,</span>
- <span class="Identifier">integrity</span> <span class="Operator">=</span> <span class="StringLit">""</span><span class="Operator">.</span><span class="Identifier">cstring</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>
- <span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">options1</span><span class="Operator">.</span><span class="Identifier">keepalive</span> <span class="Operator">==</span> <span class="Identifier">false</span>
- <span class="Identifier">assert</span> <span class="Identifier">options1</span><span class="Operator">.</span><span class="Identifier">metod</span> <span class="Operator">==</span> <span class="Operator">$</span><span class="Identifier">HttpPost</span>
- <span class="Identifier">assert</span> <span class="Identifier">options1</span><span class="Operator">.</span><span class="Identifier">body</span> <span class="Operator">==</span> <span class="LongStringLit">"""{"key": "value"}"""</span><span class="Operator">.</span><span class="Identifier">cstring</span>
- <span class="Identifier">assert</span> <span class="Identifier">options1</span><span class="Operator">.</span><span class="Identifier">mode</span> <span class="Operator">==</span> <span class="Operator">$</span><span class="Identifier">fmNoCors</span>
- <span class="Identifier">assert</span> <span class="Identifier">options1</span><span class="Operator">.</span><span class="Identifier">credentials</span> <span class="Operator">==</span> <span class="Operator">$</span><span class="Identifier">fcOmit</span>
- <span class="Identifier">assert</span> <span class="Identifier">options1</span><span class="Operator">.</span><span class="Identifier">cache</span> <span class="Operator">==</span> <span class="Operator">$</span><span class="Identifier">fchNoCache</span>
- <span class="Identifier">assert</span> <span class="Identifier">options1</span><span class="Operator">.</span><span class="Identifier">referrerPolicy</span> <span class="Operator">==</span> <span class="Operator">$</span><span class="Identifier">frpNoReferrer</span>
- <span class="Identifier">assert</span> <span class="Identifier">options1</span><span class="Operator">.</span><span class="Identifier">redirect</span> <span class="Operator">==</span> <span class="Operator">$</span><span class="Identifier">frFollow</span>
- <span class="Identifier">assert</span> <span class="Identifier">options1</span><span class="Operator">.</span><span class="Identifier">referrer</span> <span class="Operator">==</span> <span class="StringLit">"client"</span><span class="Operator">.</span><span class="Identifier">cstring</span>
- <span class="Identifier">assert</span> <span class="Identifier">options1</span><span class="Operator">.</span><span class="Identifier">integrity</span> <span class="Operator">==</span> <span class="StringLit">""</span><span class="Operator">.</span><span class="Identifier">cstring</span>
- <span class="Identifier">assert</span> <span class="Identifier">options1</span><span class="Operator">.</span><span class="Identifier">headers</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
- <span class="Keyword">block</span><span class="Punctuation">:</span>
- <span class="Keyword">let</span> <span class="Identifier">response</span><span class="Punctuation">:</span> <span class="Identifier">Response</span> <span class="Operator">=</span> <span class="Identifier">newResponse</span><span class="Punctuation">(</span><span class="Identifier">body</span> <span class="Operator">=</span> <span class="StringLit">"-. .. --"</span><span class="Operator">.</span><span class="Identifier">cstring</span><span class="Punctuation">)</span>
- <span class="Keyword">let</span> <span class="Identifier">request</span><span class="Punctuation">:</span> <span class="Identifier">Request</span> <span class="Operator">=</span> <span class="Identifier">newRequest</span><span class="Punctuation">(</span><span class="Identifier">url</span> <span class="Operator">=</span> <span class="StringLit">"http://nim-lang.org"</span><span class="Operator">.</span><span class="Identifier">cstring</span><span class="Punctuation">)</span>
- <span class="Keyword">if</span> <span class="Keyword">not</span> <span class="Identifier">defined</span><span class="Punctuation">(</span><span class="Identifier">nodejs</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Keyword">block</span><span class="Punctuation">:</span>
- <span class="Keyword">proc</span> <span class="Identifier">doFetch</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">Future</span><span class="Punctuation">[</span><span class="Identifier">Response</span><span class="Punctuation">]</span> <span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">async</span><span class="Operator">.</span><span class="Punctuation">}</span> <span class="Operator">=</span>
- <span class="Identifier">fetch</span> <span class="StringLit">"https://httpbin.org/get"</span><span class="Operator">.</span><span class="Identifier">cstring</span>
- <span class="Keyword">proc</span> <span class="Identifier">example</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">async</span><span class="Operator">.</span><span class="Punctuation">}</span> <span class="Operator">=</span>
- <span class="Keyword">let</span> <span class="Identifier">response</span><span class="Punctuation">:</span> <span class="Identifier">Response</span> <span class="Operator">=</span> <span class="Identifier">await</span> <span class="Identifier">doFetch</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">response</span><span class="Operator">.</span><span class="Identifier">ok</span>
- <span class="Identifier">assert</span> <span class="Identifier">response</span><span class="Operator">.</span><span class="Identifier">status</span> <span class="Operator">==</span> <span class="FloatNumber">200.</span><span class="Identifier">cint</span>
- <span class="Identifier">assert</span> <span class="Identifier">response</span><span class="Operator">.</span><span class="Identifier">headers</span> <span class="Keyword">is</span> <span class="Identifier">Headers</span>
- <span class="Identifier">assert</span> <span class="Identifier">response</span><span class="Operator">.</span><span class="Identifier">body</span> <span class="Keyword">is</span> <span class="Identifier">cstring</span>
- <span class="Keyword">discard</span> <span class="Identifier">example</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
- <span class="Keyword">block</span><span class="Punctuation">:</span>
- <span class="Keyword">proc</span> <span class="Identifier">example2</span> <span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">async</span><span class="Operator">.</span><span class="Punctuation">}</span> <span class="Operator">=</span>
- <span class="Identifier">await</span> <span class="Identifier">fetch</span><span class="Punctuation">(</span><span class="StringLit">"https://api.github.com/users/torvalds"</span><span class="Operator">.</span><span class="Identifier">cstring</span><span class="Punctuation">)</span>
- <span class="Operator">.</span><span class="Identifier">then</span><span class="Punctuation">(</span><span class="Punctuation">(</span><span class="Identifier">response</span><span class="Punctuation">:</span> <span class="Identifier">Response</span><span class="Punctuation">)</span> <span class="Operator">=></span> <span class="Identifier">response</span><span class="Operator">.</span><span class="Identifier">json</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
- <span class="Operator">.</span><span class="Identifier">then</span><span class="Punctuation">(</span><span class="Punctuation">(</span><span class="Identifier">json</span><span class="Punctuation">:</span> <span class="Identifier">JsObject</span><span class="Punctuation">)</span> <span class="Operator">=></span> <span class="Identifier">console</span><span class="Operator">.</span><span class="Identifier">log</span><span class="Punctuation">(</span><span class="Identifier">json</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
- <span class="Operator">.</span><span class="Identifier">catch</span><span class="Punctuation">(</span><span class="Punctuation">(</span><span class="Identifier">err</span><span class="Punctuation">:</span> <span class="Identifier">Error</span><span class="Punctuation">)</span> <span class="Operator">=></span> <span class="Identifier">console</span><span class="Operator">.</span><span class="Identifier">log</span><span class="Punctuation">(</span><span class="StringLit">"Request Failed"</span><span class="Punctuation">,</span> <span class="Identifier">err</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
- <span class="Keyword">discard</span> <span class="Identifier">example2</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
- <div class="section" id="6">
- <h1><a class="toc-backref" href="#6">Imports</a></h1>
- <dl class="item">
- <a class="reference external" href="asyncjs.html">asyncjs</a>, <a class="reference external" href="jsformdata.html">jsformdata</a>, <a class="reference external" href="jsheaders.html">jsheaders</a>, <a class="reference external" href="httpcore.html">httpcore</a>, <a class="reference external" href="jsffi.html">jsffi</a>
- </dl>
- </div>
- <div class="section" id="7">
- <h1><a class="toc-backref" href="#7">Types</a></h1>
- <dl class="item">
- <div id="FetchCaches">
- <dt><pre><a href="jsfetch.html#FetchCaches"><span class="Identifier">FetchCaches</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
- <span class="Identifier">fchDefault</span> <span class="Other">=</span> <span class="StringLit">"default"</span><span class="Other">,</span> <span class="Identifier">fchNoStore</span> <span class="Other">=</span> <span class="StringLit">"no-store"</span><span class="Other">,</span> <span class="Identifier">fchReload</span> <span class="Other">=</span> <span class="StringLit">"reload"</span><span class="Other">,</span>
- <span class="Identifier">fchNoCache</span> <span class="Other">=</span> <span class="StringLit">"no-cache"</span><span class="Other">,</span> <span class="Identifier">fchForceCache</span> <span class="Other">=</span> <span class="StringLit">"force-cache"</span></pre></dt>
- <dd>
-
- <a class="reference external" href="https://developer.mozilla.org/docs/Web/API/Request/cache">https://developer.mozilla.org/docs/Web/API/Request/cache</a>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsfetch.nim#L27" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsfetch.nim#L27" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="FetchCredentials">
- <dt><pre><a href="jsfetch.html#FetchCredentials"><span class="Identifier">FetchCredentials</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
- <span class="Identifier">fcInclude</span> <span class="Other">=</span> <span class="StringLit">"include"</span><span class="Other">,</span> <span class="Identifier">fcSameOrigin</span> <span class="Other">=</span> <span class="StringLit">"same-origin"</span><span class="Other">,</span> <span class="Identifier">fcOmit</span> <span class="Other">=</span> <span class="StringLit">"omit"</span></pre></dt>
- <dd>
-
- Credential options. See <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials">https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials</a>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsfetch.nim#L22" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsfetch.nim#L22" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="FetchModes">
- <dt><pre><a href="jsfetch.html#FetchModes"><span class="Identifier">FetchModes</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
- <span class="Identifier">fmCors</span> <span class="Other">=</span> <span class="StringLit">"cors"</span><span class="Other">,</span> <span class="Identifier">fmNoCors</span> <span class="Other">=</span> <span class="StringLit">"no-cors"</span><span class="Other">,</span> <span class="Identifier">fmSameOrigin</span> <span class="Other">=</span> <span class="StringLit">"same-origin"</span></pre></dt>
- <dd>
-
- Mode options.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsfetch.nim#L17" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsfetch.nim#L17" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="FetchOptions">
- <dt><pre><a href="jsfetch.html#FetchOptions"><span class="Identifier">FetchOptions</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>
- <span class="Identifier">keepalive</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a>
- <span class="Identifier">metod</span><span class="Operator">*</span> {.<span class="Identifier">importjs</span><span class="Other">:</span> <span class="StringLit">"method"</span>.}<span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a>
- <span class="Identifier">body</span><span class="Operator">*</span><span class="Other">,</span> <span class="Identifier">integrity</span><span class="Operator">*</span><span class="Other">,</span> <span class="Identifier">referrer</span><span class="Operator">*</span><span class="Other">,</span> <span class="Identifier">mode</span><span class="Operator">*</span><span class="Other">,</span> <span class="Identifier">credentials</span><span class="Operator">*</span><span class="Other">,</span> <span class="Identifier">cache</span><span class="Operator">*</span><span class="Other">,</span> <span class="Identifier">redirect</span><span class="Operator">*</span><span class="Other">,</span>
- <span class="Identifier">referrerPolicy</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a>
- <span class="Identifier">headers</span><span class="Operator">*</span><span class="Other">:</span> <a href="jsheaders.html#Headers"><span class="Identifier">Headers</span></a></pre></dt>
- <dd>
-
- Options for Fetch API.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsfetch.nim#L11" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsfetch.nim#L11" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="FetchRedirects">
- <dt><pre><a href="jsfetch.html#FetchRedirects"><span class="Identifier">FetchRedirects</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
- <span class="Identifier">frFollow</span> <span class="Other">=</span> <span class="StringLit">"follow"</span><span class="Other">,</span> <span class="Identifier">frError</span> <span class="Other">=</span> <span class="StringLit">"error"</span><span class="Other">,</span> <span class="Identifier">frManual</span> <span class="Other">=</span> <span class="StringLit">"manual"</span></pre></dt>
- <dd>
-
- Redirects options.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsfetch.nim#L34" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsfetch.nim#L34" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="FetchReferrerPolicies">
- <dt><pre><a href="jsfetch.html#FetchReferrerPolicies"><span class="Identifier">FetchReferrerPolicies</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
- <span class="Identifier">frpNoReferrer</span> <span class="Other">=</span> <span class="StringLit">"no-referrer"</span><span class="Other">,</span>
- <span class="Identifier">frpNoReferrerWhenDowngrade</span> <span class="Other">=</span> <span class="StringLit">"no-referrer-when-downgrade"</span><span class="Other">,</span>
- <span class="Identifier">frpOrigin</span> <span class="Other">=</span> <span class="StringLit">"origin"</span><span class="Other">,</span> <span class="Identifier">frpOriginWhenCrossOrigin</span> <span class="Other">=</span> <span class="StringLit">"origin-when-cross-origin"</span><span class="Other">,</span>
- <span class="Identifier">frpUnsafeUrl</span> <span class="Other">=</span> <span class="StringLit">"unsafe-url"</span></pre></dt>
- <dd>
-
- Referrer Policy options.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsfetch.nim#L39" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsfetch.nim#L39" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="Request">
- <dt><pre><a href="jsfetch.html#Request"><span class="Identifier">Request</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>
- <span class="Identifier">bodyUsed</span><span class="Operator">*</span><span class="Other">,</span> <span class="Identifier">ok</span><span class="Operator">*</span><span class="Other">,</span> <span class="Identifier">redirected</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a>
- <span class="Identifier">typ</span><span class="Operator">*</span> {.<span class="Identifier">importjs</span><span class="Other">:</span> <span class="StringLit">"type"</span>.}<span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a>
- <span class="Identifier">url</span><span class="Operator">*</span><span class="Other">,</span> <span class="Identifier">statusText</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a>
- <span class="Identifier">status</span><span class="Operator">*</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a>
- <span class="Identifier">headers</span><span class="Operator">*</span><span class="Other">:</span> <a href="jsheaders.html#Headers"><span class="Identifier">Headers</span></a>
- <span class="Identifier">body</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a></pre></dt>
- <dd>
-
- <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/API/Request">https://developer.mozilla.org/en-US/docs/Web/API/Request</a>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsfetch.nim#L54" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsfetch.nim#L54" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="Response">
- <dt><pre><a href="jsfetch.html#Response"><span class="Identifier">Response</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>
- <span class="Identifier">bodyUsed</span><span class="Operator">*</span><span class="Other">,</span> <span class="Identifier">ok</span><span class="Operator">*</span><span class="Other">,</span> <span class="Identifier">redirected</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a>
- <span class="Identifier">typ</span><span class="Operator">*</span> {.<span class="Identifier">importjs</span><span class="Other">:</span> <span class="StringLit">"type"</span>.}<span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a>
- <span class="Identifier">url</span><span class="Operator">*</span><span class="Other">,</span> <span class="Identifier">statusText</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a>
- <span class="Identifier">status</span><span class="Operator">*</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a>
- <span class="Identifier">headers</span><span class="Operator">*</span><span class="Other">:</span> <a href="jsheaders.html#Headers"><span class="Identifier">Headers</span></a>
- <span class="Identifier">body</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a></pre></dt>
- <dd>
-
- <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/API/Response">https://developer.mozilla.org/en-US/docs/Web/API/Response</a>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsfetch.nim#L46" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsfetch.nim#L46" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </dl>
- </div>
- <div class="section" id="12">
- <h1><a class="toc-backref" href="#12">Procs</a></h1>
- <dl class="item">
- <div id="$-procs-all">
- <div id="$">
- <dt><pre><span class="Keyword">func</span> <a href="#%24"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="jsfetch.html#Request"><span class="Identifier">Request</span></a> <span class="Operator">|</span> <a href="jsfetch.html#Response"><span class="Identifier">Response</span></a> <span class="Operator">|</span> <a href="jsfetch.html#FetchOptions"><span class="Identifier">FetchOptions</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsfetch.nim#L116" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsfetch.nim#L116" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="clone-procs-all">
- <div id="clone">
- <dt><pre><span class="Keyword">func</span> <a href="#clone"><span class="Identifier">clone</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="jsfetch.html#Response"><span class="Identifier">Response</span></a> <span class="Operator">|</span> <a href="jsfetch.html#Request"><span class="Identifier">Request</span></a><span class="Other">)</span><span class="Other">:</span> <a href="jsfetch.html#Response"><span class="Identifier">Response</span></a> {.<span class="Identifier">importjs</span><span class="Other">:</span> <span class="StringLit">"#.$1()"</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>
- <dd>
-
- <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/API/Response/clone">https://developer.mozilla.org/en-US/docs/Web/API/Response/clone</a>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsfetch.nim#L71" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsfetch.nim#L71" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="fetch-procs-all">
- <div id="fetch">
- <dt><pre><span class="Keyword">proc</span> <a href="#fetch"><span class="Identifier">fetch</span></a><span class="Other">(</span><span class="Identifier">url</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a> <span class="Operator">|</span> <a href="jsfetch.html#Request"><span class="Identifier">Request</span></a><span class="Other">)</span><span class="Other">:</span> <a href="asyncjs.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="jsfetch.html#Response"><span class="Identifier">Response</span></a><span class="Other">]</span> {.<span class="Identifier">importjs</span><span class="Other">:</span> <span class="StringLit">"$1(#)"</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>
- <dd>
-
- <tt class="docutils literal"><span class="pre"><span class="Identifier">fetch</span><span class="Punctuation">(</span><span class="Punctuation">)</span></span></tt> API, simple <tt class="docutils literal"><span class="pre"><span class="Identifier">GET</span></span></tt> only, returns a <tt class="docutils literal"><span class="pre"><span class="Identifier">Future</span><span class="Punctuation">[</span><span class="Identifier">Response</span><span class="Punctuation">]</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsfetch.nim#L108" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsfetch.nim#L108" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="fetch,,FetchOptions">
- <dt><pre><span class="Keyword">proc</span> <a href="#fetch%2C%2CFetchOptions"><span class="Identifier">fetch</span></a><span class="Other">(</span><span class="Identifier">url</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a> <span class="Operator">|</span> <a href="jsfetch.html#Request"><span class="Identifier">Request</span></a><span class="Other">;</span> <span class="Identifier">options</span><span class="Other">:</span> <a href="jsfetch.html#FetchOptions"><span class="Identifier">FetchOptions</span></a><span class="Other">)</span><span class="Other">:</span> <a href="asyncjs.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="jsfetch.html#Response"><span class="Identifier">Response</span></a><span class="Other">]</span> {.
- <span class="Identifier">importjs</span><span class="Other">:</span> <span class="StringLit">"$1(#, #)"</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>
- <dd>
-
- <tt class="docutils literal"><span class="pre"><span class="Identifier">fetch</span><span class="Punctuation">(</span><span class="Punctuation">)</span></span></tt> API that takes a <tt class="docutils literal"><span class="pre"><span class="Identifier">FetchOptions</span></span></tt>, returns a <tt class="docutils literal"><span class="pre"><span class="Identifier">Future</span><span class="Punctuation">[</span><span class="Identifier">Response</span><span class="Punctuation">]</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsfetch.nim#L111" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsfetch.nim#L111" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="formData-procs-all">
- <div id="formData,Response">
- <dt><pre><span class="Keyword">proc</span> <a href="#formData%2CResponse"><span class="Identifier">formData</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="jsfetch.html#Response"><span class="Identifier">Response</span></a><span class="Other">)</span><span class="Other">:</span> <a href="asyncjs.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="jsformdata.html#FormData"><span class="Identifier">FormData</span></a><span class="Other">]</span> {.<span class="Identifier">importjs</span><span class="Other">:</span> <span class="StringLit">"#.$1()"</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>
- <dd>
-
- <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/API/Response/formData">https://developer.mozilla.org/en-US/docs/Web/API/Response/formData</a>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsfetch.nim#L80" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsfetch.nim#L80" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="json-procs-all">
- <div id="json,Response">
- <dt><pre><span class="Keyword">proc</span> <a href="#json%2CResponse"><span class="Identifier">json</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="jsfetch.html#Response"><span class="Identifier">Response</span></a><span class="Other">)</span><span class="Other">:</span> <a href="asyncjs.html#Future"><span class="Identifier">Future</span></a><span class="Other">[</span><a href="jsffi.html#JsObject"><span class="Identifier">JsObject</span></a><span class="Other">]</span> {.<span class="Identifier">importjs</span><span class="Other">:</span> <span class="StringLit">"#.$1()"</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>
- <dd>
-
- <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/API/Response/json">https://developer.mozilla.org/en-US/docs/Web/API/Response/json</a>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsfetch.nim#L77" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsfetch.nim#L77" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="newfetchOptions-procs-all">
- <div id="newfetchOptions,cstring,Headers">
- <dt><pre><span class="Keyword">func</span> <a href="#newfetchOptions%2Ccstring%2CHeaders"><span class="Identifier">newfetchOptions</span></a><span class="Other">(</span><span class="Identifier">metod</span> <span class="Other">=</span> <span class="Identifier">HttpGet</span><span class="Other">;</span> <span class="Identifier">body</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">;</span> <span class="Identifier">mode</span> <span class="Other">=</span> <span class="Identifier">fmCors</span><span class="Other">;</span>
- <span class="Identifier">credentials</span> <span class="Other">=</span> <span class="Identifier">fcSameOrigin</span><span class="Other">;</span> <span class="Identifier">cache</span> <span class="Other">=</span> <span class="Identifier">fchDefault</span><span class="Other">;</span>
- <span class="Identifier">referrerPolicy</span> <span class="Other">=</span> <span class="Identifier">frpNoReferrerWhenDowngrade</span><span class="Other">;</span>
- <span class="Identifier">keepalive</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">;</span> <span class="Identifier">redirect</span> <span class="Other">=</span> <span class="Identifier">frFollow</span><span class="Other">;</span>
- <span class="Identifier">referrer</span> <span class="Other">=</span> <span class="StringLit">"client"</span><span class="Other">.</span><span class="Identifier">cstring</span><span class="Other">;</span> <span class="Identifier">integrity</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">.</span><span class="Identifier">cstring</span><span class="Other">;</span>
- <span class="Identifier">headers</span><span class="Other">:</span> <a href="jsheaders.html#Headers"><span class="Identifier">Headers</span></a> <span class="Other">=</span> <span class="Identifier">newHeaders</span><span class="Other">(</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <a href="jsfetch.html#FetchOptions"><span class="Identifier">FetchOptions</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>
- <dd>
-
- Constructor for <tt class="docutils literal"><span class="pre"><span class="Identifier">FetchOptions</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsfetch.nim#L88" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsfetch.nim#L88" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="newRequest-procs-all">
- <div id="newRequest,cstring">
- <dt><pre><span class="Keyword">func</span> <a href="#newRequest%2Ccstring"><span class="Identifier">newRequest</span></a><span class="Other">(</span><span class="Identifier">url</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="jsfetch.html#Request"><span class="Identifier">Request</span></a> {.<span class="Identifier">importjs</span><span class="Other">:</span> <span class="StringLit">"(new Request(#))"</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>
- <dd>
-
- Constructor for <tt class="docutils literal"><span class="pre"><span class="Identifier">Request</span></span></tt>. This does <em>not</em> call <tt class="docutils literal"><span class="pre"><span class="Identifier">fetch</span><span class="Punctuation">(</span><span class="Punctuation">)</span></span></tt>. Same as <tt class="docutils literal"><span class="pre"><span class="Identifier">new</span> <span class="Identifier">Request</span><span class="Punctuation">(</span><span class="Punctuation">)</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsfetch.nim#L65" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsfetch.nim#L65" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="newRequest,cstring,FetchOptions">
- <dt><pre><span class="Keyword">func</span> <a href="#newRequest%2Ccstring%2CFetchOptions"><span class="Identifier">newRequest</span></a><span class="Other">(</span><span class="Identifier">url</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">;</span> <span class="Identifier">fetchOptions</span><span class="Other">:</span> <a href="jsfetch.html#FetchOptions"><span class="Identifier">FetchOptions</span></a><span class="Other">)</span><span class="Other">:</span> <a href="jsfetch.html#Request"><span class="Identifier">Request</span></a> {.
- <span class="Identifier">importjs</span><span class="Other">:</span> <span class="StringLit">"(new Request(#, #))"</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>
- <dd>
-
- Constructor for <tt class="docutils literal"><span class="pre"><span class="Identifier">Request</span></span></tt> with <tt class="docutils literal"><span class="pre"><span class="Identifier">fetchOptions</span></span></tt>. Same as <tt class="docutils literal"><span class="pre"><span class="Identifier">fetch</span><span class="Punctuation">(</span><span class="Identifier">url</span><span class="Punctuation">,</span> <span class="Identifier">fetchOptions</span><span class="Punctuation">)</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsfetch.nim#L68" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsfetch.nim#L68" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="newResponse-procs-all">
- <div id="newResponse">
- <dt><pre><span class="Keyword">func</span> <a href="#newResponse"><span class="Identifier">newResponse</span></a><span class="Other">(</span><span class="Identifier">body</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a> <span class="Operator">|</span> <a href="jsformdata.html#FormData"><span class="Identifier">FormData</span></a><span class="Other">)</span><span class="Other">:</span> <a href="jsfetch.html#Response"><span class="Identifier">Response</span></a> {.
- <span class="Identifier">importjs</span><span class="Other">:</span> <span class="StringLit">"(new Response(#))"</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>
- <dd>
-
- Constructor for <tt class="docutils literal"><span class="pre"><span class="Identifier">Response</span></span></tt>. This does <em>not</em> call <tt class="docutils literal"><span class="pre"><span class="Identifier">fetch</span><span class="Punctuation">(</span><span class="Punctuation">)</span></span></tt>. Same as <tt class="docutils literal"><span class="pre"><span class="Identifier">new</span> <span class="Identifier">Response</span><span class="Punctuation">(</span><span class="Punctuation">)</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsfetch.nim#L62" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsfetch.nim#L62" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="text-procs-all">
- <div id="text,Response">
- <dt><pre><span class="Keyword">proc</span> <a href="#text%2CResponse"><span class="Identifier">text</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="jsfetch.html#Response"><span class="Identifier">Response</span></a><span class="Other">)</span><span class="Other">:</span> <a href="asyncjs.html#Future"><span class="Identifier">Future</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">"#.$1()"</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>
- <dd>
-
- <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/API/Response/text">https://developer.mozilla.org/en-US/docs/Web/API/Response/text</a>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsfetch.nim#L74" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsfetch.nim#L74" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="toCstring-procs-all">
- <div id="toCstring">
- <dt><pre><span class="Keyword">func</span> <a href="#toCstring"><span class="Identifier">toCstring</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="jsfetch.html#Request"><span class="Identifier">Request</span></a> <span class="Operator">|</span> <a href="jsfetch.html#Response"><span class="Identifier">Response</span></a> <span class="Operator">|</span> <a href="jsfetch.html#FetchOptions"><span class="Identifier">FetchOptions</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">"JSON.stringify(#)"</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>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsfetch.nim#L114" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsfetch.nim#L114" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="unsafeNewFetchOptions-procs-all">
- <div id="unsafeNewFetchOptions,cstring,cstring,cstring,cstring,cstring,cstring,bool,Headers">
- <dt><pre><span class="Keyword">proc</span> <a href="#unsafeNewFetchOptions%2Ccstring%2Ccstring%2Ccstring%2Ccstring%2Ccstring%2Ccstring%2Cbool%2CHeaders"><span class="Identifier">unsafeNewFetchOptions</span></a><span class="Other">(</span><span class="Identifier">metod</span><span class="Other">,</span> <span class="Identifier">body</span><span class="Other">,</span> <span class="Identifier">mode</span><span class="Other">,</span> <span class="Identifier">credentials</span><span class="Other">,</span> <span class="Identifier">cache</span><span class="Other">,</span> <span class="Identifier">referrerPolicy</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">;</span>
- <span class="Identifier">keepalive</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">;</span> <span class="Identifier">redirect</span> <span class="Other">=</span> <span class="StringLit">"follow"</span><span class="Other">.</span><span class="Identifier">cstring</span><span class="Other">;</span>
- <span class="Identifier">referrer</span> <span class="Other">=</span> <span class="StringLit">"client"</span><span class="Other">.</span><span class="Identifier">cstring</span><span class="Other">;</span> <span class="Identifier">integrity</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">.</span><span class="Identifier">cstring</span><span class="Other">;</span>
- <span class="Identifier">headers</span><span class="Other">:</span> <a href="jsheaders.html#Headers"><span class="Identifier">Headers</span></a> <span class="Other">=</span> <span class="Identifier">newHeaders</span><span class="Other">(</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <a href="jsfetch.html#FetchOptions"><span class="Identifier">FetchOptions</span></a> {.<span class="Identifier">importjs</span><span class="Other">:</span> <span class="StringLit">"{method: #, body: #, mode: #, credentials: #, cache: #, referrerPolicy: #, keepalive: #, redirect: #, referrer: #, integrity: #, headers: #}"</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>
- <dd>
-
- <div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
- Unsafe <tt class="docutils literal"><span class="pre"><span class="Identifier">newfetchOptions</span></span></tt>.</div>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/jsfetch.nim#L83" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/jsfetch.nim#L83" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- </dl>
- </div>
- </div>
- </div>
- <div class="twelve-columns footer">
- <span class="nim-sprite"></span>
- <br>
- <small style="color: var(--hint);">Made with Nim. Generated: 2025-03-15 14:13:44 UTC</small>
- </div>
- </div>
- </div>
- <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
-
- </body>
- </html>
|