📝 Mention file names in the form data addon doc

Solves #197

docs/api/functions/addons_abort.default.html

@@ -31,7 +31,7 @@ <h1>Function default</h1></div>
 <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>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<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>
+<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>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/api/functions/addons_perfs.default.html

@@ -35,7 +35,7 @@ <h1>Function default</h1></div>
 <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>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<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>
+<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>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/api/functions/addons_progress.default.html

@@ -28,7 +28,7 @@ <h1>Function default</h1></div>
 <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>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<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>
+<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>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

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

@@ -43,7 +43,7 @@ <h4 class="tsd-returns-title">Returns <a href="../interfaces/index.Wretch.html"
 
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<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>
+<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>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/api/functions/middlewares_dedupe.dedupe.html

@@ -49,7 +49,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
 <h4 class="tsd-returns-title">Returns <a href="../types/index.ConfiguredMiddleware.html" class="tsd-signature-type tsd-kind-type-alias">ConfiguredMiddleware</a></h4>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<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>
+<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>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/api/functions/middlewares_delay.delay.html

@@ -36,7 +36,7 @@ <h5><span class="tsd-kind-parameter">time</span>: <span class="tsd-signature-typ
 <h4 class="tsd-returns-title">Returns <a href="../types/index.ConfiguredMiddleware.html" class="tsd-signature-type tsd-kind-type-alias">ConfiguredMiddleware</a></h4>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<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>
+<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>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/api/functions/middlewares_retry.retry.html

@@ -36,7 +36,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
 <h4 class="tsd-returns-title">Returns <a href="../types/index.ConfiguredMiddleware.html" class="tsd-signature-type tsd-kind-type-alias">ConfiguredMiddleware</a></h4>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<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>
+<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>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/api/functions/middlewares_throttlingCache.throttlingCache.html

@@ -72,7 +72,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
 <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>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<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>
+<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>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/api/interfaces/addons_abort.AbortResolver.html

@@ -21,7 +21,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">AbortResolver</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<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>
+<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>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <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
 <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>
 <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<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>
+<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>
 <section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <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
 <h4 class="tsd-returns-title">Returns <a href="addons_abort.AbortResolver.html" class="tsd-signature-type tsd-kind-interface">AbortResolver</a></h4>
 <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<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>
+<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>
 <section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <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-
 <h4 class="tsd-returns-title">Returns <a href="addons_abort.AbortResolver.html" class="tsd-signature-type tsd-kind-interface">AbortResolver</a></h4>
 <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<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>
+<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>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/api/interfaces/addons_abort.AbortWretch.html

@@ -21,7 +21,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">AbortWretch</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<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>
+<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>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <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
 <h4 class="tsd-returns-title">Returns <a href="addons_abort.AbortWretch.html" class="tsd-signature-type tsd-kind-interface">AbortWretch</a></h4>
 <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<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>
+<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>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/api/interfaces/addons_formData.FormDataAddon.html

@@ -21,7 +21,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">FormDataAddon</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/elbywan/wretch/blob/b183cf7/src/addons/formData.ts#L37">src/addons/formData.ts:37</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/elbywan/wretch/blob/f445703/src/addons/formData.ts#L37">src/addons/formData.ts:37</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -51,6 +51,13 @@ <h3 class="tsd-anchor-link"><span>form<wbr/>Data</span><a href="#formData" aria-
 </blockquote>
 <pre><code class="language-js"><span class="hl-1">const</span><span class="hl-2"> </span><span class="hl-3">form</span><span class="hl-2"> = {</span><br/><span class="hl-2">  </span><span class="hl-6">duck:</span><span class="hl-2"> </span><span class="hl-5">&quot;Muscovy&quot;</span><span class="hl-2">,</span><br/><span class="hl-2">  </span><span class="hl-6">duckProperties:</span><span class="hl-2"> {</span><br/><span class="hl-2">    </span><span class="hl-6">beak:</span><span class="hl-2"> {</span><br/><span class="hl-2">      </span><span class="hl-6">color:</span><span class="hl-2"> </span><span class="hl-5">&quot;yellow&quot;</span><span class="hl-2">,</span><br/><span class="hl-2">    },</span><br/><span class="hl-2">    </span><span class="hl-6">legs:</span><span class="hl-2"> </span><span class="hl-7">2</span><span class="hl-2">,</span><br/><span class="hl-2">  },</span><br/><span class="hl-2">  </span><span class="hl-6">ignored:</span><span class="hl-2"> {</span><br/><span class="hl-2">    </span><span class="hl-6">key:</span><span class="hl-2"> </span><span class="hl-7">0</span><span class="hl-2">,</span><br/><span class="hl-2">  },</span><br/><span class="hl-2">};</span><br/><br/><span class="hl-0">// Will append the following keys to the FormData payload:</span><br/><span class="hl-0">// &quot;duck&quot;, &quot;duckProperties[beak][color]&quot;, &quot;duckProperties[legs]&quot;</span><br/><span class="hl-4">wretch</span><span class="hl-2">(</span><span class="hl-5">&quot;...&quot;</span><span class="hl-2">).</span><span class="hl-4">addons</span><span class="hl-2">(</span><span class="hl-6">FormDataAddon</span><span class="hl-2">).</span><span class="hl-4">formData</span><span class="hl-2">(</span><span class="hl-6">form</span><span class="hl-2">, [</span><span class="hl-5">&quot;ignored&quot;</span><span class="hl-2">]).</span><span class="hl-4">post</span><span class="hl-2">();</span>
 </code><button>Copy</button></pre>
+<blockquote>
+<p>Note: This addon does not support specifying a custom <code>filename</code>.
+If you need to do so, you can use the <code>body</code> method directly:</p>
+<pre><code class="language-js"><span class="hl-1">const</span><span class="hl-2"> </span><span class="hl-3">form</span><span class="hl-2"> = </span><span class="hl-1">new</span><span class="hl-2"> </span><span class="hl-4">FormData</span><span class="hl-2">();</span><br/><span class="hl-6">form</span><span class="hl-2">.</span><span class="hl-4">append</span><span class="hl-2">(</span><span class="hl-5">&quot;hello&quot;</span><span class="hl-2">, </span><span class="hl-5">&quot;world&quot;</span><span class="hl-2">, </span><span class="hl-5">&quot;hello.txt&quot;</span><span class="hl-2">);</span><br/><span class="hl-4">wretch</span><span class="hl-2">(</span><span class="hl-5">&quot;...&quot;</span><span class="hl-2">).</span><span class="hl-4">body</span><span class="hl-2">(</span><span class="hl-6">form</span><span class="hl-2">).</span><span class="hl-4">post</span><span class="hl-2">();</span>
+</code><button>Copy</button></pre>
+<p>See: <a href="https://developer.mozilla.org/en-US/docs/Web/API/FormData/append#example">https://developer.mozilla.org/en-US/docs/Web/API/FormData/append#example</a></p>
+</blockquote>
 </div>
 <section class="tsd-panel">
 <h4>Type Parameters</h4>
@@ -79,7 +86,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
 <h4 class="tsd-returns-title">Returns <a href="addons_formData.FormDataAddon.html" class="tsd-signature-type tsd-kind-interface">FormDataAddon</a></h4>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/elbywan/wretch/blob/b183cf7/src/addons/formData.ts#L80">src/addons/formData.ts:80</a></li></ul></aside></li></ul></section></section></div>
+<li>Defined in <a href="https://github.com/elbywan/wretch/blob/f445703/src/addons/formData.ts#L89">src/addons/formData.ts:89</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">