2.11.0 tag

CHANGELOG.md

@@ -1,3 +1,18 @@
+<a name="2.11.0"></a>
+# [2.11.0](https://github.com/elbywan/wretch/compare/2.10.0...2.11.0) (2024-10-29)
+
+
+### :arrow_up: Version update(s)
+
+* Bump body-parser from 1.20.0 to 1.20.3 ([598ce94](https://github.com/elbywan/wretch/commit/598ce94))
+* Bump rollup from 4.5.0 to 4.22.4 ([75f9db7](https://github.com/elbywan/wretch/commit/75f9db7))
+
+### :factory: New feature(s)
+
+* Add partial typing for the wretch options ([e778f88](https://github.com/elbywan/wretch/commit/e778f88)), closes [#253](https://github.com/elbywan/wretch/issues/253) [#251](https://github.com/elbywan/wretch/issues/251)
+
+
+
 <a name="2.10.0"></a>
 # [2.10.0](https://github.com/elbywan/wretch/compare/2.9.1...2.10.0) (2024-09-13)
 

README.md

@@ -19,7 +19,7 @@
 
 <br>
 
-##### Wretch 2.10 is now live 🎉 ! Please have a look at the [releases](https://github.com/elbywan/wretch/releases) and the [changelog](https://github.com/elbywan/wretch/blob/master/CHANGELOG.md) after each update for new features and breaking changes. If you want to try out the hot stuff, please look into the [dev](https://github.com/elbywan/wretch/tree/dev) branch.
+##### Wretch 2.11 is now live 🎉 ! Please have a look at the [releases](https://github.com/elbywan/wretch/releases) and the [changelog](https://github.com/elbywan/wretch/blob/master/CHANGELOG.md) after each update for new features and breaking changes. If you want to try out the hot stuff, please look into the [dev](https://github.com/elbywan/wretch/tree/dev) branch.
 
 ##### And if you like the library please consider becoming a [sponsor](https://github.com/sponsors/elbywan) ❤️.
 

docs/api/functions/addons_abort.default.html

@@ -6,4 +6,4 @@
 <pre><code class="js"><span class="hl-8">import</span><span class="hl-2"> </span><span class="hl-6">AbortAddon</span><span class="hl-2"> </span><span class="hl-8">from</span><span class="hl-2"> </span><span class="hl-5">&quot;wretch/addons/abort&quot;</span><br/><br/><span class="hl-1">const</span><span class="hl-2"> [</span><span class="hl-3">c</span><span class="hl-2">, </span><span class="hl-3">w</span><span class="hl-2">] = </span><span class="hl-4">wretch</span><span class="hl-2">(</span><span class="hl-5">&quot;...&quot;</span><span class="hl-2">)</span><br/><span class="hl-2">  .</span><span class="hl-4">addon</span><span class="hl-2">(</span><span class="hl-4">AbortAddon</span><span class="hl-2">())</span><br/><span class="hl-2">  .</span><span class="hl-4">get</span><span class="hl-2">()</span><br/><span class="hl-2">  .</span><span class="hl-4">onAbort</span><span class="hl-2">((</span><span class="hl-6">_</span><span class="hl-2">) </span><span class="hl-1">=&gt;</span><span class="hl-2"> </span><span class="hl-6">console</span><span class="hl-2">.</span><span class="hl-4">log</span><span class="hl-2">(</span><span class="hl-5">&quot;Aborted !&quot;</span><span class="hl-2">))</span><br/><span class="hl-2">  .</span><span class="hl-4">controller</span><span class="hl-2">();</span><br/><br/><span class="hl-6">w</span><span class="hl-2">.</span><span class="hl-4">text</span><span class="hl-2">((</span><span class="hl-6">_</span><span class="hl-2">) </span><span class="hl-1">=&gt;</span><span class="hl-2"> </span><span class="hl-6">console</span><span class="hl-2">.</span><span class="hl-4">log</span><span class="hl-2">(</span><span class="hl-5">&quot;should never be called&quot;</span><span class="hl-2">));</span><br/><span class="hl-6">c</span><span class="hl-2">.</span><span class="hl-4">abort</span><span class="hl-2">();</span><br/><br/><span class="hl-0">// Or :</span><br/><br/><span class="hl-1">const</span><span class="hl-2"> </span><span class="hl-3">controller</span><span class="hl-2"> = </span><span class="hl-1">new</span><span class="hl-2"> </span><span class="hl-4">AbortController</span><span class="hl-2">();</span><br/><br/><span class="hl-4">wretch</span><span class="hl-2">(</span><span class="hl-5">&quot;...&quot;</span><span class="hl-2">)</span><br/><span class="hl-2">  .</span><span class="hl-4">addon</span><span class="hl-2">(</span><span class="hl-4">AbortAddon</span><span class="hl-2">())</span><br/><span class="hl-2">  .</span><span class="hl-4">signal</span><span class="hl-2">(</span><span class="hl-6">controller</span><span class="hl-2">)</span><br/><span class="hl-2">  .</span><span class="hl-4">get</span><span class="hl-2">()</span><br/><span class="hl-2">  .</span><span class="hl-4">onAbort</span><span class="hl-2">((</span><span class="hl-6">_</span><span class="hl-2">) </span><span class="hl-1">=&gt;</span><span class="hl-2"> </span><span class="hl-6">console</span><span class="hl-2">.</span><span class="hl-4">log</span><span class="hl-2">(</span><span class="hl-5">&quot;Aborted !&quot;</span><span class="hl-2">))</span><br/><span class="hl-2">  .</span><span class="hl-4">text</span><span class="hl-2">((</span><span class="hl-6">_</span><span class="hl-2">) </span><span class="hl-1">=&gt;</span><span class="hl-2"> </span><span class="hl-6">console</span><span class="hl-2">.</span><span class="hl-4">log</span><span class="hl-2">(</span><span class="hl-5">&quot;should never be called&quot;</span><span class="hl-2">));</span><br/><br/><span class="hl-6">controller</span><span class="hl-2">.</span><span class="hl-4">abort</span><span class="hl-2">();</span>
 </code><button type="button">Copy</button></pre>
 
-</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="default" class="tsd-anchor"></a><span class="tsd-kind-call-signature">default</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><a href="#default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><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><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/elbywan/wretch/blob/c7f00fc8bdd7d8ae58332156a4af6f52c0737514/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"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>wretch</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
+</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="default" class="tsd-anchor"></a><span class="tsd-kind-call-signature">default</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><a href="#default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><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><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/elbywan/wretch/blob/a89ed2c399239831557c8cb67d2f1176ebe51fc1/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"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>wretch</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>