From: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Date: Mon, 8 May 2023 12:04:06 +0000 (+0000)
Subject: chore: generate documentation
X-Git-Tag: v2.4.13~1
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=493f77bdef6d66ad2fcb72b405c805274b24f3db;p=poolifier.git
chore: generate documentation
---
diff --git a/docs/assets/main.js b/docs/assets/main.js
index 4bd47a25..4c8fa615 100644
--- a/docs/assets/main.js
+++ b/docs/assets/main.js
@@ -1,7 +1,7 @@
"use strict";
"use strict";(()=>{var Se=Object.create;var re=Object.defineProperty;var we=Object.getOwnPropertyDescriptor;var Te=Object.getOwnPropertyNames;var ke=Object.getPrototypeOf,Qe=Object.prototype.hasOwnProperty;var Pe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Ie=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Te(e))!Qe.call(t,i)&&i!==r&&re(t,i,{get:()=>e[i],enumerable:!(n=we(e,i))||n.enumerable});return t};var Ce=(t,e,r)=>(r=t!=null?Se(ke(t)):{},Ie(e||!t||!t.__esModule?re(r,"default",{value:t,enumerable:!0}):r,t));var ae=Pe((se,oe)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var d=t.utils.clone(r)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(n.slice(a,o),d))}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,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index.
`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(r+=n[u+1]*i[d+1],u+=2,d+=2);return r},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),r=1,n=0;r0){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 l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,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 u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),y;m in s.node.edges?y=s.node.edges[m]:(y=new t.TokenSet,s.node.edges[m]=y),s.str.length==1&&(y.final=!0),i.push({node:y,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.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(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},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,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<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 r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,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 r=e.peekLexeme();if(r!=null)switch(r.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 n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.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 r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.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 '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;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 r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;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,r){typeof define=="function"&&define.amd?define(r):typeof se=="object"?oe.exports=r():e.lunr=r()}(this,function(){return t})})()});var ne=[];function G(t,e){ne.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){ne.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n,app:this}),n.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),r=e?.parentElement;for(;r&&!r.classList.contains(".tsd-navigation");)r instanceof HTMLDetailsElement&&(r.open=!0),r=r.parentElement;if(e){let n=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=n}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let r=e.parentElement;for(;r&&r.tagName!=="SECTION";)r=r.parentElement;if(r&&r.offsetParent==null){this.alwaysVisibleMember=r,r.classList.add("always-visible");let n=document.createElement("p");n.classList.add("warning"),n.textContent="This member is normally hidden due to your filter settings.",r.prepend(n)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let r;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(r),r=setTimeout(()=>{e.classList.remove("visible"),r=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let r;return()=>{clearTimeout(r),r=setTimeout(()=>t(),e)}};var ce=Ce(ae());function de(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("tsd-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 r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Oe(t,n,r,s)}function Oe(t,e,r,n){r.addEventListener("input",ie(()=>{Re(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Fe(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function _e(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=ce.Index.load(window.searchData.index))}function Re(t,e,r,n){if(_e(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=i?n.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${le(l.parent,i)}.${u}`);let d=document.createElement("li");d.classList.value=l.classes??"";let m=document.createElement("a");m.href=n.base+l.url,m.innerHTML=u,d.append(m),e.appendChild(d)}}function ue(t,e){let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let n=r;if(e===1)do n=n.nextElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);else do n=n.previousElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);n&&(r.classList.remove("current"),n.classList.add("current"))}}function Fe(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function le(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+n.length))} `),s=o+n.length,o=r.indexOf(n,s);return i.push(K(t.substring(s))),i.join("")}var Me={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Me[e])}var P=class{constructor(e){this.el=e.el,this.app=e.app}};var M="mousedown",fe="mousemove",N="mouseup",J={x:0,y:0},he=!1,ee=!1,De=!1,D=!1,pe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(pe?"is-mobile":"not-mobile");pe&&"ontouchstart"in document.documentElement&&(De=!0,M="touchstart",fe="touchmove",N="touchend");document.addEventListener(M,t=>{ee=!0,D=!1;let e=M=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=M=="touchstart"?t.targetTouches[0]:t,r=J.x-(e.pageX||0),n=J.y-(e.pageY||0);D=Math.sqrt(r*r+n*n)>10}});document.addEventListener(N,()=>{ee=!1});document.addEventListener("click",t=>{he&&(t.preventDefault(),t.stopImmediatePropagation(),he=!1)});var X=class extends P{constructor(r){super(r);this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(M,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,n=>this.onDocumentPointerUp(n))}setActive(r){if(this.active==r)return;this.active=r,document.documentElement.classList.toggle("has-"+this.className,r),this.el.classList.toggle("active",r);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(r){D||(this.setActive(!0),r.preventDefault())}onDocumentPointerDown(r){if(this.active){if(r.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(r){if(!D&&this.active&&r.target.closest(".col-sidebar")){let n=r.target.closest("a");if(n){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),n.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var me=document.head.appendChild(document.createElement("style"));me.dataset.for="filters";var Y=class extends P{constructor(r){super(r);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),me.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; }
-`}fromLocalStorage(){let r=Q.getItem(this.key);return r?r==="true":this.el.checked}setLocalStorage(r){Q.setItem(this.key,r.toString()),this.value=r,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let n=Array.from(r.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);r.style.display=n?"none":"block"})}};var Z=class extends P{constructor(r){super(r);this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update()),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ve(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}de();G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var ge=document.getElementById("tsd-theme");ge&&ve(ge);var Ae=new U;Object.defineProperty(window,"app",{value:Ae});})();
+`}fromLocalStorage(){let r=Q.getItem(this.key);return r?r==="true":this.el.checked}setLocalStorage(r){Q.setItem(this.key,r.toString()),this.value=r,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let n=Array.from(r.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);r.style.display=n?"none":"block"})}};var Z=class extends P{constructor(r){super(r);this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update()),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ve(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}de();G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var ge=document.getElementById("tsd-theme");ge&&ve(ge);var Ae=new U;Object.defineProperty(window,"app",{value:Ae});document.querySelectorAll("summary a").forEach(t=>{t.addEventListener("click",()=>{location.assign(t.href)})});})();
/*! Bundled license information:
lunr/lunr.js:
diff --git a/docs/assets/style.css b/docs/assets/style.css
index 5b967176..18b4f8fe 100644
--- a/docs/assets/style.css
+++ b/docs/assets/style.css
@@ -770,9 +770,11 @@ a.tsd-index-link {
color: var(--color-text);
}
.tsd-accordion-summary {
- list-style-type: none;
- display: flex;
- align-items: center;
+ list-style-type: none; /* hide marker on non-safari */
+ outline: none; /* broken on safari, so just hide it */
+}
+.tsd-accordion-summary::-webkit-details-marker {
+ display: none; /* hide marker on safari */
}
.tsd-accordion-summary,
.tsd-accordion-summary a {
@@ -784,7 +786,7 @@ a.tsd-index-link {
cursor: pointer;
}
.tsd-accordion-summary a {
- flex-grow: 1;
+ width: calc(100% - 1.5rem);
}
.tsd-accordion-summary > * {
margin-top: 0;
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 2fbe8e0e..9064de67 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -45,7 +45,7 @@
IPool < Worker , Data , Response >
+Defined in src/pools/abstract-pool.ts:35
@@ -150,7 +150,7 @@
Returns AbstractPool < Worker , Data , Response >
+Defined in src/pools/abstract-pool.ts:77
Readonly
file Path
file Path : string
+Defined in src/pools/abstract-pool.ts:79
Readonly
number Of Workers
number Of Workers : number
+Defined in src/pools/abstract-pool.ts:78
+Defined in src/pools/abstract-pool.ts:80
Protected
promise Response Map
@@ -198,7 +198,7 @@
When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
+Defined in src/pools/abstract-pool.ts:54
Protected
worker Choice Strategy Context
@@ -206,7 +206,7 @@
Default to a round robin algorithm.
+Defined in src/pools/abstract-pool.ts:64
Readonly
worker Nodes
@@ -214,7 +214,7 @@
+Defined in src/pools/abstract-pool.ts:41
Protected
Abstract
full
@@ -238,7 +238,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:324
Private
number Of Queued Tasks
@@ -248,7 +248,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:229
Private
number Of Running Tasks
@@ -258,7 +258,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:219
+Defined in src/pools/abstract-pool.ts:214
+Defined in src/pools/abstract-pool.ts:211
Methods
@@ -305,7 +305,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:423
Protected
Abstract
after Worker Setup
@@ -323,7 +323,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:513
Protected
before Task Execution Hook
@@ -341,7 +341,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:412
Private
build Tasks Queue Options
@@ -354,7 +354,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:311
Private
check And Emit Events
@@ -362,7 +362,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:571
Private
check File Path
@@ -375,7 +375,7 @@ Can be overridden.
filePath : string
Returns void
+Defined in src/pools/abstract-pool.ts:114
Private
check Number Of Workers
@@ -388,7 +388,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:123
Private
check Pool Options
@@ -401,7 +401,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:141
Private
check Valid Tasks Queue Options
@@ -414,7 +414,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:195
Private
check Valid Worker Choice Strategy
@@ -427,7 +427,7 @@ Can be overridden.
workerChoiceStrategy : "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
Returns void
+Defined in src/pools/abstract-pool.ts:167
Private
check Valid Worker Choice Strategy Options
@@ -440,7 +440,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:177
Protected
choose Worker Node
@@ -452,7 +452,7 @@ Can be overridden.
Returns [ number , WorkerNode < Worker , Data > ] [worker node key, worker node].
+Defined in src/pools/abstract-pool.ts:457
Protected
create And Setup Worker
@@ -463,7 +463,7 @@ Can be overridden.
Returns Worker New, completely set up worker.
+Defined in src/pools/abstract-pool.ts:520
Protected
Abstract
create Worker
@@ -473,7 +473,7 @@ Can be overridden.
Returns Worker
+Defined in src/pools/abstract-pool.ts:504
Private
dequeue Task
@@ -486,7 +486,7 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:658
+Defined in src/pools/abstract-pool.ts:375
Protected
Abstract
destroy Worker
@@ -514,7 +514,7 @@ Can be overridden.
Returns void | Promise < void >
+Defined in src/pools/abstract-pool.ts:389
+Defined in src/pools/abstract-pool.ts:289
Private
enqueue Task
@@ -551,7 +551,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:654
+Defined in src/pools/abstract-pool.ts:342
Private
execute Task
@@ -589,7 +589,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:649
Private
flush Tasks Queue
@@ -602,7 +602,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:666
Private
flush Tasks Queues
@@ -610,7 +610,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:677
Private
get Worker Node Key
@@ -628,7 +628,7 @@ Can be overridden.
Returns number The worker node key if the worker is found in the pool worker nodes, -1
otherwise.
+Defined in src/pools/abstract-pool.ts:245
Protected
internal Busy
@@ -636,7 +636,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:333
Protected
Abstract
is Main
@@ -646,7 +646,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:404
Private
push Worker Node
@@ -664,7 +664,7 @@ Can be overridden.
Returns number The worker nodes length.
+Defined in src/pools/abstract-pool.ts:601
Protected
Abstract
register Worker Message Listener
@@ -701,7 +701,7 @@ Can be overridden.
Returns void
Returns void
+Defined in src/pools/abstract-pool.ts:497
Private
remove Worker Node
@@ -718,7 +718,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:643
Protected
Abstract
send To Worker
@@ -739,7 +739,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:486
+Defined in src/pools/abstract-pool.ts:301
+Defined in src/pools/abstract-pool.ts:252
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:278
Private
set Worker Node
@@ -826,7 +826,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:625
Private
set Worker Node Tasks Usage
@@ -847,7 +847,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:588
Protected
setup Hook
@@ -858,7 +858,7 @@ Can be overridden
Returns void
+Defined in src/pools/abstract-pool.ts:397
Private
tasks Queue Size
@@ -871,7 +871,7 @@ Can be overridden
workerNodeKey : number
Returns number
+Defined in src/pools/abstract-pool.ts:662
+Defined in src/pools/abstract-pool.ts:543
Returns void
+Defined in src/worker/abstract-worker.ts:98
Private
check Worker Options
Returns void
+Defined in src/worker/abstract-worker.ts:86
+Defined in src/worker/abstract-worker.ts:162
Private
get Task Function
@@ -290,7 +290,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:261
Protected
handle Error
@@ -308,7 +308,7 @@ never be called.
Returns string Message of the error.
+Defined in src/worker/abstract-worker.ts:194
Protected
message Listener
@@ -325,7 +325,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:138
Protected
run Async
@@ -346,7 +346,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:231
run In Async Scope
@@ -418,7 +418,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:204
Protected
Abstract
send To Main Worker
@@ -435,7 +435,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:174
trigger Async Id
diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html
index 438b9b5b..4bfbe0e7 100644
--- a/docs/classes/CircularArray.html
+++ b/docs/classes/CircularArray.html
@@ -30,7 +30,7 @@
+Defined in src/circular-array.ts:8
+Defined in src/circular-array.ts:11
Properties
@@ -148,7 +148,7 @@ when they will be absent when used in a 'with' statement.
size
size : number
+Defined in src/circular-array.ts:9
Static
Readonly
[species]
[species] : ArrayConstructor
@@ -198,7 +198,7 @@ when they will be absent when used in a 'with' statement.
size : number
Returns void
+Defined in src/circular-array.ts:88
concat
@@ -214,7 +214,7 @@ when they will be absent when used in a 'with' statement.
+Defined in src/circular-array.ts:39
copy Within
@@ -251,7 +251,7 @@ is treated as length+end.
Returns boolean
+Defined in src/circular-array.ts:80
entries
@@ -686,7 +686,7 @@ thisArg is omitted, undefined is used as the this value.
Returns boolean
+Defined in src/circular-array.ts:84
includes
@@ -851,7 +851,7 @@ If the array is empty, undefined is returned and the array is not modified.
Returns number
+Defined in src/circular-array.ts:21
reduce
@@ -1076,7 +1076,7 @@ If the array is empty, undefined is returned and the array is not modified.
size : number
Returns void
+Defined in src/circular-array.ts:68
reverse
@@ -1222,7 +1222,7 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
Returns T []
+Defined in src/circular-array.ts:54
to Locale String
@@ -1260,7 +1260,7 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
Returns number
+Defined in src/circular-array.ts:30
values
diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html
index 48ce7804..6cbc5ebd 100644
--- a/docs/classes/ClusterWorker.html
+++ b/docs/classes/ClusterWorker.html
@@ -44,7 +44,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/cluster-worker.ts:25
@@ -109,7 +109,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/cluster-worker.ts:35
Protected
Readonly
is Main
is Main : boolean
@@ -127,7 +127,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:54
Protected
last Task Timestamp
last Task Timestamp : number
@@ -135,7 +135,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:38
Protected
main Worker
main Worker : undefined | null | Worker
@@ -143,7 +143,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:58
Protected
Readonly
opts
@@ -151,7 +151,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:59
Protected
task Functions
@@ -159,7 +159,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:34
+Defined in src/worker/abstract-worker.ts:162
+Defined in src/worker/cluster-worker.ts:56
Protected
message Listener
+Defined in src/worker/abstract-worker.ts:138
+Defined in src/worker/abstract-worker.ts:231
+Defined in src/worker/abstract-worker.ts:204
Protected
send To Main Worker
+Defined in src/worker/cluster-worker.ts:51
trigger Async Id
diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html
index e297aed1..9686cbdf 100644
--- a/docs/classes/DynamicClusterPool.html
+++ b/docs/classes/DynamicClusterPool.html
@@ -42,7 +42,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/cluster/dynamic.ts:16
@@ -132,7 +132,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/cluster/dynamic.ts:28
Properties
@@ -147,7 +147,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:44
Readonly
file Path
file Path : string
@@ -155,14 +155,14 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:79
+Defined in src/pools/cluster/dynamic.ts:30
Readonly
number Of Workers
number Of Workers : number
@@ -170,7 +170,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:78
Readonly
opts
@@ -178,7 +178,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/cluster/fixed.ts:53
Protected
promise Response Map
@@ -191,7 +191,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:54
Protected
worker Choice Strategy Context
@@ -200,7 +200,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:64
Readonly
worker Nodes
@@ -208,7 +208,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:41
Accessors
@@ -222,7 +222,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Returns boolean
+Defined in src/pools/cluster/dynamic.ts:53
+Defined in src/pools/cluster/dynamic.ts:48
Private
number Of Queued Tasks
+Defined in src/pools/abstract-pool.ts:229
Private
number Of Running Tasks
+Defined in src/pools/abstract-pool.ts:219
+Defined in src/pools/cluster/dynamic.ts:43
+Defined in src/pools/cluster/dynamic.ts:38
Protected
after Worker Setup
+Defined in src/pools/cluster/fixed.ts:93
Protected
before Task Execution Hook
+Defined in src/pools/abstract-pool.ts:412
Protected
choose Worker Node
+Defined in src/pools/abstract-pool.ts:457
Protected
create And Setup Worker
+Defined in src/pools/abstract-pool.ts:520
+Defined in src/pools/cluster/fixed.ts:88
+Defined in src/pools/abstract-pool.ts:375
+Defined in src/pools/cluster/fixed.ts:69
+Defined in src/pools/abstract-pool.ts:289
+Defined in src/pools/abstract-pool.ts:342
+Defined in src/pools/abstract-pool.ts:333
+Defined in src/pools/cluster/fixed.ts:64
Protected
register Worker Message Listener
+Defined in src/pools/cluster/fixed.ts:80
+Defined in src/pools/cluster/fixed.ts:75
+Defined in src/pools/abstract-pool.ts:301
+Defined in src/pools/abstract-pool.ts:252
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:278
+Defined in src/pools/cluster/fixed.ts:59
Protected
worker Listener
@@ -628,7 +628,7 @@ Can be overridden
+Defined in src/pools/abstract-pool.ts:543
+Defined in src/pools/abstract-pool.ts:78
Readonly
opts
@@ -178,7 +178,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:80
Protected
promise Response Map
@@ -191,7 +191,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:54
Protected
worker Choice Strategy Context
@@ -200,7 +200,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:64
Readonly
worker Nodes
@@ -208,7 +208,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:41
Accessors
@@ -222,7 +222,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Returns boolean
+Defined in src/pools/thread/dynamic.ts:54
+Defined in src/pools/thread/dynamic.ts:44
Private
number Of Queued Tasks
+Defined in src/pools/abstract-pool.ts:229
Private
number Of Running Tasks
+Defined in src/pools/abstract-pool.ts:219
+Defined in src/pools/thread/dynamic.ts:49
+Defined in src/pools/thread/dynamic.ts:39
Protected
after Worker Setup
+Defined in src/pools/thread/fixed.ts:85
Protected
before Task Execution Hook
+Defined in src/pools/abstract-pool.ts:412
Protected
choose Worker Node
+Defined in src/pools/abstract-pool.ts:457
Protected
create And Setup Worker
+Defined in src/pools/abstract-pool.ts:520
+Defined in src/pools/thread/fixed.ts:78
+Defined in src/pools/abstract-pool.ts:375
+Defined in src/pools/thread/fixed.ts:54
+Defined in src/pools/abstract-pool.ts:289
+Defined in src/pools/abstract-pool.ts:342
+Defined in src/pools/abstract-pool.ts:333
+Defined in src/pools/thread/fixed.ts:49
Protected
register Worker Message Listener
+Defined in src/pools/thread/fixed.ts:70
+Defined in src/pools/thread/fixed.ts:62
+Defined in src/pools/abstract-pool.ts:301
+Defined in src/pools/abstract-pool.ts:252
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:278
+Defined in src/pools/abstract-pool.ts:397
Protected
worker Listener
@@ -628,7 +628,7 @@ Can be overridden
+Defined in src/pools/abstract-pool.ts:543
+Defined in src/pools/abstract-pool.ts:78
Readonly
opts
@@ -168,7 +168,7 @@
+Defined in src/pools/cluster/fixed.ts:53
Protected
promise Response Map
@@ -181,7 +181,7 @@
+Defined in src/pools/abstract-pool.ts:54
Protected
worker Choice Strategy Context
@@ -190,7 +190,7 @@
+Defined in src/pools/abstract-pool.ts:64
Readonly
worker Nodes
@@ -198,7 +198,7 @@
+Defined in src/pools/abstract-pool.ts:41
+Defined in src/pools/cluster/fixed.ts:109
Private
number Of Queued Tasks
+Defined in src/pools/abstract-pool.ts:229
Private
number Of Running Tasks
+Defined in src/pools/abstract-pool.ts:219
+Defined in src/pools/cluster/fixed.ts:104
+Defined in src/pools/cluster/fixed.ts:99
Protected
after Worker Setup
+Defined in src/pools/cluster/fixed.ts:93
Protected
before Task Execution Hook
+Defined in src/pools/abstract-pool.ts:412
Protected
choose Worker Node
+Defined in src/pools/abstract-pool.ts:457
Protected
create And Setup Worker
+Defined in src/pools/abstract-pool.ts:520
+Defined in src/pools/cluster/fixed.ts:88
+Defined in src/pools/abstract-pool.ts:375
+Defined in src/pools/cluster/fixed.ts:69
+Defined in src/pools/abstract-pool.ts:289
+Defined in src/pools/abstract-pool.ts:342
+Defined in src/pools/abstract-pool.ts:333
+Defined in src/pools/cluster/fixed.ts:64
Protected
register Worker Message Listener
+Defined in src/pools/cluster/fixed.ts:80
+Defined in src/pools/cluster/fixed.ts:75
+Defined in src/pools/abstract-pool.ts:301
+Defined in src/pools/abstract-pool.ts:252
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:278
+Defined in src/pools/cluster/fixed.ts:59
Protected
worker Listener
@@ -618,7 +618,7 @@ Can be overridden
+Defined in src/pools/abstract-pool.ts:543
+Defined in src/pools/abstract-pool.ts:78
Readonly
opts
@@ -168,7 +168,7 @@
+Defined in src/pools/abstract-pool.ts:80
Protected
promise Response Map
@@ -181,7 +181,7 @@
+Defined in src/pools/abstract-pool.ts:54
Protected
worker Choice Strategy Context
@@ -190,7 +190,7 @@
+Defined in src/pools/abstract-pool.ts:64
Readonly
worker Nodes
@@ -198,7 +198,7 @@
+Defined in src/pools/abstract-pool.ts:41
+Defined in src/pools/thread/fixed.ts:105
Private
number Of Queued Tasks
+Defined in src/pools/abstract-pool.ts:229
Private
number Of Running Tasks
+Defined in src/pools/abstract-pool.ts:219
+Defined in src/pools/thread/fixed.ts:100
+Defined in src/pools/thread/fixed.ts:95
Protected
after Worker Setup
+Defined in src/pools/thread/fixed.ts:85
Protected
before Task Execution Hook
+Defined in src/pools/abstract-pool.ts:412
Protected
choose Worker Node
+Defined in src/pools/abstract-pool.ts:457
Protected
create And Setup Worker
+Defined in src/pools/abstract-pool.ts:520
+Defined in src/pools/thread/fixed.ts:78
+Defined in src/pools/abstract-pool.ts:375
+Defined in src/pools/thread/fixed.ts:54
+Defined in src/pools/abstract-pool.ts:289
+Defined in src/pools/abstract-pool.ts:342
+Defined in src/pools/abstract-pool.ts:333
+Defined in src/pools/thread/fixed.ts:49
Protected
register Worker Message Listener
+Defined in src/pools/thread/fixed.ts:70
+Defined in src/pools/thread/fixed.ts:62
+Defined in src/pools/abstract-pool.ts:301
+Defined in src/pools/abstract-pool.ts:252
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:278
+Defined in src/pools/abstract-pool.ts:397
Protected
worker Listener
@@ -618,7 +618,7 @@ Can be overridden
+Defined in src/pools/abstract-pool.ts:543
+Defined in src/worker/abstract-worker.ts:38
Protected
main Worker
main Worker : undefined | null | MessagePort
@@ -143,7 +143,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:58
Protected
Readonly
opts
@@ -151,7 +151,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:59
Protected
task Functions
@@ -159,7 +159,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:34
+Defined in src/worker/abstract-worker.ts:162
+Defined in src/worker/abstract-worker.ts:194
Protected
message Listener
+Defined in src/worker/abstract-worker.ts:138
+Defined in src/worker/abstract-worker.ts:231
+Defined in src/worker/abstract-worker.ts:204
Protected
send To Main Worker
+Defined in src/worker/thread-worker.ts:51
trigger Async Id
diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html
index 83b2657a..e46e6c05 100644
--- a/docs/classes/WorkerChoiceStrategyContext.html
+++ b/docs/classes/WorkerChoiceStrategyContext.html
@@ -38,7 +38,7 @@
WorkerChoiceStrategyContext
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:24
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:41
Private
worker Choice Strategy
worker Choice Strategy : "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:43
get Required Statistics
@@ -137,7 +137,7 @@
The required statistics.
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:95
remove
@@ -155,7 +155,7 @@
Returns boolean true
if the removal is successful, false
otherwise.
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:154
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:167
set Worker Choice Strategy
Returns void
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:108
update
@@ -205,7 +205,7 @@
Returns boolean true
if the update is successful, false
otherwise.
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:122
+Defined in src/pools/pool.ts:75
Optional
exit Handler
@@ -91,7 +91,7 @@
+Defined in src/pools/pool.ts:83
Optional
message Handler
@@ -99,7 +99,7 @@
+Defined in src/pools/pool.ts:71
Optional
online Handler
@@ -107,7 +107,7 @@
+Defined in src/pools/pool.ts:79
+Defined in src/pools/cluster/fixed.ts:24
Optional
tasks Queue Options
@@ -124,7 +124,7 @@
+Defined in src/pools/pool.ts:109
Optional
worker Choice Strategy
worker Choice Strategy ?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
@@ -134,7 +134,7 @@
+Defined in src/pools/pool.ts:89
Optional
worker Choice Strategy Options
@@ -142,7 +142,7 @@
+Defined in src/pools/pool.ts:93
+Defined in src/pools/pool.ts:146
enable Tasks Queue
enable Tasks Queue : ( ( enable , tasksQueueOptions ? ) => void )
@@ -115,7 +115,7 @@
Returns void
+Defined in src/pools/pool.ts:183
execute
execute : ( ( data ? , name ? ) => Promise < Response > )
@@ -142,7 +142,7 @@
Returns Promise < Response > Promise that will be fulfilled when the task is completed.
+Defined in src/pools/pool.ts:154
set Tasks Queue Options
set Tasks Queue Options : ( ( tasksQueueOptions ) => void )
@@ -164,7 +164,7 @@
Returns void
+Defined in src/pools/pool.ts:192
set Worker Choice Strategy
set Worker Choice Strategy : ( ( workerChoiceStrategy , workerChoiceStrategyOptions ? ) => void )
@@ -190,7 +190,7 @@
Returns void
+Defined in src/pools/pool.ts:165
set Worker Choice Strategy Options
set Worker Choice Strategy Options : ( ( workerChoiceStrategyOptions ) => void )
@@ -212,14 +212,14 @@
Returns void
+Defined in src/pools/pool.ts:174
Readonly
size
size : number
+Defined in src/pools/pool.ts:133
Readonly
type
@@ -227,14 +227,14 @@
If it is 'dynamic'
, it provides the max
property.
+Defined in src/pools/pool.ts:129
+Defined in src/pools/pool.ts:137
Returns void
+Defined in src/pools/worker.ts:110
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:84
set Options
set Options : ( ( opts ) => void )
@@ -123,7 +123,7 @@
Returns void
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:109
update
update : ( ( workerNodeKey ) => boolean )
@@ -144,7 +144,7 @@
Returns boolean true
if the update is successful, false
otherwise.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:90
+Defined in src/pools/worker.ts:43
Optional
Readonly
parent
parent ?: MainWorker
+Defined in src/utility-types.ts:39
Optional
Readonly
run Time
run Time ?: number
+Defined in src/utility-types.ts:35
+Defined in src/pools/pool.ts:89
Optional
worker Choice Strategy Options
+Defined in src/pools/pool.ts:93
Returns void
+Defined in src/utility-types.ts:102
Readonly
worker
worker : Worker
+Defined in src/utility-types.ts:110
+Defined in src/pools/worker.ts:23
Path to the worker file.