diff --git a/CHANGELOG.md b/CHANGELOG.md index 207af9e..ad67621 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,24 @@ + +## [2.1.5](https://github.com/elbywan/wretch/compare/2.1.4...2.1.5) (2022-10-15) + + +### :arrow_up: Version update(s) + +* Bump dependencies ([6043c75](https://github.com/elbywan/wretch/commit/6043c75)) +* Bump fastify from 4.3.0 to 4.8.1 ([130ccc2](https://github.com/elbywan/wretch/commit/130ccc2)) + +### :bug: Bug fix(es) + +* Query addon should strip undefined values ([ce395b5](https://github.com/elbywan/wretch/commit/ce395b5)), closes [#148](https://github.com/elbywan/wretch/issues/148) + +### :memo: Documentation update(s) + +* Add timeout code sample in the readme ([beb51c8](https://github.com/elbywan/wretch/commit/beb51c8)) +* Fix outdated code comments ([d4c546d](https://github.com/elbywan/wretch/commit/d4c546d)) +* Fix unpkg url in the readme ([07d4a00](https://github.com/elbywan/wretch/commit/07d4a00)) + + + ## [2.1.4](https://github.com/elbywan/wretch/compare/2.1.3...2.1.4) (2022-09-28) diff --git a/docs/api/assets/main.js b/docs/api/assets/main.js index c815b33..abd0485 100644 --- a/docs/api/assets/main.js +++ b/docs/api/assets/main.js @@ -1,5 +1,5 @@ "use strict"; -(()=>{var Qe=Object.create;var ae=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Ce=Object.getOwnPropertyNames;var Oe=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var _e=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Me=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ce(e))!Re.call(t,i)&&i!==n&&ae(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Qe(Oe(t)):{},Me(e||!t||!t.__esModule?ae(n,"default",{value:t,enumerable:!0}):n,t));var de=_e((ce,he)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var h=t.utils.clone(n)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(r.slice(a,o),h))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +"use strict";(()=>{var Qe=Object.create;var ae=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Ce=Object.getOwnPropertyNames;var Oe=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var _e=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Me=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ce(e))!Re.call(t,i)&&i!==n&&ae(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Qe(Oe(t)):{},Me(e||!t||!t.__esModule?ae(n,"default",{value:t,enumerable:!0}):n,t));var de=_e((ce,he)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var h=t.utils.clone(n)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(r.slice(a,o),h))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. `,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ou?h+=2:a==u&&(n+=r[l+1]*i[h+1],l+=2,h+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}if(s.str.length==0&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),m=s.str.charAt(1),v;m in s.node.edges?v=s.node.edges[m]:(v=new t.TokenSet,s.node.edges[m]=v),s.str.length==1&&(v.final=!0),i.push({node:v,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof ce=="object"?he.exports=n():e.lunr=n()}(this,function(){return t})})()});var le=[];function j(t,e){le.push({selector:e,constructor:t})}var Y=class{constructor(){this.createComponents(document.body)}createComponents(e){le.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r}),r.dataset.hasInstance=String(!0))})})}};var k=class{constructor(e){this.el=e.el}};var J=class{constructor(){this.listeners={}}addEventListener(e,n){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(n)}removeEventListener(e,n){if(!(e in this.listeners))return;let r=this.listeners[e];for(let i=0,s=r.length;i{let n=Date.now();return(...r)=>{n+e-Date.now()<0&&(t(...r),n=Date.now())}};var re=class extends J{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.navigation=document.querySelector(".col-menu"),window.addEventListener("scroll",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.searchInput=document.querySelector("#tsd-search input"),this.searchInput&&this.searchInput.addEventListener("focus",()=>{this.hideShowToolbar()}),this.onResize(),this.onScroll()}triggerResize(){let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onScroll(){this.scrollTop=window.scrollY||0;let n=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(n),this.hideShowToolbar()}hideShowToolbar(){let n=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0||!!this.searchInput&&this.searchInput===document.activeElement,n!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),this.navigation?.classList.toggle("col-menu--hide")),this.lastY=this.scrollTop}},R=re;R.instance=new re;var X=class extends k{constructor(n){super(n);this.anchors=[];this.index=-1;R.instance.addEventListener("resize",()=>this.onResize()),R.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substring(0,n.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let i=r.href;if(i.indexOf("#")==-1||i.substring(0,n.length)!=n)return;let s=i.substring(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=r.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let n;for(let i=0,s=this.anchors.length;ii.position-s.position);let r=new CustomEvent("scroll",{detail:{scrollTop:R.instance.scrollTop}});this.onScroll(r)}onScroll(n){let r=n.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>r;)o-=1;for(;o-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=o,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ue=(t,e=100)=>{let n;return(...r)=>{clearTimeout(n),n=setTimeout(()=>t(r),e)}};var me=De(de());function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let n=document.querySelector("#tsd-search input"),r=document.querySelector("#tsd-search .results");if(!n||!r)throw new Error("The input field or the result list wrapper was not found");let i=!1;r.addEventListener("mousedown",()=>i=!0),r.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),n.addEventListener("focus",()=>t.classList.add("has-focus")),n.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Fe(t,r,n,s)}function Fe(t,e,n,r){n.addEventListener("input",ue(()=>{Ae(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?fe(e,-1):s.key==="ArrowDown"?fe(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function He(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=me.Index.load(window.searchData.index))}function Ae(t,e,n,r){if(He(r,t),!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s=i?r.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${pe(u.parent,i)}.${l}`);let h=document.createElement("li");h.classList.value=u.classes??"";let m=document.createElement("a");m.href=r.base+u.url,m.innerHTML=l,h.append(m),e.appendChild(h)}}function fe(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function pe(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(ie(t.substring(s,o)),`${ie(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ie(t.substring(s))),i.join("")}var Ne={"&":"&","<":"<",">":">","'":"'",'"':"""};function ie(t){return t.replace(/[&<>"'"]/g,e=>Ne[e])}var F="mousedown",ye="mousemove",B="mouseup",Z={x:0,y:0},ge=!1,se=!1,je=!1,H=!1,xe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(xe?"is-mobile":"not-mobile");xe&&"ontouchstart"in document.documentElement&&(je=!0,F="touchstart",ye="touchmove",B="touchend");document.addEventListener(F,t=>{se=!0,H=!1;let e=F=="touchstart"?t.targetTouches[0]:t;Z.y=e.pageY||0,Z.x=e.pageX||0});document.addEventListener(ye,t=>{if(!!se&&!H){let e=F=="touchstart"?t.targetTouches[0]:t,n=Z.x-(e.pageX||0),r=Z.y-(e.pageY||0);H=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{se=!1});document.addEventListener("click",t=>{ge&&(t.preventDefault(),t.stopImmediatePropagation(),ge=!1)});var K=class extends k{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(B,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){H||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!H&&this.active&&n.target.closest(".col-menu")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var oe;try{oe=localStorage}catch{oe={getItem(){return null},setItem(){}}}var Q=oe;var Le=document.head.appendChild(document.createElement("style"));Le.dataset.for="filters";var ee=class extends k{constructor(n){super(n);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),Le.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } `}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var te=class extends k{constructor(n){super(n);this.calculateHeights(),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.textContent.replace(/\s+/g,"-").toLowerCase()}`,this.setLocalStorage(this.fromLocalStorage(),!0),this.summary.addEventListener("click",r=>this.toggleVisibility(r)),this.icon.style.transform=this.getIconRotation()}getIconRotation(n=this.el.open){return`rotate(${n?0:-90}deg)`}calculateHeights(){let n=this.el.open,{position:r,left:i}=this.el.style;this.el.style.position="fixed",this.el.style.left="-9999px",this.el.open=!0,this.expandedHeight=this.el.offsetHeight+"px",this.el.open=!1,this.collapsedHeight=this.el.offsetHeight+"px",this.el.open=n,this.el.style.height=n?this.expandedHeight:this.collapsedHeight,this.el.style.position=r,this.el.style.left=i}toggleVisibility(n){n.preventDefault(),this.el.style.overflow="hidden",this.el.open?this.collapse():this.expand()}expand(n=!0){this.el.open=!0,this.animate(this.collapsedHeight,this.expandedHeight,{opening:!0,duration:n?300:0})}collapse(n=!0){this.animate(this.expandedHeight,this.collapsedHeight,{opening:!1,duration:n?300:0})}animate(n,r,{opening:i,duration:s=300}){if(this.animation)return;let o={duration:s,easing:"ease"};this.animation=this.el.animate({height:[n,r]},o),this.icon.animate({transform:[this.icon.style.transform||this.getIconRotation(!i),this.getIconRotation(i)]},o).addEventListener("finish",()=>{this.icon.style.transform=this.getIconRotation(i)}),this.animation.addEventListener("finish",()=>this.animationEnd(i))}animationEnd(n){this.el.open=n,this.animation=void 0,this.el.style.height="auto",this.el.style.overflow="visible",this.setLocalStorage(n)}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.open}setLocalStorage(n,r=!1){this.fromLocalStorage()===n&&!r||(Q.setItem(this.key,n.toString()),this.el.open=n,this.handleValueChange(r))}handleValueChange(n=!1){this.fromLocalStorage()===this.el.open&&!n||(this.fromLocalStorage()?this.expand(!1):this.collapse(!1))}};function be(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,Ee(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),Ee(t.value)})}function Ee(t){document.documentElement.dataset.theme=t}ve();j(X,".menu-highlight");j(K,"a[data-toggle]");j(te,".tsd-index-accordion");j(ee,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("theme");Se&&be(Se);var Be=new Y;Object.defineProperty(window,"app",{value:Be});})(); /*! diff --git a/docs/api/assets/style.css b/docs/api/assets/style.css index 8f6ed2c..958d2c2 100644 --- a/docs/api/assets/style.css +++ b/docs/api/assets/style.css @@ -1124,6 +1124,7 @@ ul.tsd-type-parameter-list h5 { display: flex; justify-content: space-between; height: 2.5rem; + margin: 0 auto; } .tsd-page-toolbar .table-cell { position: relative; diff --git a/docs/api/assets/widgets.png b/docs/api/assets/widgets.png deleted file mode 100644 index c738053..0000000 Binary files a/docs/api/assets/widgets.png and /dev/null differ diff --git a/docs/api/assets/widgets@2x.png b/docs/api/assets/widgets@2x.png deleted file mode 100644 index 4bbbd57..0000000 Binary files a/docs/api/assets/widgets@2x.png and /dev/null differ diff --git a/docs/api/functions/addons_abort.default.html b/docs/api/functions/addons_abort.default.html index 71a490b..c701d74 100644 --- a/docs/api/functions/addons_abort.default.html +++ b/docs/api/functions/addons_abort.default.html @@ -28,7 +28,7 @@

Function default

Returns WretchAddon<AbortWretch, AbortResolver>

+
  • Defined in src/addons/abort.ts:110
    • diff --git a/docs/api/functions/addons_perfs.default.html b/docs/api/functions/addons_perfs.default.html index 0fb6f25..570a0ab 100644 --- a/docs/api/functions/addons_perfs.default.html +++ b/docs/api/functions/addons_perfs.default.html @@ -32,7 +32,7 @@

    Function default

    Returns WretchAddon<unknown, PerfsAddon>

    +
  • Defined in src/addons/perfs.ts:114
    • diff --git a/docs/api/functions/index.default-1.html b/docs/api/functions/index.default-1.html index 0ead642..f88cc63 100644 --- a/docs/api/functions/index.default-1.html +++ b/docs/api/functions/index.default-1.html @@ -39,7 +39,7 @@
    _options: {}

    Returns Wretch

    +
  • Defined in src/index.ts:36
    • diff --git a/docs/api/functions/middlewares_dedupe.dedupe.html b/docs/api/functions/middlewares_dedupe.dedupe.html index 0e3d457..cba9013 100644 --- a/docs/api/functions/middlewares_dedupe.dedupe.html +++ b/docs/api/functions/middlewares_dedupe.dedupe.html @@ -54,7 +54,7 @@

    Parameters

    Optional options: DedupeOptions

    Returns ConfiguredMiddleware

    +
  • Defined in src/middlewares/dedupe.ts:33
    • diff --git a/docs/api/functions/middlewares_delay.delay.html b/docs/api/functions/middlewares_delay.delay.html index 1bd25aa..193d135 100644 --- a/docs/api/functions/middlewares_delay.delay.html +++ b/docs/api/functions/middlewares_delay.delay.html @@ -41,7 +41,7 @@

    Parameters

    time: number

    Returns ConfiguredMiddleware

    +
  • Defined in src/middlewares/delay.ts:16
    • diff --git a/docs/api/functions/middlewares_retry.retry.html b/docs/api/functions/middlewares_retry.retry.html index 88afeca..9f27325 100644 --- a/docs/api/functions/middlewares_retry.retry.html +++ b/docs/api/functions/middlewares_retry.retry.html @@ -36,7 +36,7 @@

    Parameters

    Optional options: RetryOptions

    Returns ConfiguredMiddleware

    +
  • Defined in src/middlewares/retry.ts:92
    • diff --git a/docs/api/functions/middlewares_throttlingCache.throttlingCache.html b/docs/api/functions/middlewares_throttlingCache.throttlingCache.html index 56512a3..5d1ea89 100644 --- a/docs/api/functions/middlewares_throttlingCache.throttlingCache.html +++ b/docs/api/functions/middlewares_throttlingCache.throttlingCache.html @@ -16,7 +16,7 @@

    Function throttlingCache

    +
  • Defined in src/middlewares/throttlingCache.ts:56
    • diff --git a/docs/api/interfaces/addons_abort.AbortResolver.html b/docs/api/interfaces/addons_abort.AbortResolver.html index 6ea2d08..e1b8624 100644 --- a/docs/api/interfaces/addons_abort.AbortResolver.html +++ b/docs/api/interfaces/addons_abort.AbortResolver.html @@ -19,7 +19,7 @@

    Hierarchy

    • AbortResolver
    +
  • Defined in src/addons/abort.ts:34
    • @@ -47,15 +47,15 @@

    Type declaration

    // We need the controller outside the chain
    const [c, w] = wretch("url")
      .addon(AbortAddon())
      .get()
      .controller()

    // Resume with the chain
    w.onAbort(_ => console.log("ouch")).json()

    // Later on…
    c.abort()
    -
    -

    Type Parameters

    +
    +

    Type Parameters

    +

    R

    Parameters

    Returns [any, AbortResolver]

    +
  • Defined in src/addons/abort.ts:68

    • onAbort

    onAbort: (<T, C, R>(this: C & WretchResponseChain<T, C, R>, cb: WretchErrorCallback<T, C, R>) => AbortResolver)
    @@ -76,15 +76,15 @@

    Type declaration

  • Catches an AbortError and performs a callback.

    -
    -

    Type Parameters

    +
    +

    Type Parameters

    +

    R

    • Parameters

    Returns AbortResolver

    +
  • Defined in src/addons/abort.ts:72

    • setTimeout

    setTimeout: (<T, C, R>(this: C & WretchResponseChain<T, C, R>, time: number, controller?: AbortController) => AbortResolver)
    @@ -110,15 +110,15 @@

    Type declaration

    // 1 second timeout
    wretch("...").addon(AbortAddon()).get().setTimeout(1000).json(_ =>
      // will not be called if the request timeouts
    )
    -
    -

    Type Parameters

    +
    +

    Type Parameters

    +

    R

    Parameters

      @@ -134,7 +134,7 @@
      Optional controller:

    Returns AbortResolver

    +
  • Defined in src/addons/abort.ts:50
    • diff --git a/docs/api/interfaces/addons_abort.AbortWretch.html b/docs/api/interfaces/addons_abort.AbortWretch.html index e5ae485..fe3a94e 100644 --- a/docs/api/interfaces/addons_abort.AbortWretch.html +++ b/docs/api/interfaces/addons_abort.AbortWretch.html @@ -19,7 +19,7 @@

    Hierarchy

    • AbortWretch
    +
  • Defined in src/addons/abort.ts:3
    • @@ -47,15 +47,15 @@

    Type declaration

    const controller = new AbortController()

    // Associates the same controller with multiple requests
    wretch("url1")
      .addon(AbortAddon())
      .signal(controller)
      .get()
      .json()
    wretch("url2")
      .addon(AbortAddon())
      .signal(controller)
      .get()
      .json()

    // Aborts both requests
    controller.abort()
    -
    -

    Type Parameters

    +
    +

    Type Parameters

    +

    R

    Parameters

      @@ -67,7 +67,7 @@
      controller: AbortController

    Returns AbortWretch

    +
  • Defined in src/addons/abort.ts:31
    • diff --git a/docs/api/interfaces/addons_formData.FormDataAddon.html b/docs/api/interfaces/addons_formData.FormDataAddon.html index f2b652b..5937cc5 100644 --- a/docs/api/interfaces/addons_formData.FormDataAddon.html +++ b/docs/api/interfaces/addons_formData.FormDataAddon.html @@ -19,7 +19,7 @@

    Hierarchy

    • FormDataAddon
    +
  • Defined in src/addons/formData.ts:37
    • @@ -50,15 +50,15 @@

    formDataconst form = {
    duck: "Muscovy",
    duckProperties: {
    beak: {
    color: "yellow",
    },
    legs: 2,
    },
    ignored: {
    key: 0,
    },
    };

    // Will append the following keys to the FormData payload:
    // "duck", "duckProperties[beak][color]", "duckProperties[legs]"
    wretch("...").addons(FormDataAddon).formData(form, ["ignored"]).post();

    -
    -

    Type Parameters

    +
    +

    Type Parameters

    +

    R

    Parameters

      @@ -74,7 +74,7 @@
      Optional recursive:

    Returns FormDataAddon

    +
  • Defined in src/addons/formData.ts:80
    • diff --git a/docs/api/interfaces/addons_formUrl.FormUrlAddon.html b/docs/api/interfaces/addons_formUrl.FormUrlAddon.html index be00f0d..f567d6e 100644 --- a/docs/api/interfaces/addons_formUrl.FormUrlAddon.html +++ b/docs/api/interfaces/addons_formUrl.FormUrlAddon.html @@ -19,7 +19,7 @@

    Hierarchy

    • FormUrlAddon
    +
  • Defined in src/addons/formUrl.ts:24
    • @@ -42,15 +42,15 @@

    formUrlconst form = { a: 1, b: { c: 2 } };
    const alreadyEncodedForm = "a=1&b=%7B%22c%22%3A2%7D";

    // Automatically sets the content-type header to "application/x-www-form-urlencoded"
    wretch("...").addon(FormUrlAddon).formUrl(form).post();
    wretch("...").addon(FormUrlAddon).formUrl(alreadyEncodedForm).post();

    -
    -

    Type Parameters

    +
    +

    Type Parameters

    +

    R

    Parameters

    +
  • Defined in src/addons/formUrl.ts:41
    • diff --git a/docs/api/interfaces/addons_perfs.PerfsAddon.html b/docs/api/interfaces/addons_perfs.PerfsAddon.html index 3356a9e..cc7cd5d 100644 --- a/docs/api/interfaces/addons_perfs.PerfsAddon.html +++ b/docs/api/interfaces/addons_perfs.PerfsAddon.html @@ -19,7 +19,7 @@

    Hierarchy

    • PerfsAddon
    +
  • Defined in src/addons/perfs.ts:59
    • @@ -44,15 +44,15 @@

    Type declaration

    Performs a callback on the API performance timings of the request.

    Warning: Still experimental on browsers and node.js

    -
    -

    Type Parameters

    +
    +

    Type Parameters

    +

    R

    Parameters

      @@ -73,7 +73,7 @@
      timing: any

    Returns void

    Returns PerfsAddon

    +
  • Defined in src/addons/perfs.ts:65
    • diff --git a/docs/api/interfaces/addons_queryString.QueryStringAddon.html b/docs/api/interfaces/addons_queryString.QueryStringAddon.html index 968127a..870211e 100644 --- a/docs/api/interfaces/addons_queryString.QueryStringAddon.html +++ b/docs/api/interfaces/addons_queryString.QueryStringAddon.html @@ -19,7 +19,7 @@

    Hierarchy

    • QueryStringAddon
    +
  • Defined in src/addons/queryString.ts:37
    • @@ -50,15 +50,15 @@
    Note that .query is not meant to handle complex cases with nested ob 
    // Using wretch with qs

    const queryObject = { some: { nested: "objects" } };
    const w = wretch("https://example.com/").addon(QueryStringAddon)

    // Use .qs inside .query :

    w.query(qs.stringify(queryObject));

    // Use .defer :

    const qsWretch = w.defer((w, url, { qsQuery, qsOptions }) => (
      qsQuery ? w.query(qs.stringify(qsQuery, qsOptions)) : w
    ));

    qsWretch
      .url("https://example.com/")
      .options({ qs: { query: queryObject } });
    -
    -

    Type Parameters

    +
    +

    Type Parameters

    +

    R

    Parameters

      @@ -72,7 +72,7 @@
      qp: stringOptional replace: boolean

    Returns QueryStringAddon

    +
  • Defined in src/addons/queryString.ts:87
    • diff --git a/docs/api/interfaces/index.Wretch.html b/docs/api/interfaces/index.Wretch.html index 08a34f5..3fc20ab 100644 --- a/docs/api/interfaces/index.Wretch.html +++ b/docs/api/interfaces/index.Wretch.html @@ -19,7 +19,7 @@

    Interface Wretch<Self, Chain, Resolver>

    import wretch from "wretch"

    // Reusable wretch instance
    const w = wretch("https://domain.com", { mode: "cors" })

    Immutability : almost every method of this class return a fresh Wretch object.

    -
    +

    Type Parameters

      @@ -28,13 +28,13 @@

      Self = unknown

    • Chain = unknown

    • -

      Resolver = undefined

    +

    Resolver = undefined

    Hierarchy

    • Wretch
    +
  • Defined in src/types.ts:13
    • @@ -94,7 +94,7 @@
    contents: any

    Returns Wretch<Self, Chain, Resolver>

    +
  • Defined in src/types.ts:395

    • json

      @@ -119,7 +119,7 @@
      Optional contentType:

    Returns Wretch<Self, Chain, Resolver>

    +
  • Defined in src/types.ts:411

    • HTTP Methods

    @@ -140,7 +140,7 @@
    this: SelfOptional url: string

    Returns Resolver extends undefined ? Chain & WretchResponseChain<Self, Chain, Resolver> : Resolver

    +
  • Defined in src/types.ts:468

    • fetch

    +
  • Defined in src/types.ts:442

    • get

      @@ -189,7 +189,7 @@
      this: SelfOptional url: string

    Returns Resolver extends undefined ? Chain & WretchResponseChain<Self, Chain, Resolver> : Resolver

    +
  • Defined in src/types.ts:455

    • head

      @@ -208,7 +208,7 @@
      this: SelfOptional url: string

    Returns Resolver extends undefined ? Chain & WretchResponseChain<Self, Chain, Resolver> : Resolver

    +
  • Defined in src/types.ts:520

    • opts

      @@ -227,7 +227,7 @@
      this: SelfOptional url: string

    Returns Resolver extends undefined ? Chain & WretchResponseChain<Self, Chain, Resolver> : Resolver

    +
  • Defined in src/types.ts:533

    • patch

      @@ -248,7 +248,7 @@
      Optional body: Optional url: string

    Returns Resolver extends undefined ? Chain & WretchResponseChain<Self, Chain, Resolver> : Resolver

    +
  • Defined in src/types.ts:507

    • post

      @@ -269,7 +269,7 @@
      Optional body: Optional url: string

    Returns Resolver extends undefined ? Chain & WretchResponseChain<Self, Chain, Resolver> : Resolver

    +
  • Defined in src/types.ts:494

    • put

      @@ -290,7 +290,7 @@
      Optional body: Optional url: string

    Returns Resolver extends undefined ? Chain & WretchResponseChain<Self, Chain, Resolver> : Resolver

    +
  • Defined in src/types.ts:481

    • Helpers Methods

    @@ -313,7 +313,7 @@
    headerValue: string

    Returns Wretch<Self, Chain, Resolver>

    +
  • Defined in src/types.ts:207

    • addon

    Parameters

    Returns W & Self & Wretch<Self & W, Chain & R, Resolver>

    +
  • Defined in src/types.ts:64

    • auth

      @@ -360,7 +360,7 @@
      headerValue: string

    Returns Wretch<Self, Chain, Resolver>

    +
  • Defined in src/types.ts:231

    • catcher

    Returns Wretch<Self, Chain, Resolver>

    +
  • Defined in src/types.ts:282

    • content

      @@ -426,7 +426,7 @@
      headerValue: string

    Returns Wretch<Self, Chain, Resolver>

    +
  • Defined in src/types.ts:219

    • defer

    Parameters

     +
  • Defined in src/types.ts:314

    • errorType

      @@ -478,7 +478,7 @@
      method: string

    Returns Wretch<Self, Chain, Resolver>

    +
  • Defined in src/types.ts:84

    • headers

      @@ -499,7 +499,7 @@
      headerValues: HeadersInit

    Returns Wretch<Self, Chain, Resolver>

    +
  • Defined in src/types.ts:195

    • middlewares

    Returns Wretch<Self, Chain, Resolver>

    +
  • Defined in src/types.ts:381

    • options

    +
  • Defined in src/types.ts:180

    • polyfills

    +
  • Defined in src/types.ts:108

    • resolve

    Parameters

      @@ -623,7 +623,7 @@

      Returns Optional clear: Clear

    Returns Self & Wretch<Self, Chain, ResolverReturn>

    +
  • Defined in src/types.ts:350

    • url

    +
  • Defined in src/types.ts:136
    • diff --git a/docs/api/interfaces/index.WretchError.html b/docs/api/interfaces/index.WretchError.html index 3a09692..69aa4e8 100644 --- a/docs/api/interfaces/index.WretchError.html +++ b/docs/api/interfaces/index.WretchError.html @@ -24,7 +24,7 @@

    Hierarchy

    • WretchError
    +
  • Defined in src/types.ts:727
    • @@ -46,40 +46,40 @@

    Properties

    Optional json

    json?: any
    +
  • Defined in src/types.ts:727

    • message

    message: string
    +
  • Defined in node_modules/typescript/lib/lib.es5.d.ts:1041

    • name

    name: string
    +
  • Defined in node_modules/typescript/lib/lib.es5.d.ts:1040

    • response

    response: WretchResponse
    +
  • Defined in src/types.ts:727

    • Optional stack

    stack?: string
    +
  • Defined in node_modules/typescript/lib/lib.es5.d.ts:1042

    • status

    status: number
    +
  • Defined in src/types.ts:727

    • Optional text

    text?: string
    +
  • Defined in src/types.ts:727
    • diff --git a/docs/api/interfaces/index.WretchResponseChain.html b/docs/api/interfaces/index.WretchResponseChain.html index 90aba9e..7660687 100644 --- a/docs/api/interfaces/index.WretchResponseChain.html +++ b/docs/api/interfaces/index.WretchResponseChain.html @@ -17,7 +17,7 @@

    Interface WretchResponseChain<T, Self, R>

    The resolver interface to chaining catchers and extra methods after the request has been sent. Ultimately returns a Promise.

    -
    +

    Type Parameters

      @@ -26,13 +26,13 @@

      T

    • Self = unknown

    • -

      R = undefined

    +

    R = undefined

    Hierarchy

    • WretchResponseChain
    +
  • Defined in src/types.ts:544
    • @@ -84,7 +84,7 @@
    this: Selfcb: WretchErrorCallback<T, Self, R>

    Returns WretchResponseChain<T, Self, R>

    +
  • Defined in src/types.ts:653

    • error

    error: ((this: Self & WretchResponseChain<T, Self, R>, code: string | number | symbol, cb: WretchErrorCallback<T, Self, R>) => WretchResponseChain<T, Self, R>)
    @@ -112,7 +112,7 @@
    code: stringWretchErrorCallback<T, Self, R>

    Returns WretchResponseChain<T, Self, R>

    +
  • Defined in src/types.ts:644

    • fetchError

    fetchError: ((this: Self & WretchResponseChain<T, Self, R>, cb: WretchErrorCallback<T, Self, R>) => WretchResponseChain<T, Self, R>)
    @@ -136,7 +136,7 @@
    this: Selfcb: WretchErrorCallback<T, Self, R>

    Returns WretchResponseChain<T, Self, R>

    +
  • Defined in src/types.ts:707

    • forbidden

    forbidden: ((this: Self & WretchResponseChain<T, Self, R>, cb: WretchErrorCallback<T, Self, R>) => WretchResponseChain<T, Self, R>)
    @@ -161,7 +161,7 @@
    this: Selfcb: WretchErrorCallback<T, Self, R>

    Returns WretchResponseChain<T, Self, R>

    +
  • Defined in src/types.ts:671

    • internalError

    internalError: ((this: Self & WretchResponseChain<T, Self, R>, cb: WretchErrorCallback<T, Self, R>) => WretchResponseChain<T, Self, R>)
    @@ -186,7 +186,7 @@
    this: Selfcb: WretchErrorCallback<T, Self, R>

    Returns WretchResponseChain<T, Self, R>

    +
  • Defined in src/types.ts:700

    • notFound

    notFound: ((this: Self & WretchResponseChain<T, Self, R>, cb: WretchErrorCallback<T, Self, R>) => WretchResponseChain<T, Self, R>)
    @@ -211,7 +211,7 @@
    this: Selfcb: WretchErrorCallback<T, Self, R>

    Returns WretchResponseChain<T, Self, R>

    +
  • Defined in src/types.ts:680

    • timeout

    timeout: ((this: Self & WretchResponseChain<T, Self, R>, cb: WretchErrorCallback<T, Self, R>) => WretchResponseChain<T, Self, R>)
    @@ -236,7 +236,7 @@
    this: Selfcb: WretchErrorCallback<T, Self, R>

    Returns WretchResponseChain<T, Self, R>

    +
  • Defined in src/types.ts:690

    • unauthorized

    unauthorized: ((this: Self & WretchResponseChain<T, Self, R>, cb: WretchErrorCallback<T, Self, R>) => WretchResponseChain<T, Self, R>)
    @@ -261,7 +261,7 @@
    this: Selfcb: WretchErrorCallback<T, Self, R>

    Returns WretchResponseChain<T, Self, R>

    +
  • Defined in src/types.ts:662

    • Response Type Properties

    @@ -278,11 +278,11 @@

    Type declaration

    wretch("...").get().arrayBuffer(arrayBuffer => …)
    -
    -

    Type Parameters

    +
    +

    Type Parameters

    • -

      Result = ArrayBuffer

    +

    Result = ArrayBuffer

    Parameters

      @@ -301,7 +301,7 @@
      type: ArrayBuffer
    Returns Result | Promise<Result>

    Returns Promise<Awaited<Result>>

    +
  • Defined in src/types.ts:605

    • blob

    blob: (<Result>(cb?: ((type: Blob) => Result | Promise<Result>)) => Promise<Awaited<Result>>)
    @@ -316,11 +316,11 @@

    Type declaration

    wretch("...").get().blob(blob => …)
    -
    -

    Type Parameters

    +
    +

    Type Parameters

    • -

      Result = Blob

    +

    Result = Blob

    Parameters

      @@ -339,7 +339,7 @@
      type: Blob

    Returns Result | Promise<Result>

    Returns Promise<Awaited<Result>>

    +
  • Defined in src/types.ts:585

    • formData

    formData: (<Result>(cb?: ((type: FormData) => Result | Promise<Result>)) => Promise<Awaited<Result>>)
    @@ -354,11 +354,11 @@

    Type declaration

    wretch("...").get().formData(formData => …)
    -
    -

    Type Parameters

    +
    +

    Type Parameters

    • -

      Result = FormData

    +

    Result = FormData

    Parameters

      @@ -377,7 +377,7 @@
      type: FormData

    Returns Result | Promise<Result>

    Returns Promise<Awaited<Result>>

    +
  • Defined in src/types.ts:595

    • json

    json: (<Result>(cb?: ((type: any) => Result | Promise<Result>)) => Promise<Awaited<Result>>)
    @@ -389,14 +389,14 @@

    Type declaration

  • <Result>(cb?: ((type: any) => Result | Promise<Result>)): Promise<Awaited<Result>>

  • Read the payload and deserialize it as JSON.

    -
    wretch("...").get().json((json) => console.log(Object.keys(json)));
+
    wretch("...").get().json((json) => console.log(Object.keys(json)));
    -
    -

    Type Parameters

    +
    +

    Type Parameters

    • -

      Result = unknown

    +

    Result = unknown

    • Parameters

      @@ -415,7 +415,7 @@
      type: any

    Returns Result | Promise<Result>

    Returns Promise<Awaited<Result>>

    +
  • Defined in src/types.ts:575

    • res

    res: (<Result>(cb?: ((type: WretchResponse) => Result | Promise<Result>)) => Promise<Awaited<Result>>)
    @@ -431,11 +431,11 @@

    Type declaration

    wretch("...").get().res((response) => console.log(response.url));
    -
    -

    Type Parameters

    +
    +

    Type Parameters

    +

    Result = WretchResponse

    Parameters

    Returns Promise<Awaited<Result>>

     +
  • Defined in src/types.ts:565

    • text

    text: (<Result>(cb?: ((type: string) => Result | Promise<Result>)) => Promise<Awaited<Result>>)
    @@ -469,11 +469,11 @@

    Type declaration

    wretch("...").get().text((txt) => console.log(txt));
    -
    -

    Type Parameters

    +
    +

    Type Parameters

    • -

      Result = string

    +

    Result = string

    Parameters

      @@ -492,7 +492,7 @@
      type: string

    Returns Result | Promise<Result>

    Returns Promise<Awaited<Result>>

    +
  • Defined in src/types.ts:615
    • diff --git a/docs/api/modules/addons.html b/docs/api/modules/addons.html index 246d8a2..40b74d6 100644 --- a/docs/api/modules/addons.html +++ b/docs/api/modules/addons.html @@ -14,7 +14,7 @@
  • addons

    • Module addons

    +
  • Defined in src/addons/index.ts:1
    • diff --git a/docs/api/modules/addons_abort.html b/docs/api/modules/addons_abort.html index b31e759..6661c51 100644 --- a/docs/api/modules/addons_abort.html +++ b/docs/api/modules/addons_abort.html @@ -14,7 +14,7 @@
  • addons/abort

    • Module addons/abort

    +
  • Defined in src/addons/abort.ts:1
    • diff --git a/docs/api/modules/addons_formData.html b/docs/api/modules/addons_formData.html index 61d8ea7..4ea1093 100644 --- a/docs/api/modules/addons_formData.html +++ b/docs/api/modules/addons_formData.html @@ -14,7 +14,7 @@
  • addons/formData

    • Module addons/formData

    +
  • Defined in src/addons/formData.ts:1
    • diff --git a/docs/api/modules/addons_formUrl.html b/docs/api/modules/addons_formUrl.html index c22dcee..651d930 100644 --- a/docs/api/modules/addons_formUrl.html +++ b/docs/api/modules/addons_formUrl.html @@ -14,7 +14,7 @@
  • addons/formUrl

    • Module addons/formUrl

    +
  • Defined in src/addons/formUrl.ts:1
    • diff --git a/docs/api/modules/addons_perfs.html b/docs/api/modules/addons_perfs.html index f6b1f31..599b474 100644 --- a/docs/api/modules/addons_perfs.html +++ b/docs/api/modules/addons_perfs.html @@ -14,7 +14,7 @@
  • addons/perfs

    • Module addons/perfs

    +
  • Defined in src/addons/perfs.ts:1
    • diff --git a/docs/api/modules/addons_queryString.html b/docs/api/modules/addons_queryString.html index 5b73ede..6963bc4 100644 --- a/docs/api/modules/addons_queryString.html +++ b/docs/api/modules/addons_queryString.html @@ -14,7 +14,7 @@
  • addons/queryString

    • Module addons/queryString

    +
  • Defined in src/addons/queryString.ts:1
    • diff --git a/docs/api/modules/index.default.html b/docs/api/modules/index.default.html index 37fe34c..2b460ef 100644 --- a/docs/api/modules/index.default.html +++ b/docs/api/modules/index.default.html @@ -15,12 +15,12 @@
  • default

    • Namespace default

    +
  • Defined in src/index.ts:36
    • +
  • Defined in src/index.ts:40
    • +
  • Defined in src/index.ts:42
    • +
  • Defined in src/index.ts:44
    • +
  • Defined in src/index.ts:46
    • +
  • Defined in src/index.ts:47

    • Index

    diff --git a/docs/api/modules/index.html b/docs/api/modules/index.html index 64e69e8..9a48d4a 100644 --- a/docs/api/modules/index.html +++ b/docs/api/modules/index.html @@ -14,7 +14,7 @@
  • index

    • Module index

    +
  • Defined in src/index.ts:1
    • diff --git a/docs/api/modules/middlewares.html b/docs/api/modules/middlewares.html index ee97151..083bcc8 100644 --- a/docs/api/modules/middlewares.html +++ b/docs/api/modules/middlewares.html @@ -14,7 +14,7 @@
  • middlewares

    • Module middlewares

    +
  • Defined in src/middlewares/index.ts:1
    • diff --git a/docs/api/modules/middlewares_dedupe.html b/docs/api/modules/middlewares_dedupe.html index c150e89..2d1d00a 100644 --- a/docs/api/modules/middlewares_dedupe.html +++ b/docs/api/modules/middlewares_dedupe.html @@ -14,7 +14,7 @@
  • middlewares/dedupe

    • Module middlewares/dedupe

    +
  • Defined in src/middlewares/dedupe.ts:1
    • diff --git a/docs/api/modules/middlewares_delay.html b/docs/api/modules/middlewares_delay.html index e7955c9..26e6082 100644 --- a/docs/api/modules/middlewares_delay.html +++ b/docs/api/modules/middlewares_delay.html @@ -14,7 +14,7 @@
  • middlewares/delay

    • Module middlewares/delay

    +
  • Defined in src/middlewares/delay.ts:1
    • diff --git a/docs/api/modules/middlewares_retry.html b/docs/api/modules/middlewares_retry.html index 83b6637..e2ff5dd 100644 --- a/docs/api/modules/middlewares_retry.html +++ b/docs/api/modules/middlewares_retry.html @@ -14,7 +14,7 @@
  • middlewares/retry

    • Module middlewares/retry

    +
  • Defined in src/middlewares/retry.ts:1
    • diff --git a/docs/api/modules/middlewares_throttlingCache.html b/docs/api/modules/middlewares_throttlingCache.html index ba3374f..5bfc086 100644 --- a/docs/api/modules/middlewares_throttlingCache.html +++ b/docs/api/modules/middlewares_throttlingCache.html @@ -14,7 +14,7 @@
  • middlewares/throttlingCache

    • Module middlewares/throttlingCache

    +
  • Defined in src/middlewares/throttlingCache.ts:1
    • diff --git a/docs/api/types/index.Config.html b/docs/api/types/index.Config.html index b1ad332..444c37f 100644 --- a/docs/api/types/index.Config.html +++ b/docs/api/types/index.Config.html @@ -14,7 +14,7 @@
  • index
  • Config

    • Type alias Config

    -
    Config: { errorType: string; options: {}; polyfills: {}; polyfill: any }
    +
    Config: {
        errorType: string;
        options: {};
        polyfills: {};
        polyfill: any;
    }

    Configuration object.

    @@ -46,9 +46,9 @@
    Optional instance: Rest ...args: any[]

    Returns any

    +
  • Defined in src/types.ts:713
    • diff --git a/docs/api/types/index.ConfiguredMiddleware.html b/docs/api/types/index.ConfiguredMiddleware.html index 4378b08..892199a 100644 --- a/docs/api/types/index.ConfiguredMiddleware.html +++ b/docs/api/types/index.ConfiguredMiddleware.html @@ -33,7 +33,7 @@

    Parameters

    next: FetchLike

    Returns FetchLike

    +
  • Defined in src/types.ts:751
    • diff --git a/docs/api/types/index.FetchLike.html b/docs/api/types/index.FetchLike.html index 321831e..4681323 100644 --- a/docs/api/types/index.FetchLike.html +++ b/docs/api/types/index.FetchLike.html @@ -33,7 +33,7 @@
    url: string
    opts: WretchOptions

    Returns Promise<WretchResponse>

    +
  • Defined in src/types.ts:755
    • diff --git a/docs/api/types/index.Middleware.html b/docs/api/types/index.Middleware.html index 44290f0..5ab6881 100644 --- a/docs/api/types/index.Middleware.html +++ b/docs/api/types/index.Middleware.html @@ -14,13 +14,13 @@
  • index
  • Middleware

    • Type alias Middleware

    -
    Middleware: ((options?: { [key: string]: any }) => ConfiguredMiddleware)
    +
    Middleware: ((options?: {
        [key: string]: any;
    }) => ConfiguredMiddleware)

    Type declaration

      • -
      • (options?: { [key: string]: any }): ConfiguredMiddleware
        • +
      • (options?: {
            [key: string]: any;
        }): ConfiguredMiddleware

      • Shape of a typical middleware. Expects options and returns a ConfiguredMiddleware that can then be registered using the .middlewares function.

        @@ -29,13 +29,13 @@

        Type declaration

        Parameters

        • -
          Optional options: { [key: string]: any }
          +
          Optional options: {
              [key: string]: any;
          }
          • [key: string]: any

        Returns ConfiguredMiddleware

    +
  • Defined in src/types.ts:745
    • diff --git a/docs/api/types/index.WretchAddon.html b/docs/api/types/index.WretchAddon.html index 8f791cc..4540985 100644 --- a/docs/api/types/index.WretchAddon.html +++ b/docs/api/types/index.WretchAddon.html @@ -14,15 +14,16 @@
  • index
  • WretchAddon

    • Type alias WretchAddon<W, R>

    -
    WretchAddon<W, R>: { resolver?: R; wretch?: W; beforeRequest?: any }
    +
    WretchAddon<W, R>: {
        resolver?: R;
        wretch?: W;
        beforeRequest?: any;
    }

    An addon enhancing either the request or response chain (or both).

    -

    Type Parameters

    +
    +

    Type Parameters

    • W extends unknown

    • -

      R extends unknown = unknown

    +

    R extends unknown = unknown

    Type declaration

      @@ -35,15 +36,15 @@
      beforeRequest?:function
      • beforeRequest<T, C, R>(wretch: Wretch<T, C, R>, options: WretchOptions): void
      • -
        -

        Type Parameters

        +
        +

        Type Parameters

        • T

        • C

        • -

          R

        +

        R

    Parameters

    Returns void

    +
  • Defined in src/types.ts:760
    • diff --git a/docs/api/types/index.WretchDeferredCallback.html b/docs/api/types/index.WretchDeferredCallback.html index 32d5b12..4effd61 100644 --- a/docs/api/types/index.WretchDeferredCallback.html +++ b/docs/api/types/index.WretchDeferredCallback.html @@ -15,14 +15,15 @@
  • WretchDeferredCallback

    • Type alias WretchDeferredCallback<T, C, R>

    WretchDeferredCallback<T, C, R>: ((wretch: T & Wretch<T, C, R>, url: string, options: WretchOptions) => Wretch<T, C, any>)
    -

    Type Parameters

    +
    +

    Type Parameters

    • T

    • C

    • -

      R

    +

    R

    Type declaration

    Returns Wretch<T, C, any>

    +
  • Defined in src/types.ts:739
    • diff --git a/docs/api/types/index.WretchErrorCallback.html b/docs/api/types/index.WretchErrorCallback.html index f638c67..32fb9af 100644 --- a/docs/api/types/index.WretchErrorCallback.html +++ b/docs/api/types/index.WretchErrorCallback.html @@ -15,14 +15,15 @@
  • WretchErrorCallback

    • Type alias WretchErrorCallback<T, C, R>

    WretchErrorCallback<T, C, R>: ((error: WretchError, originalRequest: Wretch<T, C, R>) => any)
    -

    Type Parameters

    +
    +

    Type Parameters

    • T

    • C

    • -

      R

    +

    R

    Type declaration

      @@ -41,7 +42,7 @@
      error: Wretch<T, C, R>

    Returns any

    +
  • Defined in src/types.ts:731
    • diff --git a/docs/api/types/index.WretchOptions.html b/docs/api/types/index.WretchOptions.html index 51111d0..8f2585c 100644 --- a/docs/api/types/index.WretchOptions.html +++ b/docs/api/types/index.WretchOptions.html @@ -18,7 +18,7 @@

    Type alias WretchOptions

    Fetch Request options with additional properties.

    +
  • Defined in src/types.ts:723
    • diff --git a/docs/api/types/index.WretchResponse.html b/docs/api/types/index.WretchResponse.html index 7a2baf5..9782421 100644 --- a/docs/api/types/index.WretchResponse.html +++ b/docs/api/types/index.WretchResponse.html @@ -14,11 +14,11 @@
  • index
  • WretchResponse

    • Type alias WretchResponse

    -
    WretchResponse: Response & { [key: string]: any }
    +
    WretchResponse: Response & {
        [key: string]: any;
    }

    Fetch Response object with additional properties.

    +
  • Defined in src/types.ts:735
    • diff --git a/docs/api/types/middlewares_dedupe.DedupeKeyFunction.html b/docs/api/types/middlewares_dedupe.DedupeKeyFunction.html index a27530f..14962fe 100644 --- a/docs/api/types/middlewares_dedupe.DedupeKeyFunction.html +++ b/docs/api/types/middlewares_dedupe.DedupeKeyFunction.html @@ -31,7 +31,7 @@
    url: string
    opts: WretchOptions

    Returns string

    +
  • Defined in src/middlewares/dedupe.ts:6
    • diff --git a/docs/api/types/middlewares_dedupe.DedupeMiddleware.html b/docs/api/types/middlewares_dedupe.DedupeMiddleware.html index 298bec9..dbfe6ad 100644 --- a/docs/api/types/middlewares_dedupe.DedupeMiddleware.html +++ b/docs/api/types/middlewares_dedupe.DedupeMiddleware.html @@ -58,7 +58,7 @@

    Parameters

    Optional options: DedupeOptions

    Returns ConfiguredMiddleware

    +
  • Defined in src/middlewares/dedupe.ts:33
    • diff --git a/docs/api/types/middlewares_dedupe.DedupeOptions.html b/docs/api/types/middlewares_dedupe.DedupeOptions.html index 60eab3d..ef50704 100644 --- a/docs/api/types/middlewares_dedupe.DedupeOptions.html +++ b/docs/api/types/middlewares_dedupe.DedupeOptions.html @@ -14,7 +14,7 @@
  • middlewares/dedupe
  • DedupeOptions

    • Type alias DedupeOptions

    -
    DedupeOptions: { key?: DedupeKeyFunction; resolver?: DedupeResolverFunction; skip?: DedupeSkipFunction }
    +
    DedupeOptions: {
        key?: DedupeKeyFunction;
        resolver?: DedupeResolverFunction;
        skip?: DedupeSkipFunction;
    }

    Type declaration

    +
  • Defined in src/middlewares/dedupe.ts:8
    • diff --git a/docs/api/types/middlewares_dedupe.DedupeResolverFunction.html b/docs/api/types/middlewares_dedupe.DedupeResolverFunction.html index 2d4ae9b..af55e4e 100644 --- a/docs/api/types/middlewares_dedupe.DedupeResolverFunction.html +++ b/docs/api/types/middlewares_dedupe.DedupeResolverFunction.html @@ -29,7 +29,7 @@

    Parameters

    response: Response

    Returns Response

    +
  • Defined in src/middlewares/dedupe.ts:7
    • diff --git a/docs/api/types/middlewares_dedupe.DedupeSkipFunction.html b/docs/api/types/middlewares_dedupe.DedupeSkipFunction.html index 9d440fb..52622d4 100644 --- a/docs/api/types/middlewares_dedupe.DedupeSkipFunction.html +++ b/docs/api/types/middlewares_dedupe.DedupeSkipFunction.html @@ -31,7 +31,7 @@
    url: string
    opts: WretchOptions

    Returns boolean

    +
  • Defined in src/middlewares/dedupe.ts:5
    • diff --git a/docs/api/types/middlewares_delay.DelayMiddleware.html b/docs/api/types/middlewares_delay.DelayMiddleware.html index d69d486..c9f8500 100644 --- a/docs/api/types/middlewares_delay.DelayMiddleware.html +++ b/docs/api/types/middlewares_delay.DelayMiddleware.html @@ -45,7 +45,7 @@

    Parameters

    time: number

    Returns ConfiguredMiddleware

    +
  • Defined in src/middlewares/delay.ts:16
    • diff --git a/docs/api/types/middlewares_retry.DelayRampFunction.html b/docs/api/types/middlewares_retry.DelayRampFunction.html index 5546106..af3f127 100644 --- a/docs/api/types/middlewares_retry.DelayRampFunction.html +++ b/docs/api/types/middlewares_retry.DelayRampFunction.html @@ -31,7 +31,7 @@
    delay: number
    nbOfAttempts: number

    Returns number

    +
  • Defined in src/middlewares/retry.ts:5
    • diff --git a/docs/api/types/middlewares_retry.OnRetryFunction.html b/docs/api/types/middlewares_retry.OnRetryFunction.html index ec2b514..57a0c67 100644 --- a/docs/api/types/middlewares_retry.OnRetryFunction.html +++ b/docs/api/types/middlewares_retry.OnRetryFunction.html @@ -14,19 +14,19 @@
  • middlewares/retry
  • OnRetryFunction

    • Type alias OnRetryFunction

    -
    OnRetryFunction: ((args: { error?: Error; options: WretchOptions; response?: Response; url: string }) => void | OnRetryFunctionResponse | Promise<OnRetryFunctionResponse>)
    +
    OnRetryFunction: ((args: {
        error?: Error;
        options: WretchOptions;
        response?: Response;
        url: string;
    }) => void | OnRetryFunctionResponse | Promise<OnRetryFunctionResponse>)

    Type declaration

    +
  • Defined in src/middlewares/retry.ts:8
    • diff --git a/docs/api/types/middlewares_retry.OnRetryFunctionResponse.html b/docs/api/types/middlewares_retry.OnRetryFunctionResponse.html index c3e02b3..a2ccc1d 100644 --- a/docs/api/types/middlewares_retry.OnRetryFunctionResponse.html +++ b/docs/api/types/middlewares_retry.OnRetryFunctionResponse.html @@ -14,9 +14,9 @@
  • middlewares/retry
  • OnRetryFunctionResponse

    • Type alias OnRetryFunctionResponse

    -
    OnRetryFunctionResponse: { options?: WretchOptions; url?: string } | undefined
    +
  • Defined in src/middlewares/retry.ts:7
    • diff --git a/docs/api/types/middlewares_retry.RetryMiddleware.html b/docs/api/types/middlewares_retry.RetryMiddleware.html index f1f2913..498133b 100644 --- a/docs/api/types/middlewares_retry.RetryMiddleware.html +++ b/docs/api/types/middlewares_retry.RetryMiddleware.html @@ -40,7 +40,7 @@

    Parameters

    Optional options: RetryOptions

    Returns ConfiguredMiddleware

    +
  • Defined in src/middlewares/retry.ts:92
    • diff --git a/docs/api/types/middlewares_retry.RetryOptions.html b/docs/api/types/middlewares_retry.RetryOptions.html index ee41d07..ff30921 100644 --- a/docs/api/types/middlewares_retry.RetryOptions.html +++ b/docs/api/types/middlewares_retry.RetryOptions.html @@ -14,7 +14,7 @@
  • middlewares/retry
  • RetryOptions

    • Type alias RetryOptions

    -
    RetryOptions: { delayRamp?: DelayRampFunction; delayTimer?: number; maxAttempts?: number; onRetry?: OnRetryFunction; resolveWithLatestResponse?: boolean; retryOnNetworkError?: boolean; until?: UntilFunction }
    +
    RetryOptions: {
        delayRamp?: DelayRampFunction;
        delayTimer?: number;
        maxAttempts?: number;
        onRetry?: OnRetryFunction;
        resolveWithLatestResponse?: boolean;
        retryOnNetworkError?: boolean;
        until?: UntilFunction;
    }

    Type declaration

    +
  • Defined in src/middlewares/retry.ts:14
    • diff --git a/docs/api/types/middlewares_retry.UntilFunction.html b/docs/api/types/middlewares_retry.UntilFunction.html index defc273..1c376b1 100644 --- a/docs/api/types/middlewares_retry.UntilFunction.html +++ b/docs/api/types/middlewares_retry.UntilFunction.html @@ -31,7 +31,7 @@
    Optional response: Optional error: Error

    Returns boolean | Promise<boolean>

    +
  • Defined in src/middlewares/retry.ts:6
    • diff --git a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheClearFunction.html b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheClearFunction.html index 925fa11..ac1c419 100644 --- a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheClearFunction.html +++ b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheClearFunction.html @@ -31,7 +31,7 @@
    url: string
    opts: WretchOptions

    Returns boolean

    +
  • Defined in src/middlewares/throttlingCache.ts:7
    • diff --git a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheConditionFunction.html b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheConditionFunction.html index d87c166..e578823 100644 --- a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheConditionFunction.html +++ b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheConditionFunction.html @@ -29,7 +29,7 @@

    Parameters

    response: WretchOptions

    Returns boolean

    +
  • Defined in src/middlewares/throttlingCache.ts:9
    • diff --git a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheInvalidateFunction.html b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheInvalidateFunction.html index 1c8ce04..67d1b82 100644 --- a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheInvalidateFunction.html +++ b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheInvalidateFunction.html @@ -31,7 +31,7 @@
    url: string
    opts: WretchOptions

    Returns string | RegExp | void

    +
  • Defined in src/middlewares/throttlingCache.ts:8
    • diff --git a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheKeyFunction.html b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheKeyFunction.html index 26cd18a..1c59970 100644 --- a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheKeyFunction.html +++ b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheKeyFunction.html @@ -31,7 +31,7 @@
    url: string
    opts: WretchOptions

    Returns string

    +
  • Defined in src/middlewares/throttlingCache.ts:6
    • diff --git a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheMiddleware.html b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheMiddleware.html index 6f0cd86..3e3209c 100644 --- a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheMiddleware.html +++ b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheMiddleware.html @@ -14,13 +14,13 @@
  • middlewares/throttlingCache
  • ThrottlingCacheMiddleware

    • Type alias ThrottlingCacheMiddleware

    -
    ThrottlingCacheMiddleware: ((options?: ThrottlingCacheOptions) => ConfiguredMiddleware & { cache: Map<any, any>; inflight: Map<any, any>; throttling: Set<unknown>; cacheResponse: any })
    +
    ThrottlingCacheMiddleware: ((options?: ThrottlingCacheOptions) => ConfiguredMiddleware & {
        cache: Map<any, any>;
        inflight: Map<any, any>;
        throttling: Set<unknown>;
        cacheResponse: any;
    })

    Type declaration

    +
  • Defined in src/middlewares/throttlingCache.ts:56
    • diff --git a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheOptions.html b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheOptions.html index 4b5e57c..501486c 100644 --- a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheOptions.html +++ b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheOptions.html @@ -14,7 +14,7 @@
  • middlewares/throttlingCache
  • ThrottlingCacheOptions

    • Type alias ThrottlingCacheOptions

    -
    ThrottlingCacheOptions: { clear?: ThrottlingCacheClearFunction; condition?: ThrottlingCacheConditionFunction; flagResponseOnCacheHit?: string; invalidate?: ThrottlingCacheInvalidateFunction; key?: ThrottlingCacheKeyFunction; skip?: ThrottlingCacheSkipFunction; throttle?: number }
    +
    ThrottlingCacheOptions: {
        clear?: ThrottlingCacheClearFunction;
        condition?: ThrottlingCacheConditionFunction;
        flagResponseOnCacheHit?: string;
        invalidate?: ThrottlingCacheInvalidateFunction;
        key?: ThrottlingCacheKeyFunction;
        skip?: ThrottlingCacheSkipFunction;
        throttle?: number;
    }

    Type declaration

      @@ -33,7 +33,7 @@
      Optional skip
      Optional throttle?: number
    +
  • Defined in src/middlewares/throttlingCache.ts:10
    • diff --git a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheSkipFunction.html b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheSkipFunction.html index 429948f..06fd66d 100644 --- a/docs/api/types/middlewares_throttlingCache.ThrottlingCacheSkipFunction.html +++ b/docs/api/types/middlewares_throttlingCache.ThrottlingCacheSkipFunction.html @@ -31,7 +31,7 @@
    url: string
    opts: WretchOptions

    Returns boolean

    +
  • Defined in src/middlewares/throttlingCache.ts:5
    • diff --git a/docs/api/variables/addons_formData.default.html b/docs/api/variables/addons_formData.default.html index 23a341c..a368842 100644 --- a/docs/api/variables/addons_formData.default.html +++ b/docs/api/variables/addons_formData.default.html @@ -20,7 +20,7 @@

    Variable defaultConst

    +
  • Defined in src/addons/formData.ts:92
    • diff --git a/docs/api/variables/addons_formUrl.default.html b/docs/api/variables/addons_formUrl.default.html index 53d9157..2a5dd4d 100644 --- a/docs/api/variables/addons_formUrl.default.html +++ b/docs/api/variables/addons_formUrl.default.html @@ -20,7 +20,7 @@

    Variable defaultConst

    +
  • Defined in src/addons/formUrl.ts:53
    • diff --git a/docs/api/variables/addons_queryString.default.html b/docs/api/variables/addons_queryString.default.html index fc70ea5..7ae787e 100644 --- a/docs/api/variables/addons_queryString.default.html +++ b/docs/api/variables/addons_queryString.default.html @@ -20,7 +20,7 @@

    Variable defaultConst

    +
  • Defined in src/addons/queryString.ts:99
    • diff --git a/docs/api/variables/index.default.WretchError.html b/docs/api/variables/index.default.WretchError.html index 838aaf8..a7bc1ce 100644 --- a/docs/api/variables/index.default.WretchError.html +++ b/docs/api/variables/index.default.WretchError.html @@ -17,7 +17,7 @@

    Variable WretchError

    WretchError: typeof WretchError
    +
  • Defined in src/index.ts:47
    • diff --git a/docs/api/variables/index.default.default.html b/docs/api/variables/index.default.default.html index 3c5ab5c..e2544c9 100644 --- a/docs/api/variables/index.default.default.html +++ b/docs/api/variables/index.default.default.html @@ -17,7 +17,7 @@

    Variable default

    default: typeof default
    +
  • Defined in src/index.ts:40
    • diff --git a/docs/api/variables/index.default.errorType.html b/docs/api/variables/index.default.errorType.html index 59e8937..2f10f48 100644 --- a/docs/api/variables/index.default.errorType.html +++ b/docs/api/variables/index.default.errorType.html @@ -36,7 +36,7 @@

    Parameters

    errorType: string

    Returns void

    +
  • Defined in src/index.ts:44
    • diff --git a/docs/api/variables/index.default.options.html b/docs/api/variables/index.default.options.html index 69f814d..6fedcd8 100644 --- a/docs/api/variables/index.default.options.html +++ b/docs/api/variables/index.default.options.html @@ -40,7 +40,7 @@
    replace: booleanReturns void
    +
  • Defined in src/index.ts:42
    • diff --git a/docs/api/variables/index.default.polyfills.html b/docs/api/variables/index.default.polyfills.html index e76ff46..02a175e 100644 --- a/docs/api/variables/index.default.polyfills.html +++ b/docs/api/variables/index.default.polyfills.html @@ -42,7 +42,7 @@
    replace: booleanReturns void
    +
  • Defined in src/index.ts:46
    • diff --git a/package.json b/package.json index 222b8ab..06d22ee 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "wretch", - "version": "2.1.4", + "version": "2.1.5", "type": "module", "description": "A tiny wrapper built around fetch with an intuitive syntax.", "keywords": [