📝 Regenerate api doc

docs/api/interfaces/addons_abort.AbortResolver.html

@@ -60,7 +60,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>this: <span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol"> &amp; </span><a href="index.WretchResponseChain.html" class="tsd-signature-type" data-tsd-kind="Interface">WretchResponseChain</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><a href="addons_abort.AbortResolver.html" class="tsd-signature-type" data-tsd-kind="Interface">AbortResolver</a><span class="tsd-signature-symbol">]</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/elbywan/wretch/blob/30de07c/src/addons/abort.ts#L69">addons/abort.ts:69</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/elbywan/wretch/blob/e79ff71/src/addons/abort.ts#L69">addons/abort.ts:69</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="onAbort" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>on<wbr/>Abort</span><a href="#onAbort" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">on<wbr/>Abort<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol"> &amp; </span><a href="index.WretchResponseChain.html" class="tsd-signature-type" data-tsd-kind="Interface">WretchResponseChain</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">&gt;</span>, cb<span class="tsd-signature-symbol">: </span><a href="../types/index.WretchErrorCallback.html" class="tsd-signature-type" data-tsd-kind="Type alias">WretchErrorCallback</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="addons_abort.AbortResolver.html" class="tsd-signature-type" data-tsd-kind="Interface">AbortResolver</a><span class="tsd-signature-symbol">)</span></div>
@@ -90,7 +90,7 @@ <h5>this: <span class="tsd-signature-type" data-tsd-kind="Type parameter">C</spa
 <h5>cb: <a href="../types/index.WretchErrorCallback.html" class="tsd-signature-type" data-tsd-kind="Type alias">WretchErrorCallback</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="addons_abort.AbortResolver.html" class="tsd-signature-type" data-tsd-kind="Interface">AbortResolver</a></h4></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/elbywan/wretch/blob/30de07c/src/addons/abort.ts#L73">addons/abort.ts:73</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/elbywan/wretch/blob/e79ff71/src/addons/abort.ts#L73">addons/abort.ts:73</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="setTimeout" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>set<wbr/>Timeout</span><a href="#setTimeout" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">set<wbr/>Timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol"> &amp; </span><a href="index.WretchResponseChain.html" class="tsd-signature-type" data-tsd-kind="Interface">WretchResponseChain</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">&gt;</span>, time<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, controller<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AbortController</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="addons_abort.AbortResolver.html" class="tsd-signature-type" data-tsd-kind="Interface">AbortResolver</a><span class="tsd-signature-symbol">)</span></div>
@@ -129,7 +129,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> controller: <span clas
 </div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="addons_abort.AbortResolver.html" class="tsd-signature-type" data-tsd-kind="Interface">AbortResolver</a></h4></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/elbywan/wretch/blob/30de07c/src/addons/abort.ts#L51">addons/abort.ts:51</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/elbywan/wretch/blob/e79ff71/src/addons/abort.ts#L51">addons/abort.ts:51</a></li></ul></aside></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/api/interfaces/addons_abort.AbortWretch.html

@@ -64,7 +64,7 @@ <h5>controller: <span class="tsd-signature-type">AbortController</span></h5>
 </div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="addons_abort.AbortWretch.html" class="tsd-signature-type" data-tsd-kind="Interface">AbortWretch</a></h4></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/elbywan/wretch/blob/30de07c/src/addons/abort.ts#L32">addons/abort.ts:32</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/elbywan/wretch/blob/e79ff71/src/addons/abort.ts#L32">addons/abort.ts:32</a></li></ul></aside></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/api/interfaces/addons_perfs.PerfsAddon.html

@@ -71,7 +71,7 @@ <h5>timing: <span class="tsd-signature-type">any</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="addons_perfs.PerfsAddon.html" class="tsd-signature-type" data-tsd-kind="Interface">PerfsAddon</a></h4></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/elbywan/wretch/blob/30de07c/src/addons/perfs.ts#L66">addons/perfs.ts:66</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/elbywan/wretch/blob/e79ff71/src/addons/perfs.ts#L66">addons/perfs.ts:66</a></li></ul></aside></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/api/interfaces/index.Wretch.html

@@ -141,18 +141,27 @@ <h3 class="tsd-anchor-link"><span>fetch</span><a href="#fetch" aria-label="Perma
 <ul class="tsd-descriptions">
 <li class="tsd-description">
 <div class="tsd-comment tsd-typography"><p>Sends the request using the accumulated fetch options.</p>
+<p>Can be used to replay requests.</p>
+<pre><code class="language-js"><span class="hl-1">const</span><span class="hl-2"> </span><span class="hl-3">reAuthOn401</span><span class="hl-2"> = </span><span class="hl-4">wretch</span><span class="hl-2">()</span><br/><span class="hl-2">.</span><span class="hl-4">catcher</span><span class="hl-2">(</span><span class="hl-7">401</span><span class="hl-2">, </span><span class="hl-1">async</span><span class="hl-2"> (</span><span class="hl-6">error</span><span class="hl-2">, </span><span class="hl-6">request</span><span class="hl-2">) </span><span class="hl-1">=&gt;</span><span class="hl-2"> {</span><br/><span class="hl-2">  </span><span class="hl-0">// Renew credentials</span><br/><span class="hl-2">  </span><span class="hl-1">const</span><span class="hl-2"> </span><span class="hl-3">token</span><span class="hl-2"> = </span><span class="hl-8">await</span><span class="hl-2"> </span><span class="hl-4">wretch</span><span class="hl-2">(</span><span class="hl-5">&quot;/renewtoken&quot;</span><span class="hl-2">).</span><span class="hl-4">get</span><span class="hl-2">().</span><span class="hl-4">text</span><span class="hl-2">();</span><br/><span class="hl-2">  </span><span class="hl-4">storeToken</span><span class="hl-2">(</span><span class="hl-6">token</span><span class="hl-2">);</span><br/><span class="hl-2">  </span><span class="hl-0">// Replay the original request with new credentials</span><br/><span class="hl-2">  </span><span class="hl-8">return</span><span class="hl-2"> </span><span class="hl-6">request</span><span class="hl-2">.</span><span class="hl-4">auth</span><span class="hl-2">(</span><span class="hl-6">token</span><span class="hl-2">).</span><span class="hl-4">fetch</span><span class="hl-2">().</span><span class="hl-4">unauthorized</span><span class="hl-2">((</span><span class="hl-6">err</span><span class="hl-2">) </span><span class="hl-1">=&gt;</span><span class="hl-2"> {</span><br/><span class="hl-2">    </span><span class="hl-8">throw</span><span class="hl-2"> </span><span class="hl-6">err</span><span class="hl-2">;</span><br/><span class="hl-2">  }).</span><span class="hl-4">json</span><span class="hl-2">();</span><br/><span class="hl-2">});</span><br/><br/><span class="hl-6">reAuthOn401</span><br/><span class="hl-2">.</span><span class="hl-4">get</span><span class="hl-2">(</span><span class="hl-5">&quot;/resource&quot;</span><span class="hl-2">)</span><br/><span class="hl-2">.</span><span class="hl-4">json</span><span class="hl-2">() </span><span class="hl-0">// &lt;- Will only be called for the original promise</span><br/><span class="hl-2">.</span><span class="hl-4">then</span><span class="hl-2">(</span><span class="hl-6">callback</span><span class="hl-2">); </span><span class="hl-0">// &lt;- Will be called for the original OR the replayed promise result</span>
+</code></pre>
 </div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
 <li>
 <h5>this: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Self</span><span class="tsd-signature-symbol"> &amp; </span><a href="index.Wretch.html" class="tsd-signature-type" data-tsd-kind="Interface">Wretch</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Self</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Chain</span><span class="tsd-signature-symbol">&gt;</span></h5></li>
 <li>
-<h5><code class="tsd-tag ts-flagOptional">Optional</code> method: <span class="tsd-signature-type">string</span></h5></li>
+<h5><code class="tsd-tag ts-flagOptional">Optional</code> method: <span class="tsd-signature-type">string</span></h5>
+<div class="tsd-comment tsd-typography"><p>The HTTP method to use</p>
+</div></li>
 <li>
-<h5><code class="tsd-tag ts-flagOptional">Optional</code> url: <span class="tsd-signature-type">string</span></h5></li>
+<h5><code class="tsd-tag ts-flagOptional">Optional</code> url: <span class="tsd-signature-type">string</span></h5>
+<div class="tsd-comment tsd-typography"><p>Some url to append</p>
+</div></li>
 <li>
-<h5><code class="tsd-tag ts-flagOptional">Optional</code> body: <span class="tsd-signature-type">any</span></h5></li></ul></div>
+<h5><code class="tsd-tag ts-flagOptional">Optional</code> body: <span class="tsd-signature-type">any</span></h5>
+<div class="tsd-comment tsd-typography"><p>Set the body. Behaviour varies depending on the argument type, an object is considered as json.</p>
+</div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">Chain</span><span class="tsd-signature-symbol"> &amp; </span><a href="index.WretchResponseChain.html" class="tsd-signature-type" data-tsd-kind="Interface">WretchResponseChain</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Self</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Chain</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="get" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>get</span><a href="#get" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>