Skip to content

Commit 411fb09

Browse files
elbywanelbywan
committed
📝 Mention file names in the form data addon doc
Solves #197
1 parent f445703 commit 411fb09

File tree

70 files changed

+144
-128
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+144
-128
lines changed

‎docs/api/functions/addons_abort.default.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ <h1>Function default</h1></div>
3131
<h4 class="tsd-returns-title">Returns <a href="../types/index.WretchAddon.html" class="tsd-signature-type tsd-kind-type-alias">WretchAddon</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/addons_abort.AbortWretch.html" class="tsd-signature-type tsd-kind-interface">AbortWretch</a><span class="tsd-signature-symbol">, </span><a href="../interfaces/addons_abort.AbortResolver.html" class="tsd-signature-type tsd-kind-interface">AbortResolver</a><span class="tsd-signature-symbol">&gt;</span></h4>
3232
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
3333
<ul>
34-
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/b183cf7/src/addons/abort.ts#L110">src/addons/abort.ts:110</a></li></ul></aside></li></ul></section></div>
34+
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/f445703/src/addons/abort.ts#L110">src/addons/abort.ts:110</a></li></ul></aside></li></ul></section></div>
3535
<div class="col-sidebar">
3636
<div class="page-menu">
3737
<div class="tsd-navigation settings">

‎docs/api/functions/addons_perfs.default.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ <h1>Function default</h1></div>
3535
<h4 class="tsd-returns-title">Returns <a href="../types/index.WretchAddon.html" class="tsd-signature-type tsd-kind-type-alias">WretchAddon</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/addons_perfs.PerfsAddon.html" class="tsd-signature-type tsd-kind-interface">PerfsAddon</a><span class="tsd-signature-symbol">&gt;</span></h4>
3636
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
3737
<ul>
38-
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/b183cf7/src/addons/perfs.ts#L58">src/addons/perfs.ts:58</a></li></ul></aside></li></ul></section></div>
38+
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/f445703/src/addons/perfs.ts#L58">src/addons/perfs.ts:58</a></li></ul></aside></li></ul></section></div>
3939
<div class="col-sidebar">
4040
<div class="page-menu">
4141
<div class="tsd-navigation settings">

‎docs/api/functions/addons_progress.default.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ <h1>Function default</h1></div>
2828
<h4 class="tsd-returns-title">Returns <a href="../types/index.WretchAddon.html" class="tsd-signature-type tsd-kind-type-alias">WretchAddon</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/addons_progress.ProgressResolver.html" class="tsd-signature-type tsd-kind-interface">ProgressResolver</a><span class="tsd-signature-symbol">&gt;</span></h4>
2929
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
3030
<ul>
31-
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/b183cf7/src/addons/progress.ts#L45">src/addons/progress.ts:45</a></li></ul></aside></li></ul></section></div>
31+
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/f445703/src/addons/progress.ts#L45">src/addons/progress.ts:45</a></li></ul></aside></li></ul></section></div>
3232
<div class="col-sidebar">
3333
<div class="page-menu">
3434
<div class="tsd-navigation settings">

‎docs/api/functions/index.default-1.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ <h4 class="tsd-returns-title">Returns <a href="../interfaces/index.Wretch.html"
4343

4444
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
4545
<ul>
46-
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/b183cf7/src/index.ts#L36">src/index.ts:36</a></li></ul></aside></li></ul></section></div>
46+
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/f445703/src/index.ts#L36">src/index.ts:36</a></li></ul></aside></li></ul></section></div>
4747
<div class="col-sidebar">
4848
<div class="page-menu">
4949
<div class="tsd-navigation settings">

‎docs/api/functions/middlewares_dedupe.dedupe.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
4949
<h4 class="tsd-returns-title">Returns <a href="../types/index.ConfiguredMiddleware.html" class="tsd-signature-type tsd-kind-type-alias">ConfiguredMiddleware</a></h4>
5050
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
5151
<ul>
52-
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/b183cf7/src/middlewares/dedupe.ts#L33">src/middlewares/dedupe.ts:33</a></li></ul></aside></li></ul></section></div>
52+
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/f445703/src/middlewares/dedupe.ts#L33">src/middlewares/dedupe.ts:33</a></li></ul></aside></li></ul></section></div>
5353
<div class="col-sidebar">
5454
<div class="page-menu">
5555
<div class="tsd-navigation settings">

‎docs/api/functions/middlewares_delay.delay.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ <h5><span class="tsd-kind-parameter">time</span>: <span class="tsd-signature-typ
3636
<h4 class="tsd-returns-title">Returns <a href="../types/index.ConfiguredMiddleware.html" class="tsd-signature-type tsd-kind-type-alias">ConfiguredMiddleware</a></h4>
3737
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
3838
<ul>
39-
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/b183cf7/src/middlewares/delay.ts#L16">src/middlewares/delay.ts:16</a></li></ul></aside></li></ul></section></div>
39+
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/f445703/src/middlewares/delay.ts#L16">src/middlewares/delay.ts:16</a></li></ul></aside></li></ul></section></div>
4040
<div class="col-sidebar">
4141
<div class="page-menu">
4242
<div class="tsd-navigation settings">

‎docs/api/functions/middlewares_retry.retry.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
3636
<h4 class="tsd-returns-title">Returns <a href="../types/index.ConfiguredMiddleware.html" class="tsd-signature-type tsd-kind-type-alias">ConfiguredMiddleware</a></h4>
3737
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
3838
<ul>
39-
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/b183cf7/src/middlewares/retry.ts#L119">src/middlewares/retry.ts:119</a></li></ul></aside></li></ul></section></div>
39+
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/f445703/src/middlewares/retry.ts#L119">src/middlewares/retry.ts:119</a></li></ul></aside></li></ul></section></div>
4040
<div class="col-sidebar">
4141
<div class="page-menu">
4242
<div class="tsd-navigation settings">

‎docs/api/functions/middlewares_throttlingCache.throttlingCache.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
7272
<h4 class="tsd-returns-title">Returns <a href="../types/index.ConfiguredMiddleware.html" class="tsd-signature-type tsd-kind-type-alias">ConfiguredMiddleware</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">cache</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">inflight</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">throttling</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Set</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-call-signature">cacheResponse</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span>, <span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4>
7373
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
7474
<ul>
75-
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/b183cf7/src/middlewares/throttlingCache.ts#L56">src/middlewares/throttlingCache.ts:56</a></li></ul></aside></li></ul></section></div>
75+
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/f445703/src/middlewares/throttlingCache.ts#L56">src/middlewares/throttlingCache.ts:56</a></li></ul></aside></li></ul></section></div>
7676
<div class="col-sidebar">
7777
<div class="page-menu">
7878
<div class="tsd-navigation settings">

‎docs/api/interfaces/addons_abort.AbortResolver.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h4>Hierarchy</h4>
2121
<ul class="tsd-hierarchy">
2222
<li><span class="target">AbortResolver</span></li></ul></section><aside class="tsd-sources">
2323
<ul>
24-
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/b183cf7/src/addons/abort.ts#L34">src/addons/abort.ts:34</a></li></ul></aside>
24+
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/f445703/src/addons/abort.ts#L34">src/addons/abort.ts:34</a></li></ul></aside>
2525
<section class="tsd-panel-group tsd-index-group">
2626
<section class="tsd-panel tsd-index-panel">
2727
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -66,7 +66,7 @@ <h5><span class="tsd-kind-parameter">this</span>: <span class="tsd-signature-typ
6666
<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 tsd-kind-interface">AbortResolver</a><span class="tsd-signature-symbol">]</span></h4>
6767
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
6868
<ul>
69-
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/b183cf7/src/addons/abort.ts#L68">src/addons/abort.ts:68</a></li></ul></aside></section>
69+
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/f445703/src/addons/abort.ts#L68">src/addons/abort.ts:68</a></li></ul></aside></section>
7070
<section class="tsd-panel tsd-member"><a id="onAbort" class="tsd-anchor"></a>
7171
<h3 class="tsd-anchor-link"><span>on<wbr/>Abort</span><a href="#onAbort" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
7272
<div class="tsd-signature"><span class="tsd-kind-property">on<wbr/>Abort</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">C</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">R</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">cb</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="addons_abort.AbortResolver.html" class="tsd-signature-type tsd-kind-interface">AbortResolver</a><span class="tsd-signature-symbol">)</span></div>
@@ -98,7 +98,7 @@ <h5><span class="tsd-kind-parameter">cb</span>: <a href="../types/index.WretchEr
9898
<h4 class="tsd-returns-title">Returns <a href="addons_abort.AbortResolver.html" class="tsd-signature-type tsd-kind-interface">AbortResolver</a></h4>
9999
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
100100
<ul>
101-
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/b183cf7/src/addons/abort.ts#L72">src/addons/abort.ts:72</a></li></ul></aside></section>
101+
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/f445703/src/addons/abort.ts#L72">src/addons/abort.ts:72</a></li></ul></aside></section>
102102
<section class="tsd-panel tsd-member"><a id="setTimeout" class="tsd-anchor"></a>
103103
<h3 class="tsd-anchor-link"><span>set<wbr/>Timeout</span><a href="#setTimeout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
104104
<div class="tsd-signature"><span class="tsd-kind-property">set<wbr/>Timeout</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">C</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">R</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">time</span>, <span class="tsd-kind-parameter">controller</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="addons_abort.AbortResolver.html" class="tsd-signature-type tsd-kind-interface">AbortResolver</a><span class="tsd-signature-symbol">)</span></div>
@@ -141,7 +141,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
141141
<h4 class="tsd-returns-title">Returns <a href="addons_abort.AbortResolver.html" class="tsd-signature-type tsd-kind-interface">AbortResolver</a></h4>
142142
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
143143
<ul>
144-
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/b183cf7/src/addons/abort.ts#L50">src/addons/abort.ts:50</a></li></ul></aside></section></section></div>
144+
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/f445703/src/addons/abort.ts#L50">src/addons/abort.ts:50</a></li></ul></aside></section></section></div>
145145
<div class="col-sidebar">
146146
<div class="page-menu">
147147
<div class="tsd-navigation settings">

‎docs/api/interfaces/addons_abort.AbortWretch.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h4>Hierarchy</h4>
2121
<ul class="tsd-hierarchy">
2222
<li><span class="target">AbortWretch</span></li></ul></section><aside class="tsd-sources">
2323
<ul>
24-
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/b183cf7/src/addons/abort.ts#L3">src/addons/abort.ts:3</a></li></ul></aside>
24+
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/f445703/src/addons/abort.ts#L3">src/addons/abort.ts:3</a></li></ul></aside>
2525
<section class="tsd-panel-group tsd-index-group">
2626
<section class="tsd-panel tsd-index-panel">
2727
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -71,7 +71,7 @@ <h5><span class="tsd-kind-parameter">controller</span>: <span class="tsd-signatu
7171
<h4 class="tsd-returns-title">Returns <a href="addons_abort.AbortWretch.html" class="tsd-signature-type tsd-kind-interface">AbortWretch</a></h4>
7272
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
7373
<ul>
74-
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/b183cf7/src/addons/abort.ts#L31">src/addons/abort.ts:31</a></li></ul></aside></section></section></div>
74+
<li>Defined in <a href="https://github.com/elbywan/wretch/blob/f445703/src/addons/abort.ts#L31">src/addons/abort.ts:31</a></li></ul></aside></section></section></div>
7575
<div class="col-sidebar">
7676
<div class="page-menu">
7777
<div class="tsd-navigation settings">

0 commit comments

Comments
 (0)