From 396360a789e4806699533ddf899c79dc2b7ae868 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 24 Apr 2023 05:40:08 +0000 Subject: [PATCH] chore: generate documentation --- docs/assets/main.js | 6 +- docs/classes/AbstractPool.html | 106 +++++++++--------- docs/classes/AbstractWorker.html | 32 +++--- docs/classes/CircularArray.html | 22 ++-- docs/classes/ClusterWorker.html | 28 ++--- docs/classes/DynamicClusterPool.html | 68 +++++------ docs/classes/DynamicThreadPool.html | 68 +++++------ docs/classes/FixedClusterPool.html | 66 +++++------ docs/classes/FixedThreadPool.html | 66 +++++------ docs/classes/PoolEmitter.html | 2 +- docs/classes/ThreadWorker.html | 28 ++--- docs/classes/WorkerChoiceStrategyContext.html | 18 +-- docs/enums/PoolType.html | 6 +- docs/interfaces/ClusterPoolOptions.html | 24 ++-- docs/interfaces/IPool.html | 20 ++-- docs/interfaces/IWorker.html | 6 +- docs/interfaces/IWorkerChoiceStrategy.html | 12 +- docs/interfaces/MessageValue.html | 14 +-- docs/interfaces/PoolOptions.html | 20 ++-- docs/interfaces/PromiseResponseWrapper.html | 8 +- docs/interfaces/RequiredStatistics.html | 8 +- docs/interfaces/Task.html | 6 +- docs/interfaces/TasksQueueOptions.html | 4 +- docs/interfaces/TasksUsage.html | 16 +-- .../WorkerChoiceStrategyOptions.html | 4 +- docs/interfaces/WorkerNode.html | 8 +- docs/interfaces/WorkerOptions.html | 8 +- docs/types/Draft.html | 2 +- docs/types/ErrorHandler.html | 2 +- docs/types/ExitHandler.html | 2 +- docs/types/KillBehavior.html | 2 +- docs/types/MessageHandler.html | 2 +- docs/types/OnlineHandler.html | 2 +- docs/types/PoolEvent.html | 2 +- .../types/ThreadWorkerWithMessageChannel.html | 2 +- docs/types/WorkerAsyncFunction.html | 2 +- docs/types/WorkerChoiceStrategy.html | 2 +- docs/types/WorkerFunction.html | 2 +- docs/types/WorkerSyncFunction.html | 2 +- docs/variables/KillBehaviors.html | 2 +- docs/variables/PoolEvents.html | 2 +- docs/variables/WorkerChoiceStrategies.html | 2 +- 42 files changed, 352 insertions(+), 352 deletions(-) diff --git a/docs/assets/main.js b/docs/assets/main.js index 5e525428..4bd47a25 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,7 +1,7 @@ "use strict"; -"use strict";(()=>{var be=Object.create;var re=Object.defineProperty;var Se=Object.getOwnPropertyDescriptor;var we=Object.getOwnPropertyNames;var Te=Object.getPrototypeOf,ke=Object.prototype.hasOwnProperty;var Qe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Pe=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of we(e))!ke.call(t,i)&&i!==r&&re(t,i,{get:()=>e[i],enumerable:!(n=Se(e,i))||n.enumerable});return t};var Ie=(t,e,r)=>(r=t!=null?be(Te(t)):{},Pe(e||!t||!t.__esModule?re(r,"default",{value:t,enumerable:!0}):r,t));var ae=Qe((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(),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&&e?.parentElement?.parentElement!==r&&(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)}}};var ie=(t,e=100)=>{let r;return()=>{clearTimeout(r),r=setTimeout(()=>t(),e)}};var ce=Ie(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+"/"};Ce(t,n,r,s)}function Ce(t,e,r,n){r.addEventListener("input",ie(()=>{_e(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Re(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 Oe(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 _e(t,e,r,n){if(Oe(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 Re(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 F="mousedown",fe="mousemove",N="mouseup",J={x:0,y:0},he=!1,ee=!1,Fe=!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&&(Fe=!0,F="touchstart",fe="touchmove",N="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=F=="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(F,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}addEventListener("load",()=>{de(),De(),G(X,"a[data-toggle]"),G(Z,".tsd-index-accordion"),G(Y,".tsd-filter-item input[type=checkbox]");let t=document.getElementById("tsd-theme");t&&ve(t);let e=new U;Object.defineProperty(window,"app",{value:e})});function De(){document.querySelectorAll("pre > button").forEach(t=>{let e;t.addEventListener("click",()=>{t.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(t.previousElementSibling.innerText.trim()),t.textContent="Copied!",t.classList.add("visible"),clearTimeout(e),e=setTimeout(()=>{t.classList.remove("visible"),e=setTimeout(()=>{t.textContent="Copy"},100)},1e3)})})}})(); +"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});})(); /*! Bundled license information: lunr/lunr.js: diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 5b3d2996..2377e5ef 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:33
    • @@ -150,7 +150,7 @@

    Returns AbstractPool<Worker, Data, Response>

    +
  • Defined in src/pools/abstract-pool.ts:75

    • Properties

    @@ -165,28 +165,28 @@
    +
  • Defined in src/pools/abstract-pool.ts:42

    • Readonly filePath

    filePath: string

    Path to the worker file.

    +
  • Defined in src/pools/abstract-pool.ts:77

    • Readonly numberOfWorkers

    numberOfWorkers: number

    Number of workers that this pool should manage.

    +
  • Defined in src/pools/abstract-pool.ts:76

    • Readonly opts

    opts: PoolOptions<Worker>

    Options for the pool.

    +
  • Defined in src/pools/abstract-pool.ts:78

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -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:52

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -206,7 +206,7 @@

    Default to a round robin algorithm.

    +
  • Defined in src/pools/abstract-pool.ts:62

    • Readonly workerNodes

    workerNodes: WorkerNode<Worker, Data>[] = []
    @@ -214,7 +214,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:39

    • Accessors

    @@ -227,7 +227,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:296

    • Protected Abstract full

    +
  • Defined in src/pools/abstract-pool.ts:289

    • Private numberOfQueuedTasks

    +
  • Defined in src/pools/abstract-pool.ts:195

    • Private numberOfRunningTasks

    +
  • Defined in src/pools/abstract-pool.ts:185

    • Abstract type

    +
  • Defined in src/pools/abstract-pool.ts:180

    • Methods

    @@ -294,7 +294,7 @@ Can be overridden.

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:386

    • Protected Abstract afterWorkerSetup

      @@ -312,7 +312,7 @@ Can be overridden.

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:474

    • Protected beforeTaskExecutionHook

      @@ -330,7 +330,7 @@ Can be overridden.

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:375

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:276

    • Private checkAndEmitEvents

    +
  • Defined in src/pools/abstract-pool.ts:532

    • Private checkFilePath

      @@ -364,7 +364,7 @@ Can be overridden.

      filePath: string

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:112

    • Private checkNumberOfWorkers

      @@ -377,7 +377,7 @@ Can be overridden.

      numberOfWorkers: number

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:121

    • Private checkPoolOptions

      @@ -390,7 +390,7 @@ Can be overridden.

      opts: PoolOptions<Worker>

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:139

    • Private checkValidTasksQueueOptions

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:167

    • Private checkValidWorkerChoiceStrategy

      @@ -416,7 +416,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:157

    • Protected chooseWorkerNode

    +
  • Defined in src/pools/abstract-pool.ts:419

    • Protected createAndSetupWorker

    +
  • Defined in src/pools/abstract-pool.ts:481

    • Protected Abstract createWorker

    +
  • Defined in src/pools/abstract-pool.ts:465

    • Private dequeueTask

      @@ -462,7 +462,7 @@ Can be overridden.

      workerNodeKey: number

    Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:634

    • destroy

    +
  • Defined in src/pools/abstract-pool.ts:338

    • Protected Abstract destroyWorker

      @@ -490,7 +490,7 @@ Can be overridden.

    Returns void | Promise<void>

    +
  • Defined in src/pools/abstract-pool.ts:352

    • enableTasksQueue

    +
  • Defined in src/pools/abstract-pool.ts:254

    • Private enqueueTask

      @@ -527,7 +527,7 @@ Can be overridden.

      task: Task<Data>

    Returns number

    +
  • Defined in src/pools/abstract-pool.ts:630

    • execute

    +
  • Defined in src/pools/abstract-pool.ts:307

    • Private executeTask

      @@ -561,7 +561,7 @@ Can be overridden.

      task: Task<Data>

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:625

    • Private flushTasksQueue

      @@ -574,7 +574,7 @@ Can be overridden.

      workerNodeKey: number

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:642

    • Private flushTasksQueueByWorker

      @@ -587,7 +587,7 @@ Can be overridden.

      worker: Worker

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:650

    • Private flushTasksQueues

    +
  • Defined in src/pools/abstract-pool.ts:655

    • Private getWorkerNodeKey

      @@ -613,7 +613,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:211

    • Private getWorkerTasksUsage

    +
  • Defined in src/pools/abstract-pool.ts:563

    • Protected internalBusy

    +
  • Defined in src/pools/abstract-pool.ts:298

    • Protected Abstract isMain

    +
  • Defined in src/pools/abstract-pool.ts:367

    • Private pushWorkerNode

    +
  • Defined in src/pools/abstract-pool.ts:577

    • Protected Abstract registerWorkerMessageListener

      @@ -706,7 +706,7 @@ Can be overridden.

      Returns void

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:458

    • Private removeWorkerNode

      @@ -723,7 +723,7 @@ Can be overridden.

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:619

    • Protected Abstract sendToWorker

      @@ -744,7 +744,7 @@ Can be overridden.

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:447

    • setTasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:266

    • setWorkerChoiceStrategy

    +
  • Defined in src/pools/abstract-pool.ts:218

    • setWorkerChoiceStrategyOptions

    +
  • Defined in src/pools/abstract-pool.ts:244

    • Private setWorkerNode

      @@ -831,7 +831,7 @@ Can be overridden.

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:601

    • Private setWorkerNodeTasksUsage

      @@ -852,7 +852,7 @@ Can be overridden.

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:549

    • Protected setupHook

    +
  • Defined in src/pools/abstract-pool.ts:360

    • Private tasksQueueSize

      @@ -876,7 +876,7 @@ Can be overridden

      workerNodeKey: number

    Returns number

    +
  • Defined in src/pools/abstract-pool.ts:638

    • Protected workerListener

      @@ -901,7 +901,7 @@ Can be overridden

      Returns void

      The listener function to execute when a message is received from a worker.

    +
  • Defined in src/pools/abstract-pool.ts:504
    • diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index ee6528c7..f24250c6 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -43,7 +43,7 @@
  • ClusterWorker
  • ThreadWorker
    • +
  • Defined in src/worker/abstract-worker.ts:24
    • @@ -123,7 +123,7 @@

    Returns AbstractWorker<MainWorker, Data, Response>

    +
  • Defined in src/worker/abstract-worker.ts:46

    • Properties

    @@ -132,35 +132,35 @@

    Handler id of the aliveInterval worker alive check.

    +
  • Defined in src/worker/abstract-worker.ts:36

    • Protected Readonly isMain

    isMain: boolean

    Whether this is the main worker or not.

    +
  • Defined in src/worker/abstract-worker.ts:48

    • Protected lastTaskTimestamp

    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

    +
  • Defined in src/worker/abstract-worker.ts:32

    • Protected mainWorker

    mainWorker: undefined | null | MainWorker

    Reference to main worker.

    +
  • Defined in src/worker/abstract-worker.ts:50

    • Protected Readonly opts

    opts: WorkerOptions = ...

    Options for the worker.

    +
  • Defined in src/worker/abstract-worker.ts:51

    • Methods

    @@ -210,7 +210,7 @@ the AsyncResource to which the function is bound.

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:156

    • Private checkFunctionInput

      @@ -227,7 +227,7 @@ the AsyncResource to which the function is bound.

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:95

    • Private checkWorkerOptions

      @@ -240,7 +240,7 @@ the AsyncResource to which the function is bound.

      opts: WorkerOptions

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:83

    • emitDestroy

    +
  • Defined in src/worker/abstract-worker.ts:139

    • Protected handleError

    +
  • Defined in src/worker/abstract-worker.ts:171

    • Protected messageListener

      @@ -305,7 +305,7 @@ never be called.

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:113

    • Protected run

      @@ -326,7 +326,7 @@ never be called.

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:181

    • Protected runAsync

      @@ -347,7 +347,7 @@ never be called.

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:208

    • runInAsyncScope

      @@ -415,7 +415,7 @@ then restore the original execution context.

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:151

    • triggerAsyncId

      diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html index 3604f40d..25451dfd 100644 --- a/docs/classes/CircularArray.html +++ b/docs/classes/CircularArray.html @@ -30,7 +30,7 @@
      • CircularArray
    +
  • Defined in src/circular-array.ts:8
    • @@ -112,7 +112,7 @@

    Returns CircularArray<T>

    +
  • 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
    +
  • Defined in src/circular-array.ts:88

    • concat

    +
  • Defined in src/circular-array.ts:39

    • copyWithin

    +
  • 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

    • toLocaleString

      @@ -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 0ac4865d..1db68505 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -44,7 +44,7 @@ but the minimum number of workers will be guaranteed.

      • ClusterWorker
    +
  • Defined in src/worker/cluster-worker.ts:21
    • @@ -108,7 +108,7 @@ but the minimum number of workers will be guaranteed.

    Returns ClusterWorker<Data, Response>

    +
  • Defined in src/worker/cluster-worker.ts:31

    • Properties

    @@ -118,7 +118,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:36

    • Protected Readonly isMain

    isMain: boolean
    @@ -126,7 +126,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:48

    • Protected lastTaskTimestamp

    lastTaskTimestamp: number
    @@ -134,7 +134,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:32

    • Protected mainWorker

    mainWorker: undefined | null | Worker
    @@ -142,7 +142,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:50

    • Protected Readonly opts

    opts: WorkerOptions = ...
    @@ -150,7 +150,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:51

    • Methods

    @@ -201,7 +201,7 @@ the AsyncResource to which the function is bound.

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:156

    • emitDestroy

    +
  • Defined in src/worker/abstract-worker.ts:139

    • Protected handleError

    +
  • Defined in src/worker/cluster-worker.ts:50

    • Protected messageListener

    +
  • Defined in src/worker/abstract-worker.ts:113

    • Protected run

    +
  • Defined in src/worker/abstract-worker.ts:181

    • Protected runAsync

    +
  • Defined in src/worker/abstract-worker.ts:208

    • runInAsyncScope

    +
  • Defined in src/worker/cluster-worker.ts:45

    • triggerAsyncId

      diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 03fbe182..d03d1f4d 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
      • DynamicClusterPool
    +
  • Defined in src/pools/cluster/dynamic.ts:16
    • @@ -131,7 +131,7 @@ When the maximum number of workers is reached and workers are busy, an event is

    Returns DynamicClusterPool<Data, Response>

    +
  • Defined in src/pools/cluster/dynamic.ts:28

    • Properties

    @@ -146,7 +146,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:42

    • Readonly filePath

    filePath: string
    @@ -154,14 +154,14 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:77

    • Readonly max

    max: number

    Maximum number of workers that can be created by this pool.

    +
  • Defined in src/pools/cluster/dynamic.ts:30

    • Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -169,7 +169,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:76

    • Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -177,7 +177,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 promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -190,7 +190,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:52

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -199,7 +199,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:62

    • Readonly workerNodes

    workerNodes: WorkerNode<Worker, Data>[] = []
    @@ -207,7 +207,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:39

    • Accessors

    @@ -221,7 +221,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:48

    • Protected full

      @@ -233,7 +233,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:43

    • Private numberOfQueuedTasks

      @@ -244,7 +244,7 @@ When the maximum number of workers is reached and workers are busy, an event is

      Returns number

    +
  • Defined in src/pools/abstract-pool.ts:195

    • Private numberOfRunningTasks

      @@ -255,7 +255,7 @@ When the maximum number of workers is reached and workers are busy, an event is

      Returns number

    +
  • Defined in src/pools/abstract-pool.ts:185

    • type

    +
  • Defined in src/pools/cluster/dynamic.ts:38

    • Methods

    @@ -292,7 +292,7 @@ Can be overridden.

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:386

    • Protected afterWorkerSetup

    +
  • Defined in src/pools/cluster/fixed.ts:93

    • Protected beforeTaskExecutionHook

    +
  • Defined in src/pools/abstract-pool.ts:375

    • Protected chooseWorkerNode

    +
  • Defined in src/pools/abstract-pool.ts:419

    • Protected createAndSetupWorker

    +
  • Defined in src/pools/abstract-pool.ts:481

    • Protected createWorker

    +
  • Defined in src/pools/cluster/fixed.ts:88

    • destroy

    +
  • Defined in src/pools/abstract-pool.ts:338

    • Protected destroyWorker

    +
  • Defined in src/pools/cluster/fixed.ts:69

    • enableTasksQueue

    +
  • Defined in src/pools/abstract-pool.ts:254

    • execute

    +
  • Defined in src/pools/abstract-pool.ts:307

    • Protected internalBusy

    +
  • Defined in src/pools/abstract-pool.ts:298

    • Protected isMain

    +
  • Defined in src/pools/cluster/fixed.ts:64

    • Protected registerWorkerMessageListener

    +
  • Defined in src/pools/cluster/fixed.ts:80

    • Protected sendToWorker

    +
  • Defined in src/pools/cluster/fixed.ts:75

    • setTasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:266

    • setWorkerChoiceStrategy

    +
  • Defined in src/pools/abstract-pool.ts:218

    • setWorkerChoiceStrategyOptions

    +
  • Defined in src/pools/abstract-pool.ts:244

    • Protected setupHook

    +
  • Defined in src/pools/cluster/fixed.ts:59

    • Protected workerListener

      @@ -612,7 +612,7 @@ Can be overridden

    +
  • Defined in src/pools/abstract-pool.ts:504
    • diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 734d1642..0c8848b6 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -42,7 +42,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    • DynamicThreadPool
    +
  • Defined in src/pools/thread/dynamic.ts:17
    • @@ -131,7 +131,7 @@ When the maximum number of threads is reached and workers are busy, an event is

    Returns DynamicThreadPool<Data, Response>

    +
  • Defined in src/pools/thread/dynamic.ts:29

    • Properties

    @@ -146,7 +146,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:42

    • Readonly filePath

    filePath: string
    @@ -154,14 +154,14 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:77

    • Readonly max

    max: number

    Maximum number of threads that can be created by this pool.

    +
  • Defined in src/pools/thread/dynamic.ts:31

    • Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -169,7 +169,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:76

    • Readonly opts

    opts: PoolOptions<ThreadWorkerWithMessageChannel>
    @@ -177,7 +177,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:78

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    @@ -190,7 +190,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:52

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    @@ -199,7 +199,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:62

    • Readonly workerNodes

    workerNodes: WorkerNode<ThreadWorkerWithMessageChannel, Data>[] = []
    @@ -207,7 +207,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:39

    • Accessors

    @@ -221,7 +221,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:49

    • Protected full

      @@ -233,7 +233,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:44

    • Private numberOfQueuedTasks

      @@ -244,7 +244,7 @@ When the maximum number of threads is reached and workers are busy, an event is

      Returns number

    +
  • Defined in src/pools/abstract-pool.ts:195

    • Private numberOfRunningTasks

      @@ -255,7 +255,7 @@ When the maximum number of threads is reached and workers are busy, an event is

      Returns number

    +
  • Defined in src/pools/abstract-pool.ts:185

    • type

      @@ -267,7 +267,7 @@ When the maximum number of threads is reached and workers are busy, an event is

      Returns PoolType

    +
  • Defined in src/pools/thread/dynamic.ts:39

    • Methods

    @@ -292,7 +292,7 @@ Can be overridden.

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:386

    • Protected afterWorkerSetup

    +
  • Defined in src/pools/thread/fixed.ts:85

    • Protected beforeTaskExecutionHook

    +
  • Defined in src/pools/abstract-pool.ts:375

    • Protected chooseWorkerNode

    +
  • Defined in src/pools/abstract-pool.ts:419

    • Protected createAndSetupWorker

    +
  • Defined in src/pools/abstract-pool.ts:481

    • Protected createWorker

    +
  • Defined in src/pools/thread/fixed.ts:78

    • destroy

    +
  • Defined in src/pools/abstract-pool.ts:338

    • Protected destroyWorker

    +
  • Defined in src/pools/thread/fixed.ts:54

    • enableTasksQueue

    +
  • Defined in src/pools/abstract-pool.ts:254

    • execute

    +
  • Defined in src/pools/abstract-pool.ts:307

    • Protected internalBusy

    +
  • Defined in src/pools/abstract-pool.ts:298

    • Protected isMain

    +
  • Defined in src/pools/thread/fixed.ts:49

    • Protected registerWorkerMessageListener

    +
  • Defined in src/pools/thread/fixed.ts:70

    • Protected sendToWorker

    +
  • Defined in src/pools/thread/fixed.ts:62

    • setTasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:266

    • setWorkerChoiceStrategy

    +
  • Defined in src/pools/abstract-pool.ts:218

    • setWorkerChoiceStrategyOptions

    +
  • Defined in src/pools/abstract-pool.ts:244

    • Protected setupHook

    +
  • Defined in src/pools/abstract-pool.ts:360

    • Protected workerListener

      @@ -612,7 +612,7 @@ Can be overridden

    +
  • Defined in src/pools/abstract-pool.ts:504
    • diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 412adcef..7ce5b2fb 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -44,7 +44,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:39
    • @@ -128,7 +128,7 @@

    Returns FixedClusterPool<Data, Response>

    +
  • Defined in src/pools/cluster/fixed.ts:50

    • Properties

    @@ -143,7 +143,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:42

    • Readonly filePath

    filePath: string
    @@ -151,7 +151,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:77

    • Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -159,7 +159,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:76

    • Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -167,7 +167,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:53

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -180,7 +180,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:52

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -189,7 +189,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:62

    • Readonly workerNodes

    workerNodes: WorkerNode<Worker, Data>[] = []
    @@ -197,7 +197,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:39

    • Accessors

    @@ -211,7 +211,7 @@

    Returns boolean

    +
  • Defined in src/pools/cluster/fixed.ts:109

    • Protected full

    +
  • Defined in src/pools/cluster/fixed.ts:104

    • Private numberOfQueuedTasks

    +
  • Defined in src/pools/abstract-pool.ts:195

    • Private numberOfRunningTasks

    +
  • Defined in src/pools/abstract-pool.ts:185

    • type

    +
  • Defined in src/pools/cluster/fixed.ts:99

    • Methods

    @@ -282,7 +282,7 @@ Can be overridden.

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:386

    • Protected afterWorkerSetup

    +
  • Defined in src/pools/cluster/fixed.ts:93

    • Protected beforeTaskExecutionHook

    +
  • Defined in src/pools/abstract-pool.ts:375

    • Protected chooseWorkerNode

    +
  • Defined in src/pools/abstract-pool.ts:419

    • Protected createAndSetupWorker

    +
  • Defined in src/pools/abstract-pool.ts:481

    • Protected createWorker

    +
  • Defined in src/pools/cluster/fixed.ts:88

    • destroy

    +
  • Defined in src/pools/abstract-pool.ts:338

    • Protected destroyWorker

    +
  • Defined in src/pools/cluster/fixed.ts:69

    • enableTasksQueue

    +
  • Defined in src/pools/abstract-pool.ts:254

    • execute

    +
  • Defined in src/pools/abstract-pool.ts:307

    • Protected internalBusy

    +
  • Defined in src/pools/abstract-pool.ts:298

    • Protected isMain

    +
  • Defined in src/pools/cluster/fixed.ts:64

    • Protected registerWorkerMessageListener

    +
  • Defined in src/pools/cluster/fixed.ts:80

    • Protected sendToWorker

    +
  • Defined in src/pools/cluster/fixed.ts:75

    • setTasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:266

    • setWorkerChoiceStrategy

    +
  • Defined in src/pools/abstract-pool.ts:218

    • setWorkerChoiceStrategyOptions

    +
  • Defined in src/pools/abstract-pool.ts:244

    • Protected setupHook

    +
  • Defined in src/pools/cluster/fixed.ts:59

    • Protected workerListener

      @@ -602,7 +602,7 @@ Can be overridden

    +
  • Defined in src/pools/abstract-pool.ts:504
    • diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index afdb1f84..e454e9ee 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -44,7 +44,7 @@ +
  • Defined in src/pools/thread/fixed.ts:29
    • @@ -128,7 +128,7 @@

    Returns FixedThreadPool<Data, Response>

    +
  • Defined in src/pools/thread/fixed.ts:40

    • Properties

    @@ -143,7 +143,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:42

    • Readonly filePath

    filePath: string
    @@ -151,7 +151,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:77

    • Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -159,7 +159,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:76

    • Readonly opts

    opts: PoolOptions<ThreadWorkerWithMessageChannel>
    @@ -167,7 +167,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:78

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    @@ -180,7 +180,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:52

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    @@ -189,7 +189,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:62

    • Readonly workerNodes

    workerNodes: WorkerNode<ThreadWorkerWithMessageChannel, Data>[] = []
    @@ -197,7 +197,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:39

    • Accessors

    @@ -211,7 +211,7 @@

    Returns boolean

    +
  • Defined in src/pools/thread/fixed.ts:105

    • Protected full

    +
  • Defined in src/pools/thread/fixed.ts:100

    • Private numberOfQueuedTasks

    +
  • Defined in src/pools/abstract-pool.ts:195

    • Private numberOfRunningTasks

    +
  • Defined in src/pools/abstract-pool.ts:185

    • type

    +
  • Defined in src/pools/thread/fixed.ts:95

    • Methods

    @@ -282,7 +282,7 @@ Can be overridden.

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:386

    • Protected afterWorkerSetup

    +
  • Defined in src/pools/thread/fixed.ts:85

    • Protected beforeTaskExecutionHook

    +
  • Defined in src/pools/abstract-pool.ts:375

    • Protected chooseWorkerNode

    +
  • Defined in src/pools/abstract-pool.ts:419

    • Protected createAndSetupWorker

    +
  • Defined in src/pools/abstract-pool.ts:481

    • Protected createWorker

    +
  • Defined in src/pools/thread/fixed.ts:78

    • destroy

    +
  • Defined in src/pools/abstract-pool.ts:338

    • Protected destroyWorker

    +
  • Defined in src/pools/thread/fixed.ts:54

    • enableTasksQueue

    +
  • Defined in src/pools/abstract-pool.ts:254

    • execute

    +
  • Defined in src/pools/abstract-pool.ts:307

    • Protected internalBusy

    +
  • Defined in src/pools/abstract-pool.ts:298

    • Protected isMain

    +
  • Defined in src/pools/thread/fixed.ts:49

    • Protected registerWorkerMessageListener

    +
  • Defined in src/pools/thread/fixed.ts:70

    • Protected sendToWorker

    +
  • Defined in src/pools/thread/fixed.ts:62

    • setTasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:266

    • setWorkerChoiceStrategy

    +
  • Defined in src/pools/abstract-pool.ts:218

    • setWorkerChoiceStrategyOptions

    +
  • Defined in src/pools/abstract-pool.ts:244

    • Protected setupHook

    +
  • Defined in src/pools/abstract-pool.ts:360

    • Protected workerListener

      @@ -602,7 +602,7 @@ Can be overridden

    +
  • Defined in src/pools/abstract-pool.ts:504
    • diff --git a/docs/classes/PoolEmitter.html b/docs/classes/PoolEmitter.html index 886dad9d..a164defe 100644 --- a/docs/classes/PoolEmitter.html +++ b/docs/classes/PoolEmitter.html @@ -25,7 +25,7 @@
    • PoolEmitter
    +
  • Defined in src/pools/pool.ts:35
    • diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index 03f2c120..fb444a08 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -44,7 +44,7 @@ but the minimum number of workers will be guaranteed.

    • ThreadWorker
    +
  • Defined in src/worker/thread-worker.ts:21
    • @@ -108,7 +108,7 @@ but the minimum number of workers will be guaranteed.

    Returns ThreadWorker<Data, Response>

    +
  • Defined in src/worker/thread-worker.ts:31

    • Properties

    @@ -118,7 +118,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:36

    • Protected Readonly isMain

    isMain: boolean
    @@ -126,7 +126,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:48

    • Protected lastTaskTimestamp

    lastTaskTimestamp: number
    @@ -134,7 +134,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:32

    • Protected mainWorker

    mainWorker: undefined | null | MessagePort
    @@ -142,7 +142,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:50

    • Protected Readonly opts

    opts: WorkerOptions = ...
    @@ -150,7 +150,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:51

    • Methods

    @@ -201,7 +201,7 @@ the AsyncResource to which the function is bound.

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:156

    • emitDestroy

    +
  • Defined in src/worker/abstract-worker.ts:139

    • Protected handleError

    +
  • Defined in src/worker/abstract-worker.ts:171

    • Protected messageListener

    +
  • Defined in src/worker/abstract-worker.ts:113

    • Protected run

    +
  • Defined in src/worker/abstract-worker.ts:181

    • Protected runAsync

    +
  • Defined in src/worker/abstract-worker.ts:208

    • runInAsyncScope

    +
  • Defined in src/worker/thread-worker.ts:39

    • triggerAsyncId

      diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index 7f67cf5a..87a793a4 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
    • @@ -96,21 +96,21 @@

    Returns WorkerChoiceStrategyContext<Worker, Data, Response>

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:41

    • Properties

    Private Readonly workerChoiceStrategies

    workerChoiceStrategies: Map<"ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>
    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:29

    • Private workerChoiceStrategy

    workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN

    The worker choice strategy.

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:43

    • Methods

    @@ -123,7 +123,7 @@

    Returns number

    The key of the worker node.

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:122

    • getRequiredStatistics

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:95

    • remove

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:136

    • setOptions

      @@ -169,7 +169,7 @@

    Returns void

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:149

    • setWorkerChoiceStrategy

      @@ -186,7 +186,7 @@

    Returns void

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:108
    • diff --git a/docs/enums/PoolType.html b/docs/enums/PoolType.html index 21439ec1..779b372d 100644 --- a/docs/enums/PoolType.html +++ b/docs/enums/PoolType.html @@ -19,7 +19,7 @@

    Pool types.

    +
  • Defined in src/pools/pool.ts:21
    • @@ -38,14 +38,14 @@

    Dynamic pool type.

    +
  • Defined in src/pools/pool.ts:29

    • FIXED

    FIXED: "fixed"

    Fixed pool type.

    +
  • Defined in src/pools/pool.ts:25
    • diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index 9d1adb8e..40bd8617 100644 --- a/docs/interfaces/ClusterPoolOptions.html +++ b/docs/interfaces/ClusterPoolOptions.html @@ -25,7 +25,7 @@
    • ClusterPoolOptions
    +
  • Defined in src/pools/cluster/fixed.ts:11
    • @@ -56,7 +56,7 @@
    +
  • Defined in src/pools/pool.ts:99

    • Optional enableTasksQueue

    enableTasksQueue?: boolean
    @@ -66,7 +66,7 @@
    +
  • Defined in src/pools/pool.ts:105

    • Optional env

    env?: any
    @@ -75,7 +75,7 @@

    See

    https://nodejs.org/api/cluster.html#cluster_cluster_fork_env

    +
  • Defined in src/pools/cluster/fixed.ts:18

    • Optional errorHandler

    errorHandler?: ErrorHandler<Worker>
    @@ -83,7 +83,7 @@
    +
  • Defined in src/pools/pool.ts:75

    • Optional exitHandler

    exitHandler?: ExitHandler<Worker>
    @@ -91,7 +91,7 @@
    +
  • Defined in src/pools/pool.ts:83

    • Optional messageHandler

    messageHandler?: MessageHandler<Worker>
    @@ -99,7 +99,7 @@
    +
  • Defined in src/pools/pool.ts:71

    • Optional onlineHandler

    onlineHandler?: OnlineHandler<Worker>
    @@ -107,7 +107,7 @@
    +
  • Defined in src/pools/pool.ts:79

    • Optional settings

    settings?: ClusterSettings
    @@ -116,7 +116,7 @@

    See

    https://nodejs.org/api/cluster.html#cluster_cluster_settings

    +
  • Defined in src/pools/cluster/fixed.ts:24

    • Optional tasksQueueOptions

    tasksQueueOptions?: TasksQueueOptions
    @@ -124,7 +124,7 @@
    +
  • Defined in src/pools/pool.ts:109

    • Optional workerChoiceStrategy

    workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
    @@ -134,7 +134,7 @@
    +
  • Defined in src/pools/pool.ts:89

    • Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -142,7 +142,7 @@
    +
  • Defined in src/pools/pool.ts:93
    • diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index d010c608..b59b1675 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -42,7 +42,7 @@ +
  • Defined in src/pools/pool.ts:119
    • @@ -76,7 +76,7 @@

    Returns Promise<void>

    +
  • Defined in src/pools/pool.ts:153

    • Optional Readonly emitter

    emitter?: PoolEmitter
    @@ -88,7 +88,7 @@
    +
  • Defined in src/pools/pool.ts:142

    • enableTasksQueue

    enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -114,7 +114,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:178

    • execute

    execute: ((data?) => Promise<Response>)
    @@ -137,7 +137,7 @@

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

    +
  • Defined in src/pools/pool.ts:149

    • setTasksQueueOptions

    setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -159,7 +159,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:187

    • setWorkerChoiceStrategy

    setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -185,7 +185,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:160

    • setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -207,7 +207,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:169

    • Readonly type

    type: PoolType
    @@ -215,14 +215,14 @@

    If it is 'dynamic', it provides the max property.

    +
  • Defined in src/pools/pool.ts:129

    • Readonly workerNodes

    workerNodes: WorkerNode<Worker, Data>[]

    Pool worker nodes.

    +
  • Defined in src/pools/pool.ts:133
    • diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index 895b5e60..73b6fca9 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -23,7 +23,7 @@
    • IWorker
    +
  • Defined in src/pools/worker.ts:88
    • @@ -46,7 +46,7 @@

    Param

    The event handler.

    +
  • Defined in src/pools/worker.ts:95

    • once

    once: ((event, handler) => void)
    @@ -72,7 +72,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:105
    • diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index 3370fa58..a534753f 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -23,7 +23,7 @@
    • IWorkerChoiceStrategy
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:67
    • @@ -53,7 +53,7 @@

    Returns number

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:79

    • remove

    remove: ((workerNodeKey) => boolean)
    @@ -75,14 +75,14 @@

    Returns boolean

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:85

    • Readonly requiredStatistics

    requiredStatistics: RequiredStatistics

    Required tasks usage statistics.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:71

    • reset

    reset: (() => boolean)
    @@ -97,7 +97,7 @@

    Returns boolean

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:75

    • setOptions

    setOptions: ((opts) => void)
    @@ -119,7 +119,7 @@

    Returns void

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:91
    • diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index 3cf315bd..e095fb5e 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -36,7 +36,7 @@
    • MessageValue
    +
  • Defined in src/utility-types.ts:20
    • @@ -60,14 +60,14 @@
    +
  • Defined in src/pools/worker.ts:42

    • Optional Readonly error

    error?: string

    Error.

    +
  • Defined in src/utility-types.ts:31

    • Optional Readonly id

    id?: string
    @@ -75,28 +75,28 @@
    +
  • Defined in src/pools/worker.ts:46

    • Optional Readonly kill

    kill?: 1 | "SOFT" | "HARD"

    Kill code.

    +
  • Defined in src/utility-types.ts:27

    • Optional Readonly parent

    parent?: MainWorker

    Reference to main worker.

    +
  • Defined in src/utility-types.ts:39

    • Optional Readonly runTime

    runTime?: number

    Runtime.

    +
  • Defined in src/utility-types.ts:35
    • diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index 5eee8fe1..a853d630 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -32,7 +32,7 @@ +
  • Defined in src/pools/pool.ts:67
    • @@ -60,7 +60,7 @@

    Default Value

    true

    +
  • Defined in src/pools/pool.ts:99

    • Optional enableTasksQueue

    enableTasksQueue?: boolean
    @@ -69,42 +69,42 @@

    Default Value

    false

    +
  • Defined in src/pools/pool.ts:105

    • Optional errorHandler

    errorHandler?: ErrorHandler<Worker>

    A function that will listen for error event on each worker.

    +
  • Defined in src/pools/pool.ts:75

    • Optional exitHandler

    exitHandler?: ExitHandler<Worker>

    A function that will listen for exit event on each worker.

    +
  • Defined in src/pools/pool.ts:83

    • Optional messageHandler

    messageHandler?: MessageHandler<Worker>

    A function that will listen for message event on each worker.

    +
  • Defined in src/pools/pool.ts:71

    • Optional onlineHandler

    onlineHandler?: OnlineHandler<Worker>

    A function that will listen for online event on each worker.

    +
  • Defined in src/pools/pool.ts:79

    • Optional tasksQueueOptions

    tasksQueueOptions?: TasksQueueOptions

    Pool worker tasks queue options.

    +
  • Defined in src/pools/pool.ts:109

    • Optional workerChoiceStrategy

    workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
    @@ -113,14 +113,14 @@

    Default Value

    WorkerChoiceStrategies.ROUND_ROBIN

    +
  • Defined in src/pools/pool.ts:89

    • Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    +
  • Defined in src/pools/pool.ts:93
    • diff --git a/docs/interfaces/PromiseResponseWrapper.html b/docs/interfaces/PromiseResponseWrapper.html index c5f73805..d78e9097 100644 --- a/docs/interfaces/PromiseResponseWrapper.html +++ b/docs/interfaces/PromiseResponseWrapper.html @@ -34,7 +34,7 @@
    • PromiseResponseWrapper
    +
  • Defined in src/utility-types.ts:79
    • @@ -67,7 +67,7 @@
    Optional reason: string

    Returns void

    +
  • Defined in src/utility-types.ts:90

    • Readonly resolve

    resolve: ((value) => void)
    @@ -87,14 +87,14 @@
    value: Response

    Returns void

    +
  • Defined in src/utility-types.ts:86

    • Readonly worker

    worker: Worker

    The worker handling the execution.

    +
  • Defined in src/utility-types.ts:94
    • diff --git a/docs/interfaces/RequiredStatistics.html b/docs/interfaces/RequiredStatistics.html index 2aa42b53..f71b22ee 100644 --- a/docs/interfaces/RequiredStatistics.html +++ b/docs/interfaces/RequiredStatistics.html @@ -23,7 +23,7 @@
    • RequiredStatistics
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:49
    • @@ -43,21 +43,21 @@

    Require tasks average run time.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:57

    • medRunTime

    medRunTime: boolean

    Require tasks median run time.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:61

    • runTime

    runTime: boolean

    Require tasks run time.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:53
    • diff --git a/docs/interfaces/Task.html b/docs/interfaces/Task.html index 8c9b7d16..9b54b8a9 100644 --- a/docs/interfaces/Task.html +++ b/docs/interfaces/Task.html @@ -32,7 +32,7 @@ +
  • Defined in src/pools/worker.ts:38
    • @@ -51,14 +51,14 @@

    Task input data that will be passed to the worker.

    +
  • Defined in src/pools/worker.ts:42

    • Optional Readonly id

    id?: string

    UUID of the message.

    +
  • Defined in src/pools/worker.ts:46
    • diff --git a/docs/interfaces/TasksQueueOptions.html b/docs/interfaces/TasksQueueOptions.html index 146bab93..be95e948 100644 --- a/docs/interfaces/TasksQueueOptions.html +++ b/docs/interfaces/TasksQueueOptions.html @@ -23,7 +23,7 @@
    • TasksQueueOptions
    +
  • Defined in src/pools/pool.ts:53
    • @@ -43,7 +43,7 @@

    Default Value

    1

    +
  • Defined in src/pools/pool.ts:59
    • diff --git a/docs/interfaces/TasksUsage.html b/docs/interfaces/TasksUsage.html index 81902f82..d5fd5071 100644 --- a/docs/interfaces/TasksUsage.html +++ b/docs/interfaces/TasksUsage.html @@ -23,7 +23,7 @@
    • TasksUsage
    +
  • Defined in src/pools/worker.ts:54
    • @@ -47,49 +47,49 @@

    Average tasks runtime.

    +
  • Defined in src/pools/worker.ts:74

    • error

    error: number

    Number of tasks errored.

    +
  • Defined in src/pools/worker.ts:82

    • medRunTime

    medRunTime: number

    Median tasks runtime.

    +
  • Defined in src/pools/worker.ts:78

    • run

    run: number

    Number of tasks executed.

    +
  • Defined in src/pools/worker.ts:58

    • runTime

    runTime: number

    Tasks runtime.

    +
  • Defined in src/pools/worker.ts:66

    • runTimeHistory

    runTimeHistory: CircularArray<number>

    Tasks runtime history.

    +
  • Defined in src/pools/worker.ts:70

    • running

    running: number

    Number of tasks running.

    +
  • Defined in src/pools/worker.ts:62
    • diff --git a/docs/interfaces/WorkerChoiceStrategyOptions.html b/docs/interfaces/WorkerChoiceStrategyOptions.html index 33a9e312..f5e04552 100644 --- a/docs/interfaces/WorkerChoiceStrategyOptions.html +++ b/docs/interfaces/WorkerChoiceStrategyOptions.html @@ -23,7 +23,7 @@
    • WorkerChoiceStrategyOptions
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:35
    • @@ -43,7 +43,7 @@

    Default Value

    false

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:41
    • diff --git a/docs/interfaces/WorkerNode.html b/docs/interfaces/WorkerNode.html index cb7c7763..11c3d1e0 100644 --- a/docs/interfaces/WorkerNode.html +++ b/docs/interfaces/WorkerNode.html @@ -34,7 +34,7 @@
    • WorkerNode
    +
  • Defined in src/pools/worker.ts:115
    • @@ -54,21 +54,21 @@

    Worker node tasks queue.

    +
  • Defined in src/pools/worker.ts:127

    • tasksUsage

    tasksUsage: TasksUsage

    Worker node tasks usage statistics.

    +
  • Defined in src/pools/worker.ts:123

    • Readonly worker

    worker: Worker

    Worker node worker.

    +
  • Defined in src/pools/worker.ts:119
    • diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index ce2bb5d7..4a6dc823 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -23,7 +23,7 @@
    • WorkerOptions
    +
  • Defined in src/worker/worker-options.ts:38
    • @@ -45,7 +45,7 @@

    Default Value

    false

    +
  • Defined in src/worker/worker-options.ts:57

    • Optional killBehavior

    killBehavior?: "SOFT" | "HARD"
    @@ -59,7 +59,7 @@

    Default Value

    KillBehaviors.SOFT

    +
  • Defined in src/worker/worker-options.ts:68

    • Optional maxInactiveTime

    maxInactiveTime?: number
    @@ -75,7 +75,7 @@ when this timeout expires your tasks is interrupted and the worker is killed if

    Default Value

    60000

    +
  • Defined in src/worker/worker-options.ts:51
    • diff --git a/docs/types/Draft.html b/docs/types/Draft.html index 6022036a..736fed49 100644 --- a/docs/types/Draft.html +++ b/docs/types/Draft.html @@ -26,7 +26,7 @@

    Type in which properties will be non-readonly.

    +
  • Defined in src/utility-types.ts:11
    • diff --git a/docs/types/ErrorHandler.html b/docs/types/ErrorHandler.html index 698af0bd..9e2de89a 100644 --- a/docs/types/ErrorHandler.html +++ b/docs/types/ErrorHandler.html @@ -39,7 +39,7 @@
    e: Error

    Returns void

    +
  • Defined in src/pools/worker.ts:14
    • diff --git a/docs/types/ExitHandler.html b/docs/types/ExitHandler.html index 9b68fabe..af314a25 100644 --- a/docs/types/ExitHandler.html +++ b/docs/types/ExitHandler.html @@ -39,7 +39,7 @@
    code: number

    Returns void

    +
  • Defined in src/pools/worker.ts:27
    • diff --git a/docs/types/KillBehavior.html b/docs/types/KillBehavior.html index 8d5398f3..cffa3108 100644 --- a/docs/types/KillBehavior.html +++ b/docs/types/KillBehavior.html @@ -19,7 +19,7 @@

    Kill behavior.

    +
  • Defined in src/worker/worker-options.ts:18
    • diff --git a/docs/types/MessageHandler.html b/docs/types/MessageHandler.html index 0da694c3..e4990d94 100644 --- a/docs/types/MessageHandler.html +++ b/docs/types/MessageHandler.html @@ -39,7 +39,7 @@
    m: unknown

    Returns void

    +
  • Defined in src/pools/worker.ts:6
    • diff --git a/docs/types/OnlineHandler.html b/docs/types/OnlineHandler.html index 5c16e2b5..db42e105 100644 --- a/docs/types/OnlineHandler.html +++ b/docs/types/OnlineHandler.html @@ -37,7 +37,7 @@
    this: Worker

    Returns void

    +
  • Defined in src/pools/worker.ts:22
    • diff --git a/docs/types/PoolEvent.html b/docs/types/PoolEvent.html index 843e4e58..dd9174a9 100644 --- a/docs/types/PoolEvent.html +++ b/docs/types/PoolEvent.html @@ -19,7 +19,7 @@

    Pool event.

    +
  • Defined in src/pools/pool.ts:48
    • diff --git a/docs/types/ThreadWorkerWithMessageChannel.html b/docs/types/ThreadWorkerWithMessageChannel.html index d46c9b1d..47e393e0 100644 --- a/docs/types/ThreadWorkerWithMessageChannel.html +++ b/docs/types/ThreadWorkerWithMessageChannel.html @@ -19,7 +19,7 @@

    A thread worker with message channels for communication between main thread and thread worker.

    +
  • Defined in src/pools/thread/fixed.ts:15
    • diff --git a/docs/types/WorkerAsyncFunction.html b/docs/types/WorkerAsyncFunction.html index bcaf3a6f..7f3ec213 100644 --- a/docs/types/WorkerAsyncFunction.html +++ b/docs/types/WorkerAsyncFunction.html @@ -44,7 +44,7 @@ This function must return a promise.

    Optional data: Data

    Returns Promise<Response>

    +
  • Defined in src/utility-types.ts:58
    • diff --git a/docs/types/WorkerChoiceStrategy.html b/docs/types/WorkerChoiceStrategy.html index 7c6928ab..fc22d6f9 100644 --- a/docs/types/WorkerChoiceStrategy.html +++ b/docs/types/WorkerChoiceStrategy.html @@ -19,7 +19,7 @@

    Worker choice strategy.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:30
    • diff --git a/docs/types/WorkerFunction.html b/docs/types/WorkerFunction.html index eebb019a..39c9e81a 100644 --- a/docs/types/WorkerFunction.html +++ b/docs/types/WorkerFunction.html @@ -31,7 +31,7 @@ This function can be synchronous or asynchronous.

    Type of execution response. This can only be serializable data.

    +
  • Defined in src/utility-types.ts:68
    • diff --git a/docs/types/WorkerSyncFunction.html b/docs/types/WorkerSyncFunction.html index c95a52a9..23b9c86f 100644 --- a/docs/types/WorkerSyncFunction.html +++ b/docs/types/WorkerSyncFunction.html @@ -43,7 +43,7 @@
    Optional data: Data

    Returns Response

    +
  • Defined in src/utility-types.ts:48
    • diff --git a/docs/variables/KillBehaviors.html b/docs/variables/KillBehaviors.html index 6f603e77..a9f0cb62 100644 --- a/docs/variables/KillBehaviors.html +++ b/docs/variables/KillBehaviors.html @@ -19,7 +19,7 @@

    Enumeration of kill behaviors.

    +
  • Defined in src/worker/worker-options.ts:4
    • diff --git a/docs/variables/PoolEvents.html b/docs/variables/PoolEvents.html index e9344c95..c546a9dc 100644 --- a/docs/variables/PoolEvents.html +++ b/docs/variables/PoolEvents.html @@ -19,7 +19,7 @@

    Enumeration of pool events.

    +
  • Defined in src/pools/pool.ts:40
    • diff --git a/docs/variables/WorkerChoiceStrategies.html b/docs/variables/WorkerChoiceStrategies.html index 078af9b0..09779b1a 100644 --- a/docs/variables/WorkerChoiceStrategies.html +++ b/docs/variables/WorkerChoiceStrategies.html @@ -19,7 +19,7 @@

    Enumeration of worker choice strategies.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:4
    • -- 2.34.1