From 58f37c77b0f9237b9616494d72da259fcb7bc1b5 Mon Sep 17 00:00:00 2001 From: Documentation Bot Date: Wed, 14 Oct 2026 22:51:53 +0000 Subject: [PATCH] docs: publish documentation --- docs/assets/hierarchy.js | 2 +- docs/assets/highlight.css | 2 +- docs/assets/icons.js | 2 +- docs/assets/icons.svg | 2 +- docs/assets/main.js | 8 +- docs/assets/navigation.js | 2 +- docs/assets/search.js | 2 +- docs/assets/style.css | 21 +- docs/classes/src.ClusterWorker.html | 547 ++++++++-- docs/classes/src.DynamicClusterPool.html | 956 +++++++++++++++-- docs/classes/src.DynamicThreadPool.html | 960 +++++++++++++++-- docs/classes/src.FixedClusterPool.html | 958 +++++++++++++++-- docs/classes/src.FixedThreadPool.html | 962 ++++++++++++++++-- docs/classes/src.ThreadWorker.html | 547 ++++++++-- docs/documents/api.html | 67 +- docs/documents/general-guidelines.html | 41 +- docs/documents/worker-choice-strategies.html | 48 +- docs/functions/src.availableParallelism.html | 45 +- docs/hierarchy.html | 46 +- docs/index.html | 40 +- docs/interfaces/src.AbstractPool.html | 873 ++++++++++++++-- docs/interfaces/src.AbstractWorker.html | 461 ++++++++- docs/interfaces/src.CircularBuffer.html | 20 - ...tLoopUtilizationMeasurementStatistics.html | 6 - docs/interfaces/src.FixedQueueNode.html | 6 - docs/interfaces/src.IFixedQueue.html | 38 - docs/interfaces/src.IPool.html | 417 +++++++- docs/interfaces/src.IWorker.html | 543 +++++++++- .../interfaces/src.IWorkerChoiceStrategy.html | 29 - docs/interfaces/src.IWorkerNode.html | 206 ---- docs/interfaces/src.MeasurementOptions.html | 65 +- .../interfaces/src.MeasurementStatistics.html | 14 - ...src.MeasurementStatisticsRequirements.html | 8 - docs/interfaces/src.MessageValue.html | 59 -- docs/interfaces/src.PoolInfo.html | 208 +++- docs/interfaces/src.PoolOptions.html | 231 ++++- docs/interfaces/src.PriorityQueue.html | 34 - .../src.PromiseResponseWrapper.html | 13 - docs/interfaces/src.StrategyData.html | 3 - docs/interfaces/src.StrategyPolicy.html | 6 - docs/interfaces/src.Task.html | 22 - docs/interfaces/src.TaskFunctionObject.html | 100 +- .../src.TaskFunctionOperationResult.html | 67 +- .../src.TaskFunctionProperties.html | 89 +- docs/interfaces/src.TaskPerformance.html | 10 - docs/interfaces/src.TaskStatistics.html | 16 - .../src.TaskStatisticsRequirements.html | 8 - docs/interfaces/src.TasksQueueOptions.html | 161 ++- .../src.WorkerChoiceStrategiesContext.html | 39 - .../src.WorkerChoiceStrategyOptions.html | 117 ++- docs/interfaces/src.WorkerError.html | 112 +- docs/interfaces/src.WorkerInfo.html | 30 - .../interfaces/src.WorkerNodeEventDetail.html | 5 - docs/interfaces/src.WorkerNodeOptions.html | 9 - docs/interfaces/src.WorkerOptions.html | 96 +- docs/interfaces/src.WorkerStatistics.html | 6 - docs/interfaces/src.WorkerUsage.html | 10 - docs/modules/src.html | 54 +- docs/types/src.ClusterPoolOptions.html | 38 +- docs/types/src.ErrorHandler.html | 58 +- docs/types/src.EventHandler.html | 45 +- docs/types/src.ExitHandler.html | 58 +- docs/types/src.KillBehavior.html | 38 +- docs/types/src.KillHandler.html | 46 +- docs/types/src.Measurement.html | 38 +- docs/types/src.MessageHandler.html | 58 +- docs/types/src.OnlineHandler.html | 57 +- docs/types/src.PoolEvent.html | 38 +- docs/types/src.PoolType.html | 38 +- docs/types/src.TaskAsyncFunction.html | 66 +- docs/types/src.TaskFunction.html | 49 +- docs/types/src.TaskFunctions.html | 49 +- docs/types/src.TaskSyncFunction.html | 66 +- docs/types/src.ThreadPoolOptions.html | 38 +- docs/types/src.WorkerChoiceStrategy.html | 38 +- docs/types/src.WorkerType.html | 38 +- docs/types/src.Writable.html | 3 - docs/variables/src.KillBehaviors.html | 38 +- docs/variables/src.Measurements.html | 38 +- docs/variables/src.PoolEvents.html | 38 +- docs/variables/src.PoolTypes.html | 38 +- .../variables/src.WorkerChoiceStrategies.html | 38 +- docs/variables/src.WorkerTypes.html | 38 +- 83 files changed, 9083 insertions(+), 1453 deletions(-) delete mode 100644 docs/interfaces/src.CircularBuffer.html delete mode 100644 docs/interfaces/src.EventLoopUtilizationMeasurementStatistics.html delete mode 100644 docs/interfaces/src.FixedQueueNode.html delete mode 100644 docs/interfaces/src.IFixedQueue.html delete mode 100644 docs/interfaces/src.IWorkerChoiceStrategy.html delete mode 100644 docs/interfaces/src.IWorkerNode.html delete mode 100644 docs/interfaces/src.MeasurementStatistics.html delete mode 100644 docs/interfaces/src.MeasurementStatisticsRequirements.html delete mode 100644 docs/interfaces/src.MessageValue.html delete mode 100644 docs/interfaces/src.PriorityQueue.html delete mode 100644 docs/interfaces/src.PromiseResponseWrapper.html delete mode 100644 docs/interfaces/src.StrategyData.html delete mode 100644 docs/interfaces/src.StrategyPolicy.html delete mode 100644 docs/interfaces/src.Task.html delete mode 100644 docs/interfaces/src.TaskPerformance.html delete mode 100644 docs/interfaces/src.TaskStatistics.html delete mode 100644 docs/interfaces/src.TaskStatisticsRequirements.html delete mode 100644 docs/interfaces/src.WorkerChoiceStrategiesContext.html delete mode 100644 docs/interfaces/src.WorkerInfo.html delete mode 100644 docs/interfaces/src.WorkerNodeEventDetail.html delete mode 100644 docs/interfaces/src.WorkerNodeOptions.html delete mode 100644 docs/interfaces/src.WorkerStatistics.html delete mode 100644 docs/interfaces/src.WorkerUsage.html delete mode 100644 docs/types/src.Writable.html diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js index 18fd119ea..2d21feef6 100644 --- a/docs/assets/hierarchy.js +++ b/docs/assets/hierarchy.js @@ -1 +1 @@ -window.hierarchyData = "eJydk8FvwiAYxf+X74xO0ELhtmxZ4mHJDmY7GA+sxdmIbQKYbDH93xdat9FOU+qlB/q+/N578J3AVJWzINaYUYIopwgzwjYIjNpqlbmiKi2IExDmv6U8KBBw/26dkZl7qSoNCPZFmYMgCUVwNBoEFKVTZiszZe+syaahfLpzBz+TaWktCHA2n/j5ye+M/7krdG5UCWKdLGYI4zne1AjmLDTx+FXKQ5E96KN1ynSsYJL+WGk4Zx//J666aQ9qBMliFjCfik+VjyD29QO8TvI5Yz405TQwsIysfHlL16QBcnqh5dXOKJmPKPlvYLhjf7/9kuOBPfmYijltEmOa8oD/rKyVH+pV6qOKqDqURzTueayzTStp9xEcLxt7oz5Zk5BRcmF/3yqzV2bEBrcDo12kCUOYJ23ZaRKGPy9Hz8mVq+6II94V76DaNxJHCrVDoLr+BtMcu94=" \ No newline at end of file +window.hierarchyData = "eJydkjFvwyAUhP/Lm0ka7IANW9WqUrYOlTpEGVybyCgYJCBSq8j/vcJOW+wmip2FAe509z7eCawx3gHf4owmiDK6Q2DFXonSS6Md8BMkWTh10Qjg8PjhvC1K/2qMAgQHqSvgCaEIjlYBB6m9sPuiFO7B2XIZy5e1b4KnVIVzwMG7ahH8i19PeKylqqzQwLdkvUIYp3jXIkizuMTzly4aWT6po/PCDqrgJP+p0uWce/x3XG3TX7QIyHoVZb7IT1HNSBzrb+QNJk+zLAxNGY0KbCYi39zDOukCGb1A+a22oqhmQP4z3GYc/ncMeXrgSD4HMaPdxGHrL2z3u7EHYWfsd2+YSx3nJEOYkb5KTmL659UZNbkCYiCeQJ0NonqC05Ji7a2gtv0G4TFxTQ==" \ No newline at end of file diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css index ca19fc8e9..7e356084c 100644 --- a/docs/assets/highlight.css +++ b/docs/assets/highlight.css @@ -96,4 +96,4 @@ .hl-8 { color: var(--hl-8); } .hl-9 { color: var(--hl-9); } .hl-10 { color: var(--hl-10); } -pre, code { background: var(--code-background); } +pre, code, math[display='block'] { background: var(--code-background); } diff --git a/docs/assets/icons.js b/docs/assets/icons.js index 3ae8f55e5..4fbadc5ad 100644 --- a/docs/assets/icons.js +++ b/docs/assets/icons.js @@ -3,7 +3,7 @@ function addIcons() { if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons); const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg")); - svg.innerHTML = `MMNEPVFCICPMFPCPTTAAATR`; + svg.innerHTML = `MMNEPVFCICPMFPCPTTAAATR`; svg.style.display = "none"; if (location.protocol === "file:") updateUseElements(); } diff --git a/docs/assets/icons.svg b/docs/assets/icons.svg index 10db10be0..be7798fcd 100644 --- a/docs/assets/icons.svg +++ b/docs/assets/icons.svg @@ -1 +1 @@ -MMNEPVFCICPMFPCPTTAAATR \ No newline at end of file +MMNEPVFCICPMFPCPTTAAATR \ No newline at end of file diff --git a/docs/assets/main.js b/docs/assets/main.js index 64b80ab2d..b0eda9ed3 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,9 +1,9 @@ "use strict"; window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings.","hierarchy_expand":"Expand","hierarchy_collapse":"Collapse","folder":"Folder","search_index_not_available":"The search index is not available","search_no_results_found_for_0":"No results found for {0}","kind_1":"Project","kind_2":"Module","kind_4":"Namespace","kind_8":"Enumeration","kind_16":"Enumeration Member","kind_32":"Variable","kind_64":"Function","kind_128":"Class","kind_256":"Interface","kind_512":"Constructor","kind_1024":"Property","kind_2048":"Method","kind_4096":"Call Signature","kind_8192":"Index Signature","kind_16384":"Constructor Signature","kind_32768":"Parameter","kind_65536":"Type Literal","kind_131072":"Type Parameter","kind_262144":"Accessor","kind_524288":"Get Signature","kind_1048576":"Set Signature","kind_2097152":"Type Alias","kind_4194304":"Reference","kind_8388608":"Document"}; -"use strict";(()=>{var Ke=Object.create;var he=Object.defineProperty;var Ge=Object.getOwnPropertyDescriptor;var Ze=Object.getOwnPropertyNames;var Xe=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var et=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var tt=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ze(e))!Ye.call(t,i)&&i!==n&&he(t,i,{get:()=>e[i],enumerable:!(r=Ge(e,i))||r.enumerable});return t};var nt=(t,e,n)=>(n=t!=null?Ke(Xe(t)):{},tt(e||!t||!t.__esModule?he(n,"default",{value:t,enumerable:!0}):n,t));var ye=et((me,ge)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=(function(e){return function(n){e.console&&console.warn&&console.warn(n)}})(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,l],d.index=s.length,s.push(new t.Token(r.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,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(oc?d+=2:a==c&&(n+=r[l+1]*i[d+1],l+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}if(s.str.length==0&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),f=s.str.charAt(1),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),c=0;c1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},(function(e,n){typeof define=="function"&&define.amd?define(n):typeof me=="object"?ge.exports=n():e.lunr=n()})(this,function(){return t})})()});var M,G={getItem(){return null},setItem(){}},K;try{K=localStorage,M=K}catch{K=G,M=G}var S={getItem:t=>M.getItem(t),setItem:(t,e)=>M.setItem(t,e),disableWritingLocalStorage(){M=G},disable(){localStorage.clear(),M=G},enable(){M=K}};window.TypeDoc||={disableWritingLocalStorage(){S.disableWritingLocalStorage()},disableLocalStorage:()=>{S.disable()},enableLocalStorage:()=>{S.enable()}};window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse",search_index_not_available:"The search index is not available",search_no_results_found_for_0:"No results found for {0}",folder:"Folder",kind_1:"Project",kind_2:"Module",kind_4:"Namespace",kind_8:"Enumeration",kind_16:"Enumeration Member",kind_32:"Variable",kind_64:"Function",kind_128:"Class",kind_256:"Interface",kind_512:"Constructor",kind_1024:"Property",kind_2048:"Method",kind_4096:"Call Signature",kind_8192:"Index Signature",kind_16384:"Constructor Signature",kind_32768:"Parameter",kind_65536:"Type Literal",kind_131072:"Type Parameter",kind_262144:"Accessor",kind_524288:"Get Signature",kind_1048576:"Set Signature",kind_2097152:"Type Alias",kind_4194304:"Reference",kind_8388608:"Document"};var pe=[];function X(t,e){pe.push({selector:e,constructor:t})}var Z=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){pe.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!rt(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=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 n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function rt(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var fe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var Ie=nt(ye(),1);async function R(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}var Y="closing",ae="tsd-overlay";function it(){let t=Math.abs(window.innerWidth-document.documentElement.clientWidth);document.body.style.overflow="hidden",document.body.style.paddingRight=`${t}px`}function st(){document.body.style.removeProperty("overflow"),document.body.style.removeProperty("padding-right")}function xe(t,e){t.addEventListener("animationend",()=>{t.classList.contains(Y)&&(t.classList.remove(Y),document.getElementById(ae)?.remove(),t.close(),st())}),t.addEventListener("cancel",n=>{n.preventDefault(),ve(t)}),e?.closeOnClick&&document.addEventListener("click",n=>{t.open&&!t.contains(n.target)&&ve(t)},!0)}function Ee(t){if(t.open)return;let e=document.createElement("div");e.id=ae,document.body.appendChild(e),t.showModal(),it()}function ve(t){if(!t.open)return;document.getElementById(ae)?.classList.add(Y),t.classList.add(Y)}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var be=document.head.appendChild(document.createElement("style"));be.dataset.for="filters";var le={};function we(t){for(let e of t.split(/\s+/))if(le.hasOwnProperty(e)&&!le[e])return!0;return!1}var ee=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),be.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=S.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){S.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),le[`tsd-is-${this.el.name}`]=this.value,this.app.filterChanged(),this.app.updateIndexVisibility()}};var Le=0;async function Se(t,e){if(!window.searchData)return;let n=await R(window.searchData);t.data=n,t.index=Ie.Index.load(n.index),e.innerHTML=""}function _e(){let t=document.getElementById("tsd-search-trigger"),e=document.getElementById("tsd-search"),n=document.getElementById("tsd-search-input"),r=document.getElementById("tsd-search-results"),i=document.getElementById("tsd-search-script"),s=document.getElementById("tsd-search-status");if(!(t&&e&&n&&r&&i&&s))throw new Error("Search controls missing");let o={base:document.documentElement.dataset.base};o.base.endsWith("/")||(o.base+="/"),i.addEventListener("error",()=>{let a=window.translations.search_index_not_available;Pe(s,a)}),i.addEventListener("load",()=>{Se(o,s)}),Se(o,s),ot({trigger:t,searchEl:e,results:r,field:n,status:s},o)}function ot(t,e){let{field:n,results:r,searchEl:i,status:s,trigger:o}=t;xe(i,{closeOnClick:!0});function a(){Ee(i),n.setSelectionRange(0,n.value.length)}o.addEventListener("click",a),n.addEventListener("input",fe(()=>{at(r,n,s,e)},200)),n.addEventListener("keydown",l=>{if(r.childElementCount===0||l.ctrlKey||l.metaKey||l.altKey)return;let d=n.getAttribute("aria-activedescendant"),f=d?document.getElementById(d):null;if(f){let p=!1,v=!1;switch(l.key){case"Home":case"End":case"ArrowLeft":case"ArrowRight":v=!0;break;case"ArrowDown":case"ArrowUp":p=l.shiftKey;break}(p||v)&&ke(n)}if(!l.shiftKey)switch(l.key){case"Enter":f?.querySelector("a")?.click();break;case"ArrowUp":Te(r,n,f,-1),l.preventDefault();break;case"ArrowDown":Te(r,n,f,1),l.preventDefault();break}});function c(){ke(n)}n.addEventListener("change",c),n.addEventListener("blur",c),n.addEventListener("click",c),document.body.addEventListener("keydown",l=>{if(l.altKey||l.metaKey||l.shiftKey)return;let d=l.ctrlKey&&l.key==="k",f=!l.ctrlKey&&!ut()&&l.key==="/";(d||f)&&(l.preventDefault(),a())})}function at(t,e,n,r){if(!r.index||!r.data)return;t.innerHTML="",n.innerHTML="",Le+=1;let i=e.value.trim(),s;if(i){let a=i.split(" ").map(c=>c.length?`*${c}*`:"").join(" ");s=r.index.search(a).filter(({ref:c})=>{let l=r.data.rows[Number(c)].classes;return!l||!we(l)})}else s=[];if(s.length===0&&i){let a=window.translations.search_no_results_found_for_0.replace("{0}",` "${te(i)}" `);Pe(n,a);return}for(let a=0;ac.score-a.score);let o=Math.min(10,s.length);for(let a=0;a`,f=Ce(c.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(f+=` (score: ${s[a].score.toFixed(2)})`),c.parent&&(f=` - ${Ce(c.parent,i)}.${f}`);let p=document.createElement("li");p.id=`tsd-search:${Le}-${a}`,p.role="option",p.ariaSelected="false",p.classList.value=c.classes??"";let v=document.createElement("a");v.tabIndex=-1,v.href=r.base+c.url,v.innerHTML=d+`${f}`,p.append(v),t.appendChild(p)}}function Te(t,e,n,r){let i;if(r===1?i=n?.nextElementSibling||t.firstElementChild:i=n?.previousElementSibling||t.lastElementChild,i!==n){if(!i||i.role!=="option"){console.error("Option missing");return}i.ariaSelected="true",i.scrollIntoView({behavior:"smooth",block:"nearest"}),e.setAttribute("aria-activedescendant",i.id),n?.setAttribute("aria-selected","false")}}function ke(t){let e=t.getAttribute("aria-activedescendant");(e?document.getElementById(e):null)?.setAttribute("aria-selected","false"),t.setAttribute("aria-activedescendant","")}function Ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(te(t.substring(s,o)),`${te(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(te(t.substring(s))),i.join("")}var lt={"&":"&","<":"<",">":">","'":"'",'"':"""};function te(t){return t.replace(/[&<>"'"]/g,e=>lt[e])}function Pe(t,e){t.innerHTML=e?`
${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Be(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Be(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Be(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;r{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=gt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function pt(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Ve),Ve())}async function Ve(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await R(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),ft(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function ft(t,e,n){let r=e.roots.filter(i=>mt(e,i,n));for(let i of r)t.appendChild(je(e,i,n))}function je(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let c=t.reflections[a],l=s.appendChild(document.createElement("a"));l.textContent=c.name,l.href=oe+c.url,l.className=c.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=oe+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let c=je(t,a,n,r);c&&o.appendChild(c)}}return r.delete(e),s}function mt(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function gt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.setAttribute("viewBox","0 0 24 24"),t.setAttribute("fill","none"),t.innerHTML='',t}X(re,"a[data-toggle]");X(ie,".tsd-accordion");X(ee,".tsd-filter-item input[type=checkbox]");var qe=document.getElementById("tsd-theme");qe&&He(qe);var yt=new Z;Object.defineProperty(window,"app",{value:yt});_e();Ne();$e();"virtualKeyboard"in navigator&&(navigator.virtualKeyboard.overlaysContent=!0);})(); +(()=>{var Ke=Object.create;var he=Object.defineProperty;var Ge=Object.getOwnPropertyDescriptor;var Ze=Object.getOwnPropertyNames;var Xe=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var et=(t,e)=>()=>{try{return e||t((e={exports:{}}).exports,e),e.exports}catch(n){throw e=0,n}};var tt=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ze(e))!Ye.call(t,i)&&i!==n&&he(t,i,{get:()=>e[i],enumerable:!(r=Ge(e,i))||r.enumerable});return t};var nt=(t,e,n)=>(n=t!=null?Ke(Xe(t)):{},tt(e||!t||!t.__esModule?he(n,"default",{value:t,enumerable:!0}):n,t));var ye=et((me,ge)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=(function(e){return function(n){e.console&&console.warn&&console.warn(n)}})(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,l],d.index=s.length,s.push(new t.Token(r.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,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(oc?d+=2:a==c&&(n+=r[l+1]*i[d+1],l+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}if(s.str.length==0&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),f=s.str.charAt(1),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),c=0;c1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}if(s.type===t.QueryLexer.TERM)return t.QueryParser.parseTerm;var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},(function(e,n){typeof define=="function"&&define.amd?define(n):typeof me=="object"?ge.exports=n():e.lunr=n()})(this,function(){return t})})()});var M,G={getItem(){return null},setItem(){}},K;try{K=localStorage,M=K}catch{K=G,M=G}var S={getItem:t=>M.getItem(t),setItem:(t,e)=>M.setItem(t,e),disableWritingLocalStorage(){M=G},disable(){localStorage.clear(),M=G},enable(){M=K}};window.TypeDoc||={disableWritingLocalStorage(){S.disableWritingLocalStorage()},disableLocalStorage:()=>{S.disable()},enableLocalStorage:()=>{S.enable()}};window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse",search_index_not_available:"The search index is not available",search_no_results_found_for_0:"No results found for {0}",folder:"Folder",kind_1:"Project",kind_2:"Module",kind_4:"Namespace",kind_8:"Enumeration",kind_16:"Enumeration Member",kind_32:"Variable",kind_64:"Function",kind_128:"Class",kind_256:"Interface",kind_512:"Constructor",kind_1024:"Property",kind_2048:"Method",kind_4096:"Call Signature",kind_8192:"Index Signature",kind_16384:"Constructor Signature",kind_32768:"Parameter",kind_65536:"Type Literal",kind_131072:"Type Parameter",kind_262144:"Accessor",kind_524288:"Get Signature",kind_1048576:"Set Signature",kind_2097152:"Type Alias",kind_4194304:"Reference",kind_8388608:"Document"};var pe=[];function X(t,e){pe.push({selector:e,constructor:t})}var Z=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){pe.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!rt(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=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 n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function rt(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var fe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var Ie=nt(ye(),1);async function R(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}var Y="closing",ae="tsd-overlay";function it(){let t=Math.abs(window.innerWidth-document.documentElement.clientWidth);document.body.style.overflow="hidden",document.body.style.paddingRight=`${t}px`}function st(){document.body.style.removeProperty("overflow"),document.body.style.removeProperty("padding-right")}function Ee(t,e){t.addEventListener("animationend",()=>{t.classList.contains(Y)&&(t.classList.remove(Y),document.getElementById(ae)?.remove(),t.close(),st())}),t.addEventListener("cancel",n=>{n.preventDefault(),ve(t)}),e?.closeOnClick&&document.addEventListener("click",n=>{t.open&&!t.contains(n.target)&&ve(t)},!0)}function xe(t){if(t.open)return;let e=document.createElement("div");e.id=ae,document.body.appendChild(e),t.showModal(),it()}function ve(t){if(!t.open)return;document.getElementById(ae)?.classList.add(Y),t.classList.add(Y)}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var be=document.head.appendChild(document.createElement("style"));be.dataset.for="filters";var le={};function Le(t){for(let e of t.split(/\s+/))if(le.hasOwnProperty(e)&&!le[e])return!0;return!1}var ee=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),be.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=S.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){S.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),le[`tsd-is-${this.el.name}`]=this.value,this.app.filterChanged(),this.app.updateIndexVisibility()}};var we=0;async function Se(t,e){if(!window.searchData)return;let n=await R(window.searchData);t.data=n,t.index=Ie.Index.load(n.index),e.innerHTML=""}function _e(){let t=document.getElementById("tsd-search-trigger"),e=document.getElementById("tsd-search"),n=document.getElementById("tsd-search-input"),r=document.getElementById("tsd-search-results"),i=document.getElementById("tsd-search-script"),s=document.getElementById("tsd-search-status");if(!(t&&e&&n&&r&&i&&s))throw new Error("Search controls missing");let o={base:document.documentElement.dataset.base};o.base.endsWith("/")||(o.base+="/"),i.addEventListener("error",()=>{let a=window.translations.search_index_not_available;Pe(s,a)}),i.addEventListener("load",()=>{Se(o,s)}),Se(o,s),ot({trigger:t,searchEl:e,results:r,field:n,status:s},o)}function ot(t,e){let{field:n,results:r,searchEl:i,status:s,trigger:o}=t;Ee(i,{closeOnClick:!0});function a(){xe(i),n.setSelectionRange(0,n.value.length)}o.addEventListener("click",a),n.addEventListener("input",fe(()=>{at(r,n,s,e)},200)),n.addEventListener("keydown",l=>{if(r.childElementCount===0||l.ctrlKey||l.metaKey||l.altKey)return;let d=n.getAttribute("aria-activedescendant"),f=d?document.getElementById(d):null;if(f){let p=!1,v=!1;switch(l.key){case"Home":case"End":case"ArrowLeft":case"ArrowRight":v=!0;break;case"ArrowDown":case"ArrowUp":p=l.shiftKey;break}(p||v)&&ke(n)}if(!l.shiftKey)switch(l.key){case"Enter":f?.querySelector("a")?.click();break;case"ArrowUp":Te(r,n,f,-1),l.preventDefault();break;case"ArrowDown":Te(r,n,f,1),l.preventDefault();break}});function c(){ke(n)}n.addEventListener("change",c),n.addEventListener("blur",c),n.addEventListener("click",c),document.body.addEventListener("keydown",l=>{if(l.altKey||l.metaKey||l.shiftKey)return;let d=l.ctrlKey&&l.key==="k",f=!l.ctrlKey&&!ut()&&l.key==="/";(d||f)&&(l.preventDefault(),a())})}function at(t,e,n,r){if(!r.index||!r.data)return;t.innerHTML="",n.innerHTML="",we+=1;let i=e.value.trim(),s;if(i){let a=i.split(" ").map(c=>c.length?`*${c}*`:"").join(" ");s=r.index.search(a).filter(({ref:c})=>{let l=r.data.rows[Number(c)].classes;return!l||!Le(l)})}else s=[];if(s.length===0&&i){let a=window.translations.search_no_results_found_for_0.replace("{0}",` "${te(i)}" `);Pe(n,a);return}for(let a=0;ac.score-a.score);let o=Math.min(10,s.length);for(let a=0;a`,f=Ce(c.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(f+=` (score: ${s[a].score.toFixed(2)})`),c.parent&&(f=` + ${Ce(c.parent,i)}.${f}`);let p=document.createElement("li");p.id=`tsd-search:${we}-${a}`,p.role="option",p.ariaSelected="false",p.classList.value=c.classes??"";let v=document.createElement("a");v.tabIndex=-1,v.href=r.base+c.url,v.innerHTML=d+`${f}`,p.append(v),t.appendChild(p)}}function Te(t,e,n,r){let i;if(r===1?i=n?.nextElementSibling||t.firstElementChild:i=n?.previousElementSibling||t.lastElementChild,i!==n){if(!i||i.role!=="option"){console.error("Option missing");return}i.ariaSelected="true",i.scrollIntoView({behavior:"smooth",block:"nearest"}),e.setAttribute("aria-activedescendant",i.id),n?.setAttribute("aria-selected","false")}}function ke(t){let e=t.getAttribute("aria-activedescendant");(e?document.getElementById(e):null)?.setAttribute("aria-selected","false"),t.setAttribute("aria-activedescendant","")}function Ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(te(t.substring(s,o)),`${te(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(te(t.substring(s))),i.join("")}var lt={"&":"&","<":"<",">":">","'":"'",'"':"""};function te(t){return t.replace(/[&<>"'"]/g,e=>lt[e])}function Pe(t,e){t.innerHTML=e?`
${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Ve(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Ve(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Ve(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;r{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=gt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function pt(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Be),Be())}async function Be(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await R(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),ft(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function ft(t,e,n){let r=e.roots.filter(i=>mt(e,i,n));for(let i of r)t.appendChild(je(e,i,n))}function je(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let c=t.reflections[a],l=s.appendChild(document.createElement("a"));l.textContent=c.name,l.href=oe+c.url,l.className=c.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=oe+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let c=je(t,a,n,r);c&&o.appendChild(c)}}return r.delete(e),s}function mt(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function gt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.innerHTML='',t}X(re,"a[data-toggle]");X(ie,".tsd-accordion");X(ee,".tsd-filter-item input[type=checkbox]");var qe=document.getElementById("tsd-theme");qe&&He(qe);var yt=new Z;Object.defineProperty(window,"app",{value:yt});_e();Ne();$e();"virtualKeyboard"in navigator&&(navigator.virtualKeyboard.overlaysContent=!0);})(); /*! Bundled license information: lunr/lunr.js: diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index 96c4916b3..929e86c6c 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "eJydmMlSGzEQQP9lzhC2QAg31oorCw5LOFAchKaNFWRpImkITop/T2kwHsmWuuVc3a9fa0atZXz7t3Lw7KqDijWiWqsa5sbVQVVr3k5AObvBGvFu7CayWqsehaqrg/2d/f29zf2XtXnmAygwTK4/tKIGKRTYlGiZory/tXkEs87HWnBYt84wBw8ibc+xVA1reK+b6LqVYDes4XHe9lrFx0LWBlR1cDtPPpatdWBuutq9hktm7UwTIbF0azscyMlUsYngM36otUwLl7kC69XYAKtJaY9hzjPxDDU5zkWKNFJjXIAw3yuFTUtIYKbDe99K3MXDEsqBGTE+k4XQQt/s7iVkiwPL6FKji4XHwvBWMnPUjkaIMMYw4ekTKPdF6+baCSn+MCe0+grMtgb8Mrt0zAnrBLfZWsUGbBjdVH9voYVvuoZsrRjDhIMezdoCBlWhrTCgemBATP6AnvUZctxtdZevO92UEsZ0gR598wGDqYKJP298J+T7ZhktFBf05Mr9l0y4gF+teP1xxVJhJl7WWvYAP5hE2jSEMJlvxIEa6azoDaAk1MwFDKoyQhvhpvgijChcpyfCwgXYRisLN4Y1DbKs0jhW4G2pnDDHstoQKpENtRQ8v1ZjDBNeMfuY1fgglXzWKu7n7Pz+J3CHqmK0WNyA6Xb/C7CtLKwQ55SWGhrdgHHRzRCp0uNUgSGYkTYTpni+Yxc4Smm7zqbW1BJJaQt2wRgrFxbte/kUrFDiaBJgj7Xq4rlaaNaK5abUTCA5dKlTY3R+TwoYWoVu5T1Ci/yZ3V3STsAxkb/JJOkyfdk7DUhaW6Ys1hUsl0WQll77c5nwdQx6pe+/mJae2U2b+Ksyf/Rufvywtbsd3ux9m31iqpbhKdkbwzjp8g2BuYI46XoWqKoPU6bPQsojGLMnoZOqMF7iQkYVhClTcCFMmYIwbeoufsiwYoLynSv/JwyiiwDK5luxm/eUaR4ssVxNG8hJfIxy+KPo0E4VfzvvU7IlqMRKCf/HlVzeEVBiuyx43MtVnnb+NwuyCS1BlBX/bu3FBV+sGXeud/oo6THCsXuZtsxiq+xEwZt7Ykb49OXtaOHN7WQ2kKwrZBDVfBlmRT1BaPyrRC0dgEjSl7icMU2TenSUAYKI2BMT0icNmWFSghR20htHb4u0M6bYWL33/uXu5e4fzOwh7w==" \ No newline at end of file +window.navigationData = "eJyd1l1v2jAUBuD/4mtYW7oyxl3XrRqaJthA2kXVC+MciIdxItthoIn/PoWv2MT2cXeH5NePjxP7kJe/xMDWkCGhJScdUlKTkyHJClatQRp9Q0v+LjdrQTpkxWVGhoP7waB/O9h3LjOXIEFR0V1WPAPBJWgf1E5h7p9CrUB1WV5wBl1tFDWw5H49lMXW0Io13LrIKgH6Rivmzut1CMu5yBRIMny5TH4SlTagfh3WbhgmqNYnxom46F3PLuTzTtI1Z6f8pCiEH2znEtRZroBmKNrEYuYz30KG1nmdQkWsxqtQzDumYq/FTsSkx3l9lJhxy+LSgFpQdsLs0NW5eeh7sOvCApyvOhccRcsaYfWMkEJGeAXfgepKQX0Hx6XhhdRBrR2NwXXtI7kogtw5gCFYWVYmRs2oXj1XktXB8fw3MBMU29FkuARF6x8/QVcicQV3TupSE1WUoIzTTSOrNHFsAf2jggqwp95KxtjjMXw6tPbpsbPvsAUic/ClvihVhK+FlcGptDoTKrNaacs0u9L9uwkf6tuPH+4eepZ72MdXKjNhd4JGtMdRawPSxCxrHLW2PEo1w5j0jQvxCXK64YWXssdTrEhV1jAmWe3QJ1nDuKQ1XUKkLDeBeWNZf51FOCeAafVRPLx3n3QZTFFmuxJCSD2GGXXPedQ7yc5NzYe1QikqBv6P5b3eTiBFmyZsd/qW3V6+vyJNqBXCVF+z9sG+XJodOjvN6Fu6iLXrDVWczoWnlVzt+j5w+YOWnYlQlysUhJoEwtSPIaocAhHE8354WPSnUT5apRWJQHRDuagnTaiiQoDget2Ii/MFO4i+rEv33+9f96//AKKeQQY=" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 7afc7e981..5f2991332 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "eJzNnVuT6zaWpf/KRPo1yy1cJfnNXVUd4+iuLk/ZM/PgqJiglcxMzlFKWRJ1fE5V1H+fIEBIwOYCuXlR9jz5hFMAFslNXPa3AP7j4XT87fzw3S//ePhUHZ4evtuozcauNo8Ph+KtfPjuoXivHh4fLqf9w3cPT8fd5a081Od/Kd6rb1/rt/3D48NuX5zP5fnhu4eHfz7mankpD+Wp2P/u5VI9lfvqUJ5Bpd0fjWrjt+PpU3n63e71WO3K353rU1GXLxVsKffT3vbktaXzaXet9O34dNmX5385n3a9pYW8Kf39/nKuy9P/diquNbXFXE3JL0C9jw/vxak81K2YWzNG3GTujodzfbrs6iO3kW/SItkG06LxVa6kvoXOrq4+lz8c6vL0udhzJfhS1a3UTUV9fvpddf7d++lYl7u6fPpv7f+oDq/lqarLp0kyq/OfiurAlVed3/yv7y1rX5zrn4vzp5+rt/JcF2/vXIVNwbo4f6qjgvcWe3yvz1x97W/vLelcF3V1rqsdW1hS4t7ymif0/a/HU/1vl8Ouro4HtsymZNGUfI5KfoTcSUrvLFJaKXT0Lj+x3+OnXkHs9lc6Giufnn6O7hO7x3t6iu8U0jX+vsS6Xsq66eJGjTffvJR109P9Fgrd4+HFIl+Lw9O+/OPpxB+tfJGyLbLww/SV/3u13/+pPJ+Ll3Kcqk/Vfv92LfgxN+8vZfH0dZLaU1OSI3eGuvjV+PN7eSqaf0xSG78tx1DTR97s85TX/LU43/c131d+xnDtp388NXenjufAQ3OHys8drr32e1zFwnrbJ/Yf1bluZv5cjW2x/a3YvR/4qXw7fi6nPHNf8r6P/XThy7ncaeZKBX1//nrYjVBVtL//AGk/jVP2QcLO5eEp8+7+fBw/eDfVZd7j+vihw7q7sKlXwJU6UVn9h/K5uOzrKW/2uayffOnF3+44VfCHr4firdq1P/3xeMTr6O7P7pU0yLTEzhyAC8osOZ7Kc306fq0OL6OEJMVmRDdfaPlW1XUmsnMqb2X48cJX9Fztyx+L+nWUpKbQuy/0IbftrfhSvV3e/vPy9mt5+vOzfw3wTCUnua3i4Ko4Pv92reJjLqA6zL4AX8V/0QVkszY5ufNTN3xx76fjW3Uu/1Ke34+Hc/mnAifAclLb4qe2+FsxMw3GF36ui5OvgK/2VubjJI7tWKNCHyLSvwy/dzn6n64p+t8fD3X5pR6l3Nfks/23ZP/uWtMHXs5/Hp8yq7F+8Ye23EKjBUmb/VrsPv14Ks/nywkvxXPimoLvt4L8GdoodZfz13GqfIH7qKkOz8dRatoC93ly9df3cU+sLXCfe/NbforfH953fAlHZ2hzSuekaUcofK7LU6Pxj1/K3aVp6L8fj5/GCW2qaKSWoYpXX8XH3OLn65qm6ex+KuvLuJHbVRD1em0FHyL+1/L5eCrn3X5fx3/Z/d+9lrtP3x+e/vhW1W0p/zR+fypdovSPnxsGPm5x19RZHJ6aVcuT/007prZ1lqHOpfoV1hX9ofRLzoUv6ulW7X2vq7l55feHJ/eOJFfWvDnjLsbVVRye3OuSXM7B1/UxwZdc0iLX8vEX8VSeypfqlpr5EyNPnc9GhLr8dSyavB5zSS4pMiWRcqdxrq19Yoi0pT8+NspD8atHWef/cSkv41T7ws3IcP5bW/get9YPOyOlXcvcQ9Hzvni5Penvz/95rB2rHJef2hcvtwdenA/H+tRW8iGP/nl/Ob9OfPKubP+Dv4fkl7L2t/2HsYuWl7L29zq3ermHXA5YzQmeQ1f5Cp0t7VDs/3XqgjlUwF44L3h7r+LHrqevoofW1UuKzbvysjIXsObxBY6l7TnVSyF3vvK34v2PE4aIt+L9vqNEmCn9+bAr58+8Qm3Hw678L517LTeZ/P9iKsk0Q+SvYZYjgq+zAcg/NSnry3t7z38+9iDobNa7PDydfTXtDa+PH5uz8gR9ovSPF8uG6nnZs8n6KL23Kd2f3/P21h61t3nd8VrBnbRe3keno1ypj0xAncOkM0E342Yc5zD9TKDNvdaiGcUTwwEJv3NgvBb7vUvvlUkWaZzyphKfeknSR3dKfrk+dTx/vNMd/G322PzRYzIwCf382qyHhzxCt1/d2SJEGhrrEIquZpZBiMpY2B80LJNhD6IaZ7iDhvVwzEFU0KLeoGGJ461BVPAdnUEM+aONQR359/MFDcsfsgVRsYu5goaljTMFUaF38gQNy2ZYgqjWJR1BTIEjO9JF/UDDEifbgaju+7uBuBczaAbC0id7gaCuiVYgKm2uE4ilbSBx2dE00QfE0TJkA6JaprqAOFqGTEBUy1QPEEfLsAUIB/X9XrypBiCqcwH/D0PfaPtPR+b93D9M+SPMP1D8Pbw/w9InWH86/c0dnT/DF7CA8aezZLuf72fG9Yyy/bAvaRHXD+Oqppt+OpfyAZ6fsRe0xJV8+CXMMPx0swv3hzScCxq0+2TSIvcZ1UaZfTLKPjwqxlh9OgmcBZw+DIXDFLcjbDrBHdYzxebTyTTd0+XDuQS2yaerfHmPz7BgtsWHyl3e4TMsdoTBh8pdwN8zrG+svae7yLuTu2eE9JFr5MW9PQypg9aejsjlnD3D8iYae6jmhX09w7p5tp5uonyOq2dY1SxTDxX7MZ4e/kUtdkH/tRczxtDTvYIl/DzDKqfZeTo56/u6eXiXMVX4h0sda+Xpil7KycNSO8rIA7Qu4uNhKR228QB5C7p4WCLHmniA5KU8PJP1TguEhR08DPUTDDwd3Qv6dxiKh+w7kBbe5+6NNu9gAvFho29s3fm36kv5NHS6D/3RvYw7sB22b6dzKdNsO1jEUq4drsg+0w5WOMWzw1XTa9nBcpZx7HAFjjDsYLn38OuwxfPtOhnxd3DrcMVnzTpY6nyvDlcY06qDZS7t1OGK7jPqYKWL+HRGyRvXcS7j0uEKHG/Swarv6NEZdyl5i06f8PEOnR5VYw06WNhkf84IZbnUY0bRWHcOX0nWnIOVjPbm8JVkrTlYyWhnDl9JjzGnL5QXUzPWhYNFzTHhsNXxPTgZkXew4IwSz3Hg9Ehf1IDDFT7Gf5PpUO5hv+HKn+O+yay77mC+mX01PO/NyAuaZ71hX9ME503mQu5pvJl2OQtcx0dfwBTXTS45MJ2jTFeft9j0pjDuMmTxDDa9uj768bPsNZlUyxx3DVtfD0vNyJrAUblqRllrMhmhuzhr+BcwbKzJ6V7QV8OVO2yrwWIXdNVwpXJMNVjsHE8NVx3bUpNbmi3tqBktfNyqdjk/DVto3k6TkTjsppmqZax3BgtcyjrDVT3gnMllrCcZZ7iapvlmsNR5tpm5V7CU+o9UznLE5OTOMsRwNY70w2SSw9PsMHM0T1R5Z11sp0tO4WyjywitPJ9LVuk8m8sInT0ul6w4hsllhiK2pSWrb7ajZabaSU98KT8LW/sYO0tG9RJuFrberJmlh6nd5c7xrSx9OftFnSx9vIwaWQZOoCG/uauNZerpM/Q6ZphY7nXyDFPioIVliVNnmFqGDSz3OXGGKW+sfeUjTpvhSh9pXvmIk2aY0vutK8ufMsOUNca4cu8TZpiSB20rdzldZoy4UR3lgp6Ve5wrAzXf27Ey/0yZHtkT/SqLnCcDZc1zq8w6SwbrmeRVmXWODNQxzaky6wwZqGOaT2Xm+TE9AbyUlkkmlSUPiuFqG2lR+YhDYsZIZxtU7n9ADFP2aHvKhxwOwxQ/25zyEQfDzL2WEdaUDzoUhntFU40pH3ogzKSLmX8VHyx/sillyYNgJmsfsKQscebLOC1Tnv89/CgLnfaC0yaz3SjzTnrBoqaiyYVPecG5nfs5UZY54SWjemkfyhKnu0CpS7tQljnZBUqd7UFZ8FSXzJLrLg6UBU506Ze7jP9k1mkuWOBE98nyB7dAeYt6T2Yf2pLJNk93ntzrwBYo9A6+k3uczdKr/QN1800nCx/CwlQ4xXKy0AEsMxRP03hfVePsJnc4VoWvdITZZPEjVfgqh6wmdzpOhS9wnPPkHkepzNM65eEvajtZ+BAVrHkx08mcA1TySOwed22k4+QDjk7pwV2R38T/oOcJxz+4l9Ok0wbbZpLIzwC9YldXn8sfmgn95wI7aroCfKHqVmjGk+CI7Jn+d8UtcY4jR9S+8CuBn6u38lwXbxgwdPU15Zohq47K3Vlq1gTRVTffAcERdK6LujrX1Y4rKylwZ3HNw/n+1+Opvq7xmCKbgkVT8Dkq+AFip+i8r0TKn7FrBLy7/W4RbutjCSvo4WbgVY6ql7JuurQxQ0uTcGt6tiXOZ+RIfC0OT/vyj6cTe1zyJcq2xLKP0df979V+304jRmn6VO33b9dy91DmstNTpLmk9H21xfH/5/fy5ODpFK3xK3EMFXG0LxSQw+lfpHx67pejamxCEEwIFsoGctS+MebgXYWLTr05Mpl5qq7SmUkqlrYLW8zlPtNQKuf789fDjq+paH9+f2E/jdL1MbJcug6/rz8fR4/JLo2H3936+JGjtc9CTtPPFTpNFzsPidTNTkLmNBp7lfj9r03iaFcnW0rc4va52LXa4t+MWegP7ecYaoa7n4NednJNzL0bg1rQ3o0pDXc2agy2zNqoMUXKwKaMQWETNmVMktm/AWNY5vgNGFNkJnmGQVGDqYYpEno2VgwKGrmxYoo8uoliUBNnE8VkIaN6ItaGiSlSeJsjBvVN3xwxXXS6EYIpsbsRgimAs+thUMPkXQ9MUbGRZFjM2C0PPBHJfodBER3/0rRGk80Ng42O3tzAE0F2NjAj8ndiESmctNugor7M2yQh/bsYhvWM38UwWWZuxwJP5JgdC1MkDu1OGH7bJ+xOmCJ07E6EQeH32Ikw60Ly2xCmX8u8bQisy2HuQRi+hhl7EOYLn6/4jlK5ewsYC8/l3Gk84enGAu7KePYAkd9FwJVwx8eZ3TEwvFjv2zEwSQqxkA4rAP7RKQ0P7gUYTh9M2QswTSr2/TMU8n3/U4Rhj/+gLL7Hf4qoHNAZlNXHdKYI6TXvM9YPI837sySOWl+xjfqTJKWunGEx4035HBkcADeojcvgpggE9ntGXhHa76c0z/faD6pa1ms/RvxCwj9KdJZeMpT2AswpchiW+uHk3zKWeq7caQLvKKkXYjHEDXKsibLyznmOqH7n/ERJxCbP0THhQEammF5LPEfaoCV+QWFTHiHX/z5J5pDZfVjgEmZ3ltTE6c5jGbPvT7+tnZl7vcdgBOA278mNd7JzzOTDjY1xlOduwoCFfJC5zfChMiWw5ssjrezTpOS96wxV4wzs0wRySPIo2/o0GcCnzhDDNKtPk9TjTmdIG2lRny5xsrqFhc2BUlxD+DQx2ALOkML3gU8ThozfDFlT3d9jRCH/N1vaVBP4GIHQBs5WONkLPkYiyw3OljzZEj71EkalDLlG8GliZmSepvi/p4nMOb4ZwpaYmk72eTP0TcyV8O3dHA0DHu/JIlJTN0/JsLN7spyfxqu5k5ixBm7OhG0BF/eMi5mj+t7ypiS+Rlq4+dKide3vq9Pusi9O/3p5fs7ftvRXk9e15+rv2aERNPFN+/v8JRL1OdvBvizGXNo3ocDchsu39zqbJkMNhwJzG36+7LNpA9Ru+/u5zb6U2dwRatX/fG6j75dRjfqfz220Pn5/OhWjnm19LNoiUxqPXlnnVPqP4/H9f9bVvvp7O+8sGlz6Vh7qnwbX2uwKZiawlmn/m2tl+fvGvyUZwbvj5ZANo5F6Q113lFs97Ze6u21VdxR7uZVbSHNa47LS4zfNnW7iqFCfnyn91fRdTUVdjGjim/b3+asn6rMbParjqcoPU6jpqMzc5uuhzClqH2dM2QLiR/zD7Vc5BdFPJj/cX6q6WdMfT3/ltvJNKNF7jbH8XNdWvBe7ngfcaTgqMK/hvmlXt9XBORejyadyX+btIZ02rz+f2ejfxoTPN7ffz2q2d3LZaXR4Zslp8jDuSm+/n9Vs32y20+bgVJbRYM88ttPe0CSW0VxjpuydTnYadfbLwdkko+m+FVmn1cHlGG4w6W77Ngf/MGtXMBNK3BoZxSJ+6NvENuC5jprkmK17mxrYbBw1xdll3N8U0zMdtznGLN3feL/TL26T4e/rbYqZC4+aHJMC7226b4Nd1N7gzrreRiak16O2p2bVeyUNWzkjBUwPZ2+D/AR51PDIvHivgHEZwB9+nON5GxLCNrulMsa53IZEjHGUpTpGW8mmSBl1Z6aax/qF9Vmx4vYHPVi9zTA2YEeNcXde0yaTOUB/iv6Hmeapp6rZrH4od/mbFyfWk5/3XNBUW1TSGPFDjWykAe+sZtofTm6op2NKzEID3dBQI7t87582sxvo+QdsNOXprToUPWNN4p2Jfj29SXdazg+8oPA/nhcal8OpfGa1Fn45pinw9jI7bvTjyW/27vV4PA89RdDWN9eCgxdNLiu3YGv+M15GW2whEX52MkHGteBiQs496+U+HeehtfM4GfXJnXfSk8nvVeOKDyfvR4k6l/XQTCIv6VzWrFnEKEHt33887qvdhPf2m1DBe6hgIWHN7PKWkP9L+bdL5bP0U+6cm6peKzullS0k+PL+NDymIHHXgtOFgA65j1BEP5ne+Tb5WUYygDTl87rcjEB0Kb0Z3kYHW4EvUvsiCzUeFnC+zP/s8/z16AmrOT+rvnS8fpMkutv8H8W5/tFTmurv5dPI++WqaOzp77cqlrl/ruYpapZovk1Hj2q+LbNE8y9lPTd0Xsr6TnHTm4miMobzUcMNtqbI378Wh0M5tKy5Nd0W212LzRLR3dPrkPF/9y5itqjufl538svrtZpFRC4gcHlxSTrpxwGW3NGVZJVYVJkjqR0v/9AD1LtK2kKDVJ0hoB4/Si43QN4aj09h+KmP8+TFxEcxDNOfMeImClpEBDMfELU/JifQ1/RlVG+/SMfef5Jdp014kB2v2XhSGrlsBtY/3V9OnqK+lU9VkU1dZRr65loqf73gagYve9iGt7Dl7uXlVL70RHWfwy4qy7oLw6av4nN56on1PjHXkgtJea3O9fGUHZR6pNxKLiSlPeZ4gpRbyaWkcF+WjpJR7wtDiD9TeYqSa8npUgbfXk4mYrDgB7/VnabnvOHJDVjwbQcip775HIkT4r2rcGrsZwSmwecWNv+r2OenjfFvpodUs225sWmwW/kmLtLZGpP9ZEByRdmUfnMyZ69bvCvHH7057ArnCOhz3XZbbn6ND/mddRf6wF5XxCDd4zTZhzC6TXbIxRJX/X7M8+2uhPbX8656yOwMmkWL0iWu/tR39GJXR/ecxSmNDp/D0G05cwrDtOb7cSFqfMLXczlSaoYLpyuHbcEZK+G6gXyalmNU/A6imoHsMiJkoLRzqGQ5gcNGtn5tTCvbWFkMg12/Lq7Hjissb0TAOvCxPbPft4lBvmxw/1ieno+nt6LHfYJlvCcFZwoZ2vUCJPSdEjTv0ZyKw/m5PDVHG4zQ05ba+1LLSvJZqN6jU7qK2uR25+CU6QLGvDft+b79Lp5M0/E6oDHO9R0uHP4+ef7P+dxJ0kj+Uyf08q7aGU3fUojZTjKvgmtDHBR0OX8dL+Ry/rqUgNbaO+SjSgW0hVje10EB9OsBzJvQ+VjAvPtQ7i+8dv0PZzTkneSOiDMvNRSp2yJzG68OL6Nbrw4v85t/Lqr9qCv3BeY33OwxHh1hTaGlwuut+OKo05iLfyu+OOS0wPW/FV/6eFen3UHKNdhgdRjRYHWY3eDfxt7dpW5t7zI6bXJ4CT3Y2OXQnPTIbO5yqKsBw+dQgwOfuUsbRJ+4G99gWeyrw8votzUUXOqNPdfHfXkYEVC+wPyACqPqX7wflNu4L3S6FpouoO/7Z2mrnW+fjW2KcTJD2iL34IWhhj+XpzO70duPpzf4W1HV/Fe3+fXsd7cfvJMGuwdPTWtuxBs7402l65UBxB/9ZPKqxe8s7f9IF22n3Y4KvsKFrrFL9ifths2IYBp8WEI+j2j78+zmmvX0gN+s225TiOMw4wj4Ug353brtf6lYBjdG863hcKyCtthCIo6HfXUYrcGXWkjCqXTzCz8x+POhNzfTUdIW9l3O8TCco2EIaryD1eGF3xtEBeY1fLsPIxq/Xf9sATV3/25HxbgtvAwp4JvDvbPxRM3ojbwTBY29S1O387LlTRM0XUIyXrdAs38Qi3803Y83sOztNMJb+yYXkHtHx7U7udHOV5t3n8qeCUq35VuJ2Y37icaQBxto8AVZ9uuslPhwxOHDroAI1nFXrOZ7z50CLQ+fPMVqtv/sKdAu4/QpZsO9pzLBlhkzUU7TAwdCwVib0XTSjR3fqnP5l/L8fjycy/99Kt7fe6ZG8NfzLFQ/VS+H/MdZelr0dqpzKN53H+A15kQ150T/pTwfL6c82uyV1VRwulWwlLBT+X97DmPoU3QtuZyU83Gft5r1awlFlxJzW7H/e9nTXecl3Vbwn8qhbntAWPxq/cTYPxP/ZvJr9Lk61Zdi776Efnga/IZOp81v2grcl9APT7xTIZOr678B/Xuk019NvgkJgOv9Hi9oMMVwwwlucmUcSb0bFAclDW9hyUqKn0jfls3mb/czw15rz5hg6eU4pRO8prd2gMd0TCN9xs5bIx1D55gmhlyUt2ZYc8q+poYcg7emWAvIvqb6jVK3hoBBalQzQ91c1BKrQ+ttjGHtidrLWXoGmqRv6tU/+GvfwN/95eS3mBOQoCl+eJIrmhGsSAY7dHkyONbWnBS2wZUvJ5nmZJfGOUHJHKd/mdwrKRujwVz4l/J82fOCNS0yHWn0pVCHGvxmOIfad5k9/vC80XdQE8PiyxOVe1rDxlr868nPaGg0zTTFG1/BVS3QwVEpozu5YTljOjoqZ3RnNyxnfA9DRU3sZaA0GrsMwzH52fQeJe+iQ00Mmumo/IkvSadd1tvBaHjAjwPb5thymM2zpnIdAfxZHZZA44tFgjo/nLEjtTq8/Fuxq/vHrm5j37iSz6Fk/6WnF5XbPHg87C6nU3nIL9IzUtKSC0jZH4unP355Px7K/OFzGS1N0fJWdAExffAjI2IQgLAbd4jx36pDdX4tXU7nmP8+U0aMq+K5raK+VrGUuJ9aq9qfD//KsML3aQymt+OBbZGfJvUvzTRpjsJTW8FCwoKuKZJuRaeJof3f8EEb6a+mj66tD3xEM99EZfqvdvichKsRfHz7nNs9LMC7wce0fi0xt+mrf3tM61cD9wIC/ja69cWaPjew7lBXxX7/9Sdnch0jIy59DqVnSxovY0bT+ReeczZHvsS9ptl9B0hwZtzjzrVgzIH7BHGnw+NEDdlth1SxDLgsWXHwgENV3YHBh7r8kp2j9BYaE0IpOO//+sVwo6zPnvRfcEbaS1n3gy+GuJeyZpwPPFXeTzyLPk/nGOv+VMHjey2e9onHHE+6jP7jxhl6GceOTxJ2+7LKmJPpGYJvX14ZbVSceiEDq3ieaI5PcJrAr4cdLjhH8NfDDtzfu7yK/Ud2M8Qyju5mC+sfmIZMqz1F7jGvGWpucGLTd4lZ5/31JK3JstI6FpU3MPEalMaZeU2QNTT1GtTFmntNEVZWL6+jRjyi61p+rqzuq9e7myH6yTyfSX4BSZv45vb7oYv10ic4TjptMownjCZ7qWanzWGKyWiy3WvDbvT2+1nN9mGPTpuDyIPR4LkudlkbVKfF8OuxTXbfjr7jSG6/mPxucA4kIc3wjySJroDR/FBes08GK7E5LGd3PNTV4XK8nMeKuZVcSErr5OO2f/v5nEbzX1Kj7Q2YsIabuh1a8H3T3fbYZWjTt9MLilvJOVJ6jzGgrQ/7PIcbPI8MroVCqj9z2G10MGs43OTIk9mohinnsjFE9Wzy7ygY2uYPm+t2441Bwm2g/kNZF1V25wL88eTOvd9VmW+LY7PEl9VrEpkkhXW01wQxA9b/QUUc5/+QLBwmrMVn9MMZ2/qzm9lxI4Nb2rsXMbiL9vthS0NGzG0/LdfcMEEe9zsegxpHfc1jilC3l3GeRL8d8g7i/oPh0BiUx/ZqTBA4tHFzUBzL6McWxtqpnNHE36/cJ6fbNbHUzO2SPlX7/b+Wr8Xnaqg7SK65KfbrrdjQJQ/c/aa2geMeMho4xz2wJLwVX344+FPWh/NJadKt+FK1JZmJJM7DH/Z50N/dLxHasVmwsp/DYJ2VU6SN8xOJg3idseUr+sn97u+teuat9ZLn3NWoSf4N7W02nEXGa3T45DJGk7zkb9TqiGQvbViutmth5LXt3+8vzSfm0HlQzQrGC+j+aBxCT5v8Izqb6NZY/OdZzaBP7kXNRH+e1Qw46Chq5fbXOY38Oxrdbq3Ef57bTP5aor/OaeRPABDdGon+Oq8ReP5T3E78gzlN/Rme8nRrKfn7nIaa189FLWjk+re5DfwcpzjS+ps/zanepewacNzZ5nZrp/ObuQ0OtLV0M6j3TP4+t6Gfhu/fT0vdvtcmZdk/MnR+M6fBXifIrU30s/nNZgL/9sdZTZyqdL961ED7pzHVKzwy3B7Q5+JUNZV2h4dRD0jBXjvXTPyTia1cu7FcG7cfzGiheZp9Dbi/T6x/wGmTNoZ/PKvlvmuLfjGmDRsB8c9FtXfnVRWnYr8v99X59gnAa77dNYZ+ymj1r48P1eGp/PLw3T+u581+9yC/Vd9uHx4fnqty/3R++O6XgHF3x7d2IvF03F3cP//a/ux/lU1ar/mx//W/rB4ef1k9WvHtStq//vXxl1DY/cH9j1DH7f+4guLh8RfxqNW3SstH2f4jqUF0ahBJDfLh8Rf1KPW3K2Ue9aNS39qVeTTtP5KqZKcqmVSlHh5/segqVKegSgrqh8df1qig7hTUSUHz8PjL5lHbb5VKpZpOQZMUtA+Pv2wfjfzWqHVS0HYK2qTgurnhq+ZGW71JSq47JddJyU1TUqA2N52Sm6TktikpUZvbTsltGh5NtAj1aFbfrsQ2jYtuaAkSWy64NFIsQFSlYSWa0BAGttyNI5EGkmjCQ9hHvfl2tSKFu7Ek0mASTYiI9aNuZKu0cDeeRBpQogkTsYHX3I0pkQaVaEJFwLAS3bgSaWCJJlrkChbuhpZIY0s0ASNhcIludIk0vEQTM1LCwt0AE2mEySZmpEJ3W3YjTKYRJpuYkRoW7kaYJB1XEzPSINkS9FRphMkmZqSFLXcjTKYRJpuYkWvYcjfCZBphsokZCSNMdiNMphEmm5iRMMJkN8JkGmGyiRkFI0x2I0ymESabmFEwwmQ3wmQaYbKJGSXh3e5GmEwjTDUxoxQcV7oRptIIUyI3QqhugKk0wJQbGjXqhVQ3wBQZC5uQaUZU0DIYDtMAU03IKNj/qW6AqTTAVBMyag0LdwNMpQGmmpBRG1i4G2AqDTC1zg5UqhtgKg0w5QJsC1vuBphKA0w1IaNX8G53A0ylAaabkNECtay7AabTANNNzGiJWtbdCNNphOkmZrR61Prb7SqdtuluhOk0wnQTM1rDwt0I02TG1cSMNvCawaQrjTDdxIy2sOVuhOk0wnQTM3oNC3cjTKcRpl0XhgJMdwNMpwGmN9l5ge4GmE4DTLsAg++F7gaYTgPMuACDoW26AWbSADNNyJgVLNwNMJMGmGlCxsDQNt0AM2mAmSZkjISFuwFm0gAzTcgYBQt3A8yQaX0TMgb2vAbM7NMAM03IGBjaphtgJg0w08SMsXBJ0Y0wk0aYaWLGwJ7XdCPMpBFmmpgxG/RemG6EmTTCbBMzZosK226E2TTCbBMzFkaY7UaYTSPMNjFjYYTZboTZNMKsWzHCCLPdCLNphFmdnXnaboTZNMJsEzMWhqftRpgli8cmZiwMTwvWj2mE2fwK0nYjzKYRZjfZCbPtRphNI8w2MWPhlMR2I8ymEbZuYsbCKcm6G2HrNMLWLsLgi7HuRtg6jbC1zE7V190IW6cRtnYRBvvtdTfC1mmErZuYsbDfXncjbJ1G2Npk57zrboSt0whbNzGzhvOZdTfC1iRF0cTMGr6Sa5CkSCNs3cTMGs5n1t0IW6cRtm5iZq1g4W6ErdMI2zQxs4Zv1aYbYZs0wjZNzKxhbG+6EbZJI2zTxMwaxvamG2GbNMI2TcysYfZq042wTRphG51bnmy6AbZJA2xjssuTTTfANmmAbWx2ebLpBtgmDbDNOrs82XQDbEPSYJvs8mQDEmFpgG222eXJphtgmzTAtqt8Hq0bYNs0wLYiuzzZdgNsmwbYVmaXJ9tugG3TANuq7PJk2w2wbRpgW51dnmy7EbZNI2xrssuTbTfCtmmEbW12ebLtRtg2jbDtOrs82XYjbJtG2HaTXZ5suxG2JbnWbXZ5sgXZVppuXeXWJ/5Paeno/7XFRT51uQIp1xXJua5kdpXi/0bLk7TrSmUXKv5vtDzJvK50dq3i/0bLk+TrymSXK/5vtDzJv65sdsXi/0bLkxTsap1dtPi/0fIkC7vaZNct/m+0PEnErrbZpYv/Gy1Pws8l8PHqRaB8fyfhL7ILGAFT/iT+XBofr2EEyvrTtL/L5ONljECJf5r5d8l8vJIRKPdPk/8un48XMwKl/2n+36X08XpGIAJAEYBnAHBJIxAEoBTAJfbxqkYgDkBBgMvt44WNQCiAsADh0vt4bSMADRAEB4geHiAAEBCECAiX5McrHAGYgCBQQLg8P17kCIAFBOECwqX68TpHADIgCBoQng3ApY4AcEAQOiBcwh+vdgTgA4IAAuFy/njBIwAiEIQRCA8J4JpHAEogCCYQLvOPlz0CgAJBSIFwyX+88hGAFQgCC4QDAHjxIwAvEAQYCMcA8PpHAGQgCDMQDgPgJZAA1EAQbCAcCcCrIAHAgSDkQDgYgBdCArADQeCBcDxgvUFrIQHwgSD8QDgkAJdDAgAEQQiC8Aghc/tA+BGIIBwXwIsiATCCIBxBODSA10UCkARBUIJwdAAvjQSACYLQBOEAAV4dCcATBAEKwjECvEASACkIwhSEwwR4jSQAVRAEKwjPFfDrD8CCIGRBeLSAX3/AFgSBC8IBA7xYEoAvCAIYhGMGeL0kAGIQhDEIDxngkkkAyiAIZhCeM+DpIwANgpAG4eABXjgJwBoEgQ3C8QO8dhIANwjCG4RDCHj1BICDIMRBmB7jB2AOgkAH4ThCZvUEsIMg3EE4lJBZPQHyIAh6EJ494NkrgA+C0Afh8QMOf8AfBAEQwhMIPHsFCEIQBiE8hMCzT0AhBMEQwpGFzOoJgAhBSIRwcCGzegIsQhAYIRxfyKyeAI4QhEcIhxgyqydAJARBEsJRhszqCUAJQaiEcKAhs3oCXEIQMCEca8isngCaEIRNCIcbMqsnQCcEwRPC8wkcfwBQCEIoxDpvRRKAUQgCKYSnFDh+AaYQhFMIhx4yqydAKgRBFcLRh8zqCcAKQWiFcAAis3oCvEIQYCEcg8isngCyEIRZCIchMqsnQC0EwRbCkYjM6gmAC0HIhXAwIrN6AuxCEHghHI/IrJ4AvhCEXwiHJDKrJ0AwBEEYwlGJzOoJQAxBKIbwGANPnwDHEARkCE8y8PsLUIYgLEM4PpFZPQGcIQjPEA5RZFZPgGgIgjSEoxSZ1ROAGoJQDeFARWb1BLiGIGBDOFaRWT0BtCEI2xAOV6y3cPUE6IYgeEM4YoFXT4BvCAI4hCcc+PYBxCEI4xAOW2RWT4ByCII5hCMXmdUTAB2CkA7h4EVm9QRYhyCwQzh+kVk9AdwhCO8QDmFkVk+AeAiCPISjGJnVE4AeglAP4bEHfv0B9xAEfAhPPvDrD9CHIOxDOpiBV08SwA9J4Id0MAOvniSAH5LAD+nhB1w9SQA/JIEf0sMPOH2UAH5IAj+kgxl49SQB/JAEfkgHM/DqSQL4IQn8kA5mwNWTBOxDEvYhHcvAqycJ2Ick7EM6loFXTxKwD0nYh3QsA6+eJGAfkrAP6dkHnL1KwD4kYR/Ssw8Y/hKwD0nYh/TsA85eJWAfkrAP6dkHnH1KwD4kYR/SsQy8epKAfUjCPqRjGXj1JAH7kIR9SMcy8OpJAvYhCfuQjmXg1ZME7EMS9iEdy8CrJwnYhyTsQzqWgVdPErAPSfdBOJaBV08S7YSgWyEcy8CrJ4k2Q3R2Q8js6knC/RAk/vyOCLyRA22JoHsiPPvA8Yt2RdBtEY5l4NWTRBsj6M4IxzLw6kmivRF0c4RjGZm9KGh7BN0f4VgGXj1JtEOCbpFwLAOvniTaJEHYh3QsA6+eJGAfkrAP6VhGbkcMiD/CPqRjGXj1JAH7kIR9SMcy8OpJAvYhCfuQfs8E3mMC2Ick7EN69gGnTxKwD0nYh/TsA7+/gH1Iwj6kgxl49SQB/JAEfkgHM/DqSQL4IQn8kA5m4NWTBPBDEvghHczAqycJ4Ick8EM6mIFXTxLAD0ngh3QwYwM30UoAPySBH9LBDLh6koB9SMI+pGMZeGMWQB+SoA/pUEam9wLoQxL0IR3KwLtLJUAfkqAPqfNbdyRAH5KgD+k3V8CNphKgD0nQh3QoA+81lQB9SII+pEMZeLupBOhDEvQhHcrAO04lQB+SoA/pUEZm9gzQhyToQzqWgfedSsA+JGEf0rMPHH+AfUjCPqRjGXj3qQTsQxL2IR3LwBtQJWAfkrAP6VgG3oMqAfuQhH1IxzIysxfAPiRhH9KxjMzoD9iHJOxDOpaR2YwK2Ick7EPantEXsA9J2Id0LCOzJRWwD0nYh3QsI7MrFbAPSdiH9JsxMhtTQfwR9iEdy8jsTQXsQxL2IR3LyGxPBexDEvYhHcvIzB4A+5CEfUjHMjYCjj6AfUjCPqRjGTj5JgH7kIR9SMcycPJNAvYhCfuQjmXg5JsE7EMS9iEdy8DJNwnYhyTsQzqWgZNvErAPSdiHdCwjM34B9iEJ+5B+twaefQL2IQn7kI5l4OSbBOxDEvYhHcvAyTcJ2Ick7EM6lpFJvgH2IQn7kI5lZJJvgH1Iwj6kYxmZ5BtgH5KwD+lYRib5BtiHJOxDOpaRSb4B9iEJ+5COZWSSb4B9SMI+pGMZOPkG0Ick6EM6lJGZPgD0IQn6kA5lZJJvAH1Igj6kQxmZ5BtAH5KgD+lQRib5BtCHJOhDOpSRSb4B9CEJ+pCOZWSSb4B9SMI+pGMZmeQbYB+SsA/pWEYm+QbYhyTsQzqWkUm+AfYhCfuQjmVkkm+AfUjCPqRjGZnkG2AfkrAP6VhGJvkG2Ick7EM6lpFJvgH2IQn7kI5lZJJvgH1Iwj6kYxmZ5BtgH5KwD+VYBk6+KcA+FGEfyrEMPH1VgH0owj6UYxk4+aYA+1CEfSjHMnDyTQH2oQj7UI5l4OWrAuxDEfahHMvA028F2Ici7EM5mIGTbwrAD0Xgh3IwAyffFIAfisAP5WAGTr4pAD8UgR/KwQw8/VcAfigCP5SDGTj5pgD8UAR+KAczcPJNAfihCPxQDmbg6bMC8EMR+KEczMDJNwXghyLwQzmYgZNvCsAPReCHcjADJ98UgB+KwA/lYAZOvikAPxSBH8rBDJx8UwB+KAI/lIMZOPmmAPxQBH4oBzNw8k0B+KEI/FAOZmwkPKMHwA9F4IdyMAOuHhVgH4qwD+VYBs7eKMA+FGEfSuadVwqwD0XYh3IsA2ffFGAfirAP5VhG5uAcwD4UYR/Ksw+YfVOAfSjCPpRjGTj7pgD7UIR9KMcycPZNAfahCPtQjmXg6a8C7EPRE6Icy8DZM4XOiKKHRDmWgbNnCp0TRQ+KciwDZ88UOiqqc1aUymbPFDwtisSfYxk4e6bQgVH0xCjHMjLTD3RmFD00yrGMzPCNjo2i50Y5loGzZwqdHEWPjlJ5559Ch0fR06Mcy8DZM4XOjyLsQzmWgbNnCrAPRdiHciwDZ88UYB+KsA/lN37g+APsQxH2oRzMwNkzBeCHIvBD6Tx7U4B+KEI/lKMZG3zEG6AfitAP5WjGRsP+B9APReiHcjRjg+MP0A9F6IdyNGNjH435drsi/TegH4rQD+VoxmaNy4P4I/RDOZqx2cDygH4oQj+Uoxkb6DxUgH4oQj+UoxlbyN4UoB+K0A/laMYWZk8VoB+K0A/laMYWTz8A/VCEfihHM7Y4/gD9UIR+KEczthqXB/FH6IdyNGNr8PMD8Ufoh3I0Y4uP3gX0QxH6oRzN2K7h+wPohyL0Qzmasc2cGgjij9AP5WjGdgvbB/RDEfqhHM0QKxyAAH8ogj+U9RNAAZ8A4B+K8A9l/QIYhyAAIIoAEOWARqYLAgBEEQCirLe/KHwF6OhGEoPtuVQaVwCCkCAQZXs6QYBAFEEgyiENscJvAWAgijAQ5ZhGphcFDEQRBqIc08j0ooCBKMJA1NpHIX4NAQRRBIIoBzUywxiAIIpAEOUhyAqeRaQABVGEgqh1Pg2tAAVRhIKodd4DqAAFUYSCKEc1MoemAgqiCAVR67wHUAEKoggFUeu8B1ABCqIIBVGb/A4kBSiIIhREbfIbMBWgIIpQEOWoRmYeDiiIIhREOaqRSaMBCqIIBVEOa2Tm4QCDKIJB1CZ/ZpoCGEQRDKI2+WPTFMAgimAQtcl7sBTAIIpgELXJe7AUwCCKYBDld4Bk7j+IP4JBlMMamOIpgEEUwSDKYQ2xghv4FeAginAQtfVdIJ5JAhCiCAhR2/zJ7wqAEEVAiNr6TMwKduKAhChCQpQjG0LguShAIYqgEOW3gQg8EwAsRBEWohzbEAKP5ACGKAJD1NZ/aQBPRwENUYSGKEc3hDC4AnSeMj1Q2eVjBBwJNeAhmvAQ7Q/CEvibEACIaAJEtAMcQkA/nwZERBMioh3hEE1OqPsUNEAimiAR7ZGIhHNSDZiIJkxEr3xSEEaiBlBEEyiiV35DksSXAM5aJlRE+y0hEkaiBlhEEyyiHeYQEs4pNeAimnARvfKfvoBzQg3AiCZgRPsPYEgciYCMaEJGtP8IhsSRCNCIJmhE+w9hSNinasBGNGEj2n8MQ8I+VQM4ogkc0f6DGApHIqAjmtAR7T+KoXAkAjyiCR7R/sMYCvaJGvARTfiIdrxD4I8AaABINAEkWuTPBNQAkGgCSLQDHkLBPlUDQqIJIdH+aCwF+1QNEIkmiEQ75iEUjmQASTSBJNpDEoUjGVASTSiJ9pREwQWSBphEE0yiPSZROJIBJ9GEk2jPSTQc3TUAJZqAEu1BicaRDEiJJqREy57BWQNUogkq0R6VaPwqAFaiCSvR/lsa8Ah8gEo0QSXaoxKN3yTASjRhJdqzEg1hkQawRBNYoh38EBq/CYCWaEJLtKMfQsNMgwa4RBNcoh3+EBpmCjTgJZrwEq18HOI+HQATTYCJVj4O8ZsAiIkmxET7T23kngKIQ4JMtPLIDg8KgJlowky0YyDC4FcJQBNNv7qhVz2PEX14g355Q4uex4g+vkG/vqFlz01EH+CgX+DwB2YZ/DKjj3B0vsLhItHg7gR+iINEot83YvC4hD7GQb/G4VAITv1q9D0O+kEOv3EEL7g0+igH/SqH3zmSmamjD3PQL3P4rSMG9yfo4xyEnmiTz15rQE80oSfa7x0xFoYRwCea4BPtN49AfK8BPtEEn2i/ecTghwj4iSb8RPvdIwYCTA0AiiYARRsfhrg/AwRFE4KiHRERFndHAKFoglC0QyLCwgy+BgxFE4aiHRMRFq+WAETRBKJoB0WEVfgmgjgkFEU7KiIsfpcBRtEEo2jrNzHh1RLgKJpwFO2wCOYwGmAUTTCK9hjF4i4dYBRNMIr2GMXiLh1gFE0winZYRFg8RwUcRROOoj1HsTiSAUfRhKNoh0Uyn2UCGEUTjKKt/0wRfhMAR9GEo2jPUdZ4YAYcRROOoh0XEWs8qgGQoglI0Wt/jDmeYwKSoglJ0Z6kNH44MCYAkqIJSdH+KK01HhMAStEEpWiPUtZ4tQVQiiYoRbcoBa+2AEvRhKVox0YEPkxVA5iiCUzRa3+gB45kQFM0oSna0RGxwUM7wCma4BTt8IjAu6I04Cma8BS98b4uHIkAqGgCVPSmb2gGREUToqIdIREbmNLXAKloglS031gCkYQGSEUTpKIdIhEbPCgApqIJU9F+a8kGvwoAqmgCVbSDJGKDXwVAVTShKtpvLsFffANURROqoh0lwe4IDaiKJlRFb3wY4lcRYBVNsIr2Hw5pyDAYFwFX0YSraH+0FlyzA6qiCVXR/vMh+DOBAKpoAlW0hyrY36MBVdGEqmhPVbDBRwOqoglV0dv80ZYaQBVNoIr2UGWLZ3cAqmgCVbSHKls8uwNQRROooj1U2eKVGoAqmkAV7aHKFufCAVTRBKoYD1Xwe2AAVDEEqhgPVbBNyACoYghUMR6qbOGLZABUMQSqGA9VtnBMMwCqGAJVjIcqW0hlDIAqhkAV4zearOCYZgBUMQSqGMdIJHYKGQBVDIEqxjESuYJmXQOgiiFQxThGIldwdmUAVDEEqhgPVfC4bgBUMQSqGMdIsE/FAKZiCFMxDpHIFRzTDGAqhjAVI7zfGo5pBjAVQ5iKET1+LwOYiiFMxThEgu1aBiAVQ5CK8UgF27UMQCqGIBXjkQq2axmAVAxBKsYjFWy3MgCpGIJUjP/mOLY7GcBUDGEqxn93HNuVDGAqhjAV4789ju0KBjAVQ5iK8d8bwXYFA5iKIUzF+G+QCzgwGsBUDGEqxp+6JXAgAqZiCFMxLVOBC14DmIohTMX4b45gv4IBTMUQpmI8U8GU2ACmYghTMf7kLYE7NMBUDGEqxiESiQ0PBjAVQ5iKcZBEYsODAVTFEKpiPFXBeVwDqIohVMU4SILTsAZAFUOgilE9fgcDoIohUMU4RoKToAYwFUOYivFMBecgDWAqhjAV45kKTp8ZwFQMYSrGIRKcvDIAqRiCVIxHKjh5ZQBSMQSpGL8LBbteDEAqhiAV4whJ7hmAKCRExXiiknkGgKgYQlSMJyo4D2wAUTGEqBjt+0OYvzOAqBhCVIz2/SHu0gFRMYSoGAdIJPbtGEBUDCEqxgESiX07BhAVQ4iK8Udx4Uy0AUjFEKRiWqSC32WAVAxBKsYRkkwcAaJiCFExLVHJxBEIRPq9c0dIcmGAPnlOv3luejLZBn32nH733PRkEA369Dn99rlnKpmHgD5/Tr9/7pkKzhwZ9An0zjfQTb4/g19BJ3HokUpmrYS+hE4/hd6eyQXTdwZ9DZ1+Dt0fyiXx1AJ9EZ1+Et2fyiXxzAB9FZ0gFWN7ViqAqBhCVIw/lkvimQUgKoYQFePP5ZJ4ZgGQiiFIxfiDubCBzQCkYghSMf5kLmxgMwCpGIJUjPUdIu6SAVIxBKkYR0gkNrAZgFQMQSrGIRKJDWwGMBVDmIrxn03HBjYDmIohTMU4RCKxgc0ApmIIUzHtt0lwJAOmYghTMWt/QgiORMBUDGEqxn9GXeEuFTAVQ5iK8UwFmzkNYCqGMBXTMhXcJwOmYghTMZ6pZLpUwFQMYSrGMxWcyDWAqRjCVIw/pgtuEDAAqRiCVIzfoAI3mBhAVAwhKmbt4xD3BoCoGEJUTLtDBfcGgKgYQlTMxsch7g0AUTGEqBhPVDITNEBUDCEqZuMPqsbdCUAqhiAV45EK9kUbgFQMQSpm40+rwf0RQCqGIBXjkQq2NRuAVAxBKmaz7slCAqZiCFMxm03PuwigiiFQxWz8gZkZBSASCVQxLVTBLzOAKoZAFeM3q2ReZoBVDMEqZut3S+FOHXAVQ7iKaTer4Gku4CqGcBWz9V9swqMC4CqGcBXjOEkmbQC4iiFcxWxtz2oJcBVDuIrZ+lPT8bAEuIohXMVse+xfBnAVQ7iK2fpAxDMswFUM4SrWYRKpYZ9qAVexhKtY/+ES6PiwAKtYglXsysch7JMtwCqWYBXrKInEdlQLsIolWMWufBzCLtUCrGIJVrF+rwrctmUBVbGEqlhPVbAb1QKqYglVsX6rCgb9FlAVS6iK9VQF21ktoCqWUBXrj/DC8ysLqIolVMX6rSrYgGYBVrEEq1hHSTBnt4CqWEJVrKcq2M1qAVWxhKpYT1VwCs8CqmIJVbF+pwp2b1mAVSzBKlaYfDrdAqxiCVaxwgci7JEtwCqWYBXrsQom1RZgFUuwivVYBTt6LcAqlmAV67eq4E0SFmAVS7CK9VgFG2otwCqWYBXrsYrBPSrAKpZgFeuxisE9IsAqlmAV67EKhqwWYBVLsIp1lCRbAYhEglWsxyoGhzLAKpZgFSt9JMKh2QKsYglWsR6rYEutBVjFEqxiPVaxuEsEWMUSrGLbY73gJNMCrGIJVrGqZ45oAVaxBKvY9qMmuEsDXMUSrmJVTx7RAq5iCVexfrNK7hJAJBKwYv3ZXhb3SACsWAJWrAcreJ5sAVixBKxYf7oX9iVbQFYsIStW9ZhvLCArlpAV257vhXskQFYsISvWb1bB7h0L0IolaMX6E74yrzNAK5agFeuP+Mq8zgCtWIJWrEcreMFlAVqxBK1Yv1kFG5AsQCuWoBXrN6tgA5IFaMUStGI9WrF4XABoxRK0YrWPRDwuALRiCVqx2veJeKYM0IolaMX63SqYkFnAVixhK7ZlK/BlBGjFErRiPVrB/nQL0IolaMU6UiKxv9wCtGIJWrFG5i1UFqAVS9CKdaREYoO6BWjFErRiHSmR2KBuAVqxBK1Y/7UTbFC3gK1Ywlas/9zJGneJgK1YwlasZyvYoG4BW7GErVjPVrBB3QK2YglbsZ6tYIO6BWzFErZi/SdPsEHdArhiCVyxHq5gg7oFcCX8v78+PlSHz+WpLp9+ODyVXx6+++WXh+LX46kuft2XD4//ePg/lf//jSPDNfbw3T8emr1z3/3jn48Pjfniu3/885+PoTX/v0M77m9Nw67K8imusMnVXCtssjHses7Vy6HYJ3Wt1lFdYsus61yfil39fjwmlW3Era7m4yJj6vrtePpUnpLa5K225qxeVm27uvqc3P1tXIth3itXS3Woy9Pn9HZtb5VZX1iGB9qcB8yq/OmpLs6fni+HXV0dD0mkRM9CtNXqjf+vWIn2H6b9S/PxU/8PI9t/bEzQsm3/sTY8Uc91eWpklV/K3aXR9Xo8foq16U0UxNugSQZNJmjaBCmW37B/9ofjU3ku68t70mx0x80qNKtCs+EhrLah2TWv2ZeXU/lS1OmLqm10japtpNnxy6uyOrw8F7v6mERxg65vV2CY8t6ruI7VrQamlvPXw+5Uno+X065MX/foMRruS/W5qPZNr/ZenIr9vtxX57ek0nX8Wljma/C5PBUv5P6v4/sfXgDNq/DXYvfp/VSez5dTUqvWcaW+8LaNGxEiWa6ur1AbZM2WOPcPuxrf/rkui311eEl77ejqrG9vVKXRW5J2GlF4aGav+2v5fDyVvS+8WcUDQ3jzdHjzQt8jVuHGMVu+7D6V9TkNSh03xbzdl/PX5DGbeJBtH/M6qA0iQ8/RfLqH20r2vov4vvNGzl3xXuyqOlHeHNh5G6Isb4javZa7T93RrtmEH90GXufv6zo8lW9V/fT1ULxVO3/Nu1NZNKFRfi4P6SMzcacWBoGVCbc7DAJChNvNvD05JU/luT5ddhkx0f0zYWhYhVfchFdchFd8y+v2dq/HKu09o3vLe313r8fjOX1A8RivmV3LrjrtLvvi9Ovl+ZnMkaKZoOI+7n1ZpJWYuJL2nWnOdvUTVcGMyKbapkc5/+1SXtKLlvFFM1/w3f5yrstTM8c8vjcPPu0zbPQwmlzPiCq7U81YHq+m42F3OZ3Kw+5rOtjHoWh4PeLuePDBnU4c4oG6fSTt27QJnbAK/ds29G9+gOM0WVeHy/FyxiPVJh6puFVeDnUyVY5D0zBDs+lwyuLw5OaBSQ/Q9L/JSx+vgcINCTNiYcMNEaHD3zKjLlGQaToerkKfFya+woY+L8zgm+9scZp+KuoiuYHr+AZuw2yo7ddMiIYGp7OqL5+Ly75uVlt1+ZKOQOsobJuN9Lz69iWZP6/iR26DUMHV19TXdCBp1xGvOwTzTl6rCqss/yAvZzrjlNu4dl6kP5XdDi6ewagwc2x2O42ocF+c6/dTdTxVdfX38qlzJ1Q8z2N2ym3V3briuQv7AZ3Kl+rWgb6V5+Z+7pv/dUj7UxONKGGNJsIaTdgwEIuwatxy7/y5Ph2T0DXRki3MSUWYkwob3n4RForbsFpfc5+Na5L0kCp+3O3VhLW3UKEn2IaegDk5bNvKdDpxnia0EOZXwoa+RoR5ObdXqM674+FQ7uo0nqP3QnH7L99dpyNJvDJcMWPW1xON/8mtj/sYZk/lK6xfT2XxROtbR/d1wwxDOi6RdUGc7lvzhp2kykZmOq0Q8WAneTmEpMpOz9dsVIuq5M1Uyv0lvdJ4sbFu3wMT1gONc9b/Y9PGqw1pKat4IdWsA+q0a1HxZLV9vTehi1Ghi9mGLma9Cu87766Vb+/p6mxj48lxeyGKucwuD03apLtiaU4xiLJpvPfCV9aOEGl8rOL+ljlI+urwhN3Ek89wT8P6SYSVgRRhnRfyKc1Z9n6awux+ygMYS+MnbLdhLGU+v0NmwItnOMxxuTx8Th9aPGiGS7ZcYacTSQyKOLV5xQJbpramutfi8LRPXw8R57t1SIBYxRTZRCqotaHe0WqLGfxNZfvj8f1SV/vq7y6T8FYWTSqr+d25LurqXFe75M2I77EyvP7Yp7DSAE7GnRDAITcQpqZShNxAuFHNxxTazot5kb7tlM/Es0pjmQ+0rci9kGkvG2e21mNuCV3XxTNIY5khEWoCwuJ0+ZrZiX2pUICJeLXYnFrShi1v4vRcVHvyCOIJrmH21r4acJ1xeoAJVJ6rJl1evyZDVzKUtENXmLPqEKXbMGdlTh2eqy/lU2aytI76ccFMkrj6XCdKp6DbWD8zueFqy8y8ordEMBOEz/vi5TbvKs6HY92ZLdkoysNiXITFuAiLMylDimDLvJL95fyKh0sbBVtY3IiwuBE2jJIyrAe2zIu97FO8GicE9JXw8SbBL80aLYWZkWpeqL2UySphs4nj4TrRYtf1VlSHbi5OxDEbZhohrauYU/6Xsn4/7iuSnVPJYpH3EF7Ka8rkVNanKp3sN5uYomUZWxwnNxGvdDRzltFWfRtbT+XfLlU74KbC4ykek4a8lC2mrw7Px+QFkPH0ILwAYVYe5nBStu9G8+VxVnuX6qncVwdyz8eGrR9vOhOweP51zQ+EVKJSY+r+VO33bToknZdHLVxhfcjmMtdA7WjZ9HKoifglDh1NSLkoxZst+CbimDy+l6d2wtZtMn4A4dGG3ItSvHnAa3HOuSBkFPehkw75DRFuowgLOynDeBmyIio4JZovxPp/MF/M1+pcH09pajTxPSje4F8lcxFh40E4iA0ar+9EGPftittIajPaxjkpwxvrmzqyaYz4wpnZsuo2eUiXdNGLoCwv7mkfk5gz2gcbJooi3E4ZALXchPu6af+kBW+cd7afQ7HP+QlsFJ5hJSzCqyfWQYgMHQmT9F+bJVw74VyhRw2vnQhJFylDqDNxTUVnYyI2ginmbL46N2N4Ws2tlrD4DK9seJnFOrwF8mqiusq/uqmY11E3HRXp2FfxIjKMR4aZ3q/AlCR2zSgmSWrr8RQZUpe4Y9DMIbHC2eHm40LRZIFXVzNqpYLi13R79d/wph5Nbb+Wr8XniuQ54mSSDXFqma6quNZ0FrBO3kNen9nUhtIbSbogBKVlGo8abtOMZXX1Vp7r4u09vadRejkEexieJe8tawhLPFie30/N+FzTuWhsT2i7obD2EOF/iJCUlfI6IQkridV1ZhIEbnh91/5YPJVf3o+HMkXAMh7KjeFNuN+Kd5DQSRJQofcLY6dYh3WCvM4BrpfAe+vfii/V2+UtHfpjOMhcPbf1HC5vv5an47N/W5PHpBKs66sJCXKhw2MKb59c8x5B0+7B+4GaOEyTd/GCmEkP3oovbhgnWZXY3sCkWteaQGIlvsHMBP1b8eVc/T3t/DZxNj2koM2Kqe+WkkzfpjiDtAngQjMfx61SYF4RsYFbM5e0ceo07QjjGQJz4jeYhxWJn465VIG15lagIvaQaWam7618qop0wpH6O8NkL1hjNPuBddc5cc1mywxPX8/utTgcynR0jaGxZjrt2+pgxjSubnuNT2Z3l2f3MnrwoYOVIYeumCChrf9zsScrgdirp7liq0Onb47dqZoJJNp6+vrmeJ7XjiDh1Rc6jDbbMNowk/Fv1aHbZcXBz0xFud8nc4t4iRYczDpAShOcCSZ4+kxIoxlmztMlWU+ngvhV4zwwc3wiGx3iaZFissLjYUcuP/bNMrnZ8dDkk+D7FDPU1TXvwJuiHd9J5xZJuyZq/X+DV08EM7rYXldBYUq2vq6CeLemWcw53JaO+9Fzskxz6LUmMsbE0y/mJoamKrqIb75pcwtZJhrLWECbbwlEPSDvXWzqqr++kwlS7MzXfFFNReQ+xbeciUjej6fUfGMSKzuvb0C2gG3Sm4V9DSFRb4J7wgTXhNFMwW1bnTyPjA2AZsWt7fhWnctTeX4/Hs7lW5Gsn1RsRGo7tuCrEgGai+31xWFGedrmb6fi/Z2MgnEnZ5ipo/dLykdi7Ya3mEST7vimMmnPbcbt9v3RDGs8etoVL+Bzk/h4m55mJlo7zE6YJLsXZnEhd2dXvC4nGBSbocIP7zlHg4h9RJq5Eapbfc88Ku59Q7JahGS1WIc+/7pTb+QlDl1efD+ZOxPZ9s64vwwJTxESnmIdXkYVJo3MnuBU/l/iQ5SxD9GwL+PtSHbFxKhHhz1Ahpnd8PVlaUV0o8PTDVlZEbJdIixKpbp6QgMACLZYFbo3teHNOU7Nbsl00hFPipluy2aX4P4zYUqxT0Ry79K5Lk4tHzweAG2LO1TmxpeWuHb2FogYe2kmMDld0gcXBXGIXRnovWKuR0+Xg9trmVQcDbshAGTIQitm3vN0OXTqjYL4mjgPYEwxk5Wny4Hmh0S8iUhvrjbO4EgLyTUTZq5WXf/Bm3Sdy8OTi47Le9ur1Mdult1G9y0QAhEuVARjlgyrGsXMcjeNZ7Kn9RFbEGKf1DVNGliPYmYUXLu5BuKN8qFrCHRHMZfFvgFwH6M4CQsJES5DhP2tMkz/FHM/1rnZSnCoq2K//3quj/uSQNs4WcL0gJzLut2Vkutd44RjGClDPIpw50SYJkh1fY8Djg6mVXXdpr/h9RY3bUMcR8ZzVMPMN59LmBiM2boOOWzDHBDOrfnDzdRA7fFG4TD/EOGuivDiyys1D7BaMffyJ+2jBYmIc9+aObA0tVaHF+Kfjm03TMLqdnTRXc7xJt4wcRGhfxObACqvRIS57+ZcDoZNvOcqTA9EmB6IsMdPqmskX80MvIliRgKKi6j/D92sCN2sCPta5HV+Iq5shTevO78W+73fWJdsSkg0RN1H6KJE6KJEMPjLsFRVTD8UzbttYpPElcOtr4g4rI0tc2w5JSN0nBfjla+LXRKOMk67G6ZP0A2tyc2MKgl9owh9owiWUxksp0pcZ54jGkxXqTpBx75c2IQhAt0Xwa8hQ/ejud1l0yKxM+tkDtg2GSImPFsRMuOSyZeiWSzpcmLDHNNlkWEr0ft2PT7hurUkzHi0YXZrdVFf0ixUvA4wzMQf3AgcIxrLXMWFinK+ovgV1NyRDcw34hclLLgsk/n5+kAuI04KcCcKvmMlMD6GKGOqIVmReLy8Ju/Dm2xC1BtmkjC0QXcai5h76LCKNUx7Qqi1a7gVMf/XYXO2kczpRN52K+JdWZo7Pfl62IERseOiiF8eZgzQ7UbNV9yiFTTv6VyzddeVSso5o04jzHevJnAm1XdNNPcBZzJiow7T9ZM9yip2/ejrWjL4Gywz1Zx4Un/tpIdiB5VhUkBoc02lx9kiprMI1noqz5c9URyPIsyFHqy72+2L2OehmUaAuG5sKxLx7gYdfL6GiUmSlXd6l6N4DkuP6yaCsLSzzJ6NYY8SsUldB7OwZWYRmgaorTfu3IKJyoTVk2XaDZuKcRjGzk/NnJA2tb2Xp+fj6a2guDS2UOmQfjRMLtEZK2Xig2W6vl0tz9WhOr+WT00e6nghhrE4i8A8SSxz5ky8KtfMoexWVe40t/jsD8vEQrdakzPCqCUgHnj01SfJNIpEbfgDtkjtMoaKlsk7bpVmHX4xt7HMBH1vkqL5Vlw0zw4Dx4juLJ9/kPF8yjLzD7cqu08s7hmZsxpXXZgjHw85l7mUyREaI6SGul2PklYZj5aW3z3hVYyM89zG8odJhjUs7gZ0OFnHMO02vg2wmokz/oZ5zpqrLDthim3DhvlOlae36kBPnoyXhCrQbM2d1bntlWR0iueLimn3ue3TRCduxelDyx02XI3gbNc4w85MqEN/ddxbqDCo6YBxTMjbGe407tixO8VHNSjmmrw+FYfzc3lq4Gk6BsfrluvOBKapjvpWkuMy2wsN6Q5xPRM2uLplSGbqkACyzMz/5XAqn9Pgio9oYGapLu9PNOrjPk4HDmqYy7nuhkkdT/CYR5pEZxMkDz2+wDDn1cx85+fydKaTuXjvrmam2T5Xp/pS7N0pnYcnGP4yNpoZplvst6KquxAwOd83JBZCns4Ez41lboH7raxeXomJLH4+hnmoEGBnJLPy+BBscyK49kRIlciAUGTIp+vAOzRzGw8jYxCfD2CZuxxwtc25fOWXpMtIgrp9CGFzgLgaBsOVy6v7nZnuHIRb8dY9E/oSy+wHmQBCxhu2zA17jbmEruHAJt3j9XwV3iSi3edMVnzxO2KvM3TeTALvnJbxtkbL3AQ2aNCJbYiB64mwMhVht4kM8aSYi4xbStf5jp7KuqjS0+Rje7dlHkR0q/VTSY69Sk6ZDftjmcfVJdWm4RafwWr01fAw5uY39aJIjo+ltMxzhjKZ8mSTSCsyWM9FwAUybHaWgdyp0HnrUV0sfC3jDjukb+31QTAX1S1MwYuI9OgM3vjqK+y4eGOUa5lHB92qIl16nApl5l5yJ62lhyMwR51T1fmOhIyJseV8yuCvjw/v1bs7QeHhu1/++s9//j/efjW9"; \ No newline at end of file +window.searchData = "eJzNnV2T4zaypv/KRvm23CN8kJJ85zPjieOY9dg7duxedDhOsCVWFU9LVI1ItbvH4f++AZCQgOQLMvmhmnNlR5cAvCATH5lPAvz94Xz6rXr45v3vDx+Lcv/wzUZtNulq8/hQZsf84ZuH7LV4eHy4nA8P3zzsT7vLMS/r6k/Za/HupT4eHh4fdoesqvLq4ZuHhz8eY7U852V+zg5fP1+KfX4oyrwClXZ/NKqN307nj/n5693LqdjlX1f1Oavz5wK2FPtpb3vy2lJ13l0rPZ72l0Ne/ak673pLC3lT+ufDparz8/+zKq41tcVsTcEvQL2PD6/ZOS/rVsytmUTcZO5OZVWfL7v6xG3kq7BItMGwqN/LldQ309nVxaf8+7LOz5+yA1dCU6q4lbqpqKv910X19ev5VOe7Ot//r/YfivIlPxd1vp8ks6h+yIqSK6+ojs2v7y3rkFX1L1n18ZfimFd1dnzlKjQF66z6WHsF7y329FpXXH3tb+8tqaqzuqjqYscWFpS4tzzzhr79cDrXf72Uu7o4lWyZpmRmSj55Jd9C7iSldxYpUym0N5b37HG87xXEbn+lvbVyv//Fe07sGW+/958U0jX+ufi6nvPaTHGj1puvnvPazHS/uUL3eHm+yJes3B/y785n/mrVFMnbIgu/zKbyvxWHww95VWXP+ThVH4vD4Xgt+DYP7x95tv8ySe3ZlOTInaHOHxo/vubnzPzPJLX+aDm5mt7yYVdThvlLVt13mB+KZsdwnad/OpunU/t74KG9Q9HsHa6z9qtfxcJ62zf2v4uqNjt/rsa22OFW7N4v/JwfT5/yKe+8KXnf136+8OVc7rRzpYK+rb6UuxGqsvb3byDt53HK3khYlZf7yNj95TR+8TbVRcZxfXrTZd12bGoPuFInKqv/kj9ll0M9ZWRXeb1vSi8+uv1QwV++lNmx2LU//el0wn5092f3ChpEWmJHDkCHIi7HPq/q8+lLUT6PEhIUm2HdfKH5sajriGXHVN7K8O2Fr+ipOOQ/ZfXLKEmm0GtT6E0e2zH7XBwvx79fjh/y849PzTDAO5WY5LaK0lZxevrtWsXbdKAoZ3egqeLf1IFo1CYmd37ohi/u9Xw6FlX+j7x6PZVV/kOGA2AxqW3xc1v8mM0Mg/GFV3V2birgq72VeTuJYydWr9CbiGwGw59tjP7na4j+z6eyzj/Xo5Q3NTXR/luwf3et6Q278/fTPuKN9Ysv23ILrRYkbPYh23386ZxX1eWMXfGYOFPw9VaQv0Mbpe5SfRmnqilwHzVF+XQapaYtcJ83V395HffG2gL3eTa/xbf4/eZ9x0E4OkIbUzonTDtC4VOdn43G7z7nu4tp6D9Pp4/jhJoqjNTcVfHSVPE2j/jp6tOYye7nvL6MW7ltBd6s11bwJuI/5E+ncz7v8Td1/Nue/+4l3338ttx/dyzqtlTzNv58zm2g9LtPhoGPc+5MnVm5N17LvvlNu6a2deauzqXmFVaP/pI3LufCndrfqr1vv8zDy78t93aMBD0zI2dcZ2xdWbm3wyXoTtnU9TbGF3Rpkb68fSf2+Tl/Lm6hmR8Ycep4NMLV1fRj0eD1mC7ZoMiUQMqd1rm29okm0pZ+e9vIy+xDg7Kq/3PJL+NUN4XNylD9sy18j0fbLDsjpV3L3EPR0yF7vr3pb6u/n2rLKsfFpw7Z8+2FZ1V5qs9tJW/y6p8Ol+pl4pu3Zftf/D0kP+d189i/H+u0POd186xj3ss95HLAakzwHLrKV2jT0srs8B9THWZXAdtxXvDxXsWP9aevoof86iXFxrPyojIXSM3jCxxL22Oql0LufOXH7PW7CUvEMXu97yrhdko/lrt8/s7L1XYqd/m/de+13Gbyf8RWkpkMEe/DrIwIvk4DkH82IevLa/vMfzn1IOho1Dsv91VTTfvA69Pbxqwagj5R+tuLZUP1uOzZZH2U3tuW7sfXeHprj9rbvu50reBOWi+vo8NRttRbBqAqt+kM0M24HUfltp8BtLmXLxpRPNEckPA7G8ZLdjjY8F4eRJHGKTeVNKGXIHx0p+CXnVPH88c7PcHfZq/Nb70mgyShX16MPzyUI3T71Z1ThEhDYzOEvN7MShCiMhbODxqWyUgPohpnZAcN6+EkB1FBi+YGDUscnxpEBd8xM4ghf3RiUEf+/fKChuUPpQVRsYtlBQ1LG5cURIXeKSdoWDYjJYhqXTIjiClw5ES6aD7QsMTJ6UBU9/2zgbidGUwGwtIn5wJBXRNTgai0uZlALG0DgcuOpol5QBwtQ2lAVMvULCCOlqEkIKplag4QR8twChA26vsNvKkJQFTnAvk/DH2j0386Mu+X/cOUPyL5B4q/R+7PsPQJqT+d+eaOmT/DHVgg8afjst0v72dGf0al/bC7tEjWD6NX05N+Ol15g5yfsR1aoidv3oUZCT/d6ML9IQ2nQ4PpPpGwyH1WtVHJPhFlb24VY1J9OgGcBTJ9GAqHKW5H2HSCO6xnSppPJ9J0zywfThfYST5d5cvn+AwLZqf4ULnLZ/gMix2R4EPlLpDfM6xvbHpP18m7U3bPCOkjfeTFc3sYUgdTezoil8vsGZY3MbGHal44r2dYNy+tpxson5PVM6xqVlIPFfs2OT38Ti3WoX9vZ8Yk9HR7sEQ+z7DKaek8nZj1fbN5eN2YKvzNpY5N5emKXiqTh6V2VCIP0LpIHg9L6XAaD5C3YBYPS+TYJB4geakcnsl6pxnCwhk8DPUTEng6uhfM32EoHkrfgbTwPk9vdPIOJhBvtvr6qTt/LT7n+6HbfeiP7pW4A9th5+10ujItbQeLWCprhyuyL2kHK5ySs8NV05uyg+Usk7HDFTgiYQfLvUe+Dls8P10nIv4O2Tpc8dFkHSx1fq4OVxgzVQfLXDpThyu6L1EHK10kT2eUvHET5zJZOlyB45N0sOo75uiM60o8RadP+PgMnR5VYxN0sLDJ+TkjlMVCjxFFY7Nz+EqiyTlYyejcHL6SaGoOVjI6M4evpCcxp8+UF1MzNgsHi5qThMNWx8/BiYi8QwrOKPGcDJwe6Ysm4HCFj8m/iUwo90i/4cqfk30T8bvukHwzuze83JuRHZqXesPu04TMm0hH7pl4M607C/TjrTswJesmFhyYzlGmq4+n2PSGMO6yZPESbHp1vfXrZ6XXREItc7Jr2Pp6WGpE1gSOylUzKrUmEhG6S2YNvwPDiTUx3Qvm1XDlDqfVYLELZtVwpXKSarDYOTk1XHXslJqYa7Z0Rs1o4eO82uXyadhC4+k0EYnD2TRTtYzNncECl0qd4aoeyJyJRawnJc5wNU3Lm8FS56XNzO3BUurfUjkrIyYmd1ZCDFfjyHyYSHB4WjrMHM0TVd5ZFzvTJaZwdqLLCK28PJeo0nlpLiN09mS5RMUxklxmKGKntET1zc5omal20htfKp+FrX1MOktE9RLZLGy90WSWHqZ2lyfHT2Xpi9kvmsnSx8toIsvADTTkN3dNY5l6+wztx4wklnvdPMOUOJjCssStM0wtwwks97lxhilvbPrKW9w2w5U+MnnlLW6aYUrvT11Z/pYZpqwxiSv3vmGGKXkwbeUut8uMETdqolwwZ+Ue98pAzffOWJl/p0yP7In5KovcJwNlzctWmXWXDNYzKVdl1j0yUMe0TJVZd8hAHdPyVGbeH9NjwEtpmZSksuRFMVxtI1NU3uKSmDHS2Qkq978ghil7dHrKm1wOwxQ/OznlLS6GmduXEakpb3QpDLdHUxNT3vRCmEmdmd+LN5Y/OSllyYtgJmsfSElZ4s6XcVqmvP975KMsdNsLDpvMzkaZd9MLFjUVTS58ywuO7dwvE2WZG14iqpfOQ1nidhcodekslGVudoFSZ+egLHirS8TluksGygI3uvTLXSb/ZNZtLljgxOyT5S9ugfIWzT2ZfWlLJNo8PfPkXhe2QKF3yDu5x90svdrfUDc/6WThS1iYCqeknCx0AcsMxdM03lfVuHSTO1yrwlc6Itlk8StV+CqHUk3udJ0KX+C4zJN7XKUyT+uUl79o2snCl6hgzYslncy5QCWOxO7x1EZmnLzB1Sk9uMvLN2l+0POG/R/cK9Ok0wY7zSSQHwF62a4uPuXfmw39pwxn1HQFNIWKW6EZb4Ijsmf73xW3xD2OHFGHrPEEfimOeVVnRwwYuvpMObNk1V65O0uNJkF01c3PgOAIquqsLqq62HFlBQXuLM68nG8/nM711cdjijQFM1PwySv4BmKn6LyvRMqfcdYIGLv92SLc1scSVjDDzcCrHFXPeW2mtDFLiwm4mZltifsZORJfsnJ/yL87n9nrUlMib0ss+xqbuv9WHA7tNmKUpo/F4XC8lruHMhudniLNBqXvq823/x9f87OFp1O0+kPi5CriaF/IIIfDv0j59NgvR9XYgCDYECwUDeSoPTL24F2Fi269OTKZcaqu0plBKpa2C1vM5T7bUCrn2+pLueNrytqf31/Yz6N0vY0sG67D4/WX0+g12Ybx8NitT2+5WjdRyGn6uUKn6WLHIZG62UHImMYkvUr89oMJHO3q4EiJdW6fsl2rzf/NGEd/6DzHUDPc8xy020GfmGc3BrWgsxtTGu4c1BhsmXVQY4qUgUMZg8ImHMqYJLP/AMawzPEHMKbIDOIMg6IGQw1TJPQcrBgUNPJgxRR59BDFoCbOIYrJQkbNRKwDE1Ok8A5HDOqbfjhiuujwIARTYvcgBFMA59TDoIbJpx6YovxEkmExY4888EQE5x0GRXTyl6Y1GhxuGGx09OEGnghysoFpkV+LRaRwwm6Divoib5OE9J9iGNYz/hTDZJmxEws8kWNOLEyROHQ6YXi0TzidMEXo2JMIg8LvcRJhVkfixxCm92XeMQRWd5hnEIb7MOMMwnzh8xXfUSr3bAHD8VwuO40nPDxYwPWMZy8Q8VMEXAl3fJ3REwPDznrfiYFJUkgK6bACkD86peHBswDD4YMpZwGmScV5/wyF/Lz/KcJwjv+gLH6O/xRRMaAzKKuP6UwR0pu8z/AfRibvz5I4yr9iJ+pPkhRm5QyLGZ+Uz5HBAXCD2rgMbopAkH7PiCvC9PspzfNz7QdVLZtrP0b8QsLfSnSUXjKU9gLMKXIYKfXDwb9lUuq5cqcJvKOkXojFEDfIsSbKimfOc0T1Z85PlETS5Dk6JlzIyBTTmxLPkTaYEr+gsCmvkJv/PknmULL7sMAlkt1ZUoNMdx7LmP18+tPambHXeyxGAG7z3tz4THZOMvlwY2MyymMPYSCFfJC5zchDZUpg7ZdHprJPkxLPXWeoGpfAPk0ghySPSlufJgPkqTPEMJPVp0nqyU5nSBuZoj5d4mR1CwubA6W4CeHTxOAUcIYUfh74NGEo8Zsha2r29xhRKP+bLW1qEvgYgTANnK1wci74GImsbHC25Mkp4VO7MCpkyE0EnyZmRuRpSv73NJGxjG+GsCW2ppPzvBn6JsZK+OndHA0DOd6TRYRJ3Twlw5ndk+X8PF7NncSMTeDmbNgWyOKe0Zk5qu8tb0rga2QKN1+a59d+35et/f2sNG3mLvHWyKjN4fd9WYUDENxrkkO/e5sayP72muKkffc3xYTYfptj6HV/4/3oxW+TAVx6m2JuTrwmx+xJepvuy3j02htMdextZMJ+x2t76janV9IwW/MUMKFab4P8HYvX8MiNSq+AcVPy9z/NgRBDQtj0IZQxDjsMiRgT4g91jI7tT5Ey6slMjeb3C+uLjfvtDwbFaTPBgty/gfl+Zmh5X5hU/jLfxXvibzuCn/d0aGrQOGiMRItHNmLCEqxm2h9ObqhnlghCqQNzwlAju/hUHDazG5iGB4KM+flYlFnPxB9EFr1fT2/SniX8nmcUzY/nmcalPOdPrNbcL8c05Y/eH/LMpC0d87IemLC6v5w8po/5vsiiRhlp6KtrqXhfQW9wt8181pcR5/4+uYucMzpBI/HzObSTV+2Mpm/pk9H3GlfBPbU0KOhSfRkv5FJ9WUpAu/0Z2iSEAtpCrP3BoACa8s58CJ0M93nPIT9ceO02P5zRULPbtu40s6uuSN0Wmdt4UT6Pbr0on+c3/5QVh1E9bwrMb7jYH8aPd1NoKfM6Zp+tTzCm88fss3UIFuj/Mfv8c/Ev5mx7zD5XzY9nNFiUIxosytkN/nPs013q0Z770u7DJrv59aMbu5QmPYHZ3KWsmx9Pb3DgbHbYIDqXPb7BPDsU5fPo0eoKLjViq/p0yMsRBtUUmG9QblX9R16fe6JItPGm0PlaaLqAvkO7YaudA7tjm7rUxaH4V9YXrQlbDAtMb/hTfq7Yjd5+PL3B37Ki5g9d8+vZY7f/3DNpsEtLpjU3YsTOGKnUXxnwz7yfTPZamuh7/8lS2k4bsgdHR1Efu27ZJGIQEcHkBiwhn0a0/Wl2cyZ75j+bXBB+u6bQy7XQPAGfi3p0+5+LeqHm24yDsQraYguJOJWHohytoSm1kIRzbvcXzcbgx7I3F6ujpC3cTDmnspuRNUGQidoX5TN/NvAKzGv49hxGNH7r/2wBNZdxdFSMwxwMKeCinN7deKBmNOyYKGjsU5qKPNjypgmaLsFfr4Ncuw//3UMvur+cvHq/novTuaijphFp6iuvXLzPoEcDe/uxMljGyZdRMyhpTAoblPLl3HaOf8u/RI0yJui2jfzYlJ4oKWqjLoPzH3l1OfCMNSwyfc/Zt8YNNfjV8CLX182e7P8L7x0hTdfic0XF3tZw+gX+9eR3ZP8zvqmv2nK85+D1aoEJjkoZPckNyxkz0VE5oye7YTnjZxgqauIsA6VR22VtpTo/nJ7L91yUz3/Ngo+rsBr7ypZ8yoY/stLpVETK7lTuLudzXu56LQVICUsuIOVwyvbffX49labsOC2maH4ruoCYqid2HhExGEFnN2736H8tyqJ6yfcmZnW6jH0itoqntor6WsVS4n5uY70/lpzbSfo0uqjxqWQz5mlS/2GWsTkKz20FCwlzuqZIuhWdJsaf/yakh/UUmb7TiuPfoeYGiXBfF6Mxn2uyxmRZYR2LyhvAUIPSOGRqgqyhGPugLlbYfYqwvHh+iYeNh3Vdy8+V1R16vXE07yfTtxvmaG0cIdImvrr9fqizjfRYXklWZ+w2zY/Jha8Tmux11zptDrtnjCaP/WcUO42iU4gTmu1zejptDno6jAarOttF70/ptOh+PbbJ7uhgLUVzFx+TxPof+Uv2qRgyn2BWMMU+3IoNdXZgjjK1DcT3Ixo48X2WhGP2+fuyufVieBoP17rsc9GWZM7fYGpcbdciuX2D8s+Hi7keC+FFw70bLd0fjbEC2uR3CHXdGvP/PKsZwyN7mvH+PKsZwM28Vm5/ndPI39DYubXi/3luM/G+eH+d08gPYNd3a8T767xGIE702/F/MKepHyE0vLUU/H1OQ2b4WasFjVz/NreBX/y0mLB+86c51RtnyZ5t7gTlb+10fjO3wYG2lm4GzZ7B3+c29PPw8/t5qcd3/UhyfGXo/GZOg73nuW5top/NbzZi+Lc/jmlC4an79gQ/ZefC5Kt05+9RT1DBaTXWjP+Tia1c55lYG7cfzGjBPO6+BuzfJ9YPrKeINoZ/PKvlvr55vxjTRuq5oZ+y4mAq/Ck7Z4eDucHjeG3sev7WNoZ+ymj118eHotznnx+++f2aX/jNg3yn3m0fHh+eivywrx6+ee+cp93p2K70+9PuYv/31/Zn/zc3IXbz4+bXf1o9PL5fPSbrdxvx66+P711Z++/2H1wVt3+x5cTD43vxqMW71fpRNv8NyotOeRGUlw+P79WjlO+2yfZRPyrxbqM3j0n7P0FVslOVDKpSD4/vU9AF1SmngnL64fH9GpTTnXI6KJc8PL7fPGr1Tqy2QcGkUzAJCqYPj++3j3r7TokkKJh2CqZBwbV52KtHvXqnRdjkulNyHZTcmJICtbnplNwEJbempERtbjslt6FpGEsRCjUqumYliF1Zw9KwMLCp0KiEMQyRPOr03XqbhoW7ViRCMxLGOkQKC3dNSYS2JIyJiPWj2r5TKx0W7tqTCA1KGDMRG9jnrk2J0KiEMRUBzUp07UqEhiWMtcgVLNw1LRHaljAGI6Fxia51idC8hLEZKWHhroGJ0MKksRmp0NOWXQuToYVJYzNSw8JdC5Nk2jI2IxMkW4J5KrQwaWxGprDlroXJ0MKksRm5hi13LUyGFiaNzUhoYbJrYTK0MGlsRkILk10Lk6GFSWMzClqY7FqYDC1MGptR0MJk18JkaGHS2IyS8Gl3LUyGFqaMzSiFVpWuganQwJSILRCqa18qtC9l10X9qPW79SYUrbr2pchCaCxGJbBlsBiG9qWMxagUtty1LxXalzIWo9awcNe+VGhfyliM2sDCXftSoX2pdXSdUl37UqF9KWtfW9hy175UaF/KWIxewafdtS8V2pc2JqMFall3DUyHBqaNzWgJC3ctTIcWpo3NaIVk666F6dDCtLEZrWHhroVpst8yNqMTKBvsuUIL08ZmdApb7lqYDi1MG5vRa1i4a2E6tDBtZzCzxU3XRHXXwHRoYHoT3RboroHp0MC0NTA4LnTXwHRoYIk1MGjaSdfAktDAEmMyyQoW7hpYEhpYYkwmgaaddA0sCQ0sMSaTQNNOugaWhAaWGJNJFCzcNbCE7OqNySRw5k3Axj40sMSYTAJNO+kaWBIaWGJsJoGmnXQtLAktLDE2k8CZN+laWBJaWGJsJtkg2066FpaEFpYamzHOW1d22rWwNLSw1NhMCi0s7VpYGlpYamwmhRaWdi0sDS0ste4itLC0a2FpaGGpjm48066FpaGFpcZmUmieadfCUuI7GptJoXmmwH0MLSyNO5Bp18LS0MLSTXS/nHYtLA0tLDU2k8ItSdq1sDS0sLWxmRRuSdZdC1uHFra2FgYHxrprYevQwtYyulNfdy1sHVrY2loYnLfXXQtbhxa2NjaTwnl73bWwdWhh6yS65V13LWwdWtja2Mwa7mfWXQtbkwiFsZk1HJJrEKMILWxtbGYtYctdC1uHFrY2NrOG+5l118LWoYVtjM2s4ajadC1sE1rYxtjMGtr2pmthm9DCNsZm1tC2N10L24QWtjE2s0axq03XwDahgW10zDvZdO1rE9rXJol6J5uufW1C+9qkUe9k07WvTWhfm3XUO9l07WtDgmCbqHeyAWGw0L4226h3suna1ya0r+0qHkXr2tc2tK+tiHon2659bUP72sqod7Lt2tc2tK+tinon266BbUMD2+qod7LtWtg2tLBtEvVOtl0L24YWtk2j3sm2a2Hb0MK266h3su1a2Da0sO0m6p1suxa2JZHWbdQ72YJYKw22rmLuSfOnsLT3b21xEQ9crkDAdUUirisZdVKav9HyJOi6UlE/pfkbLU/irisddVWav9HyJPS6SqLeSvM3Wp5EX1dp1GFp/kbLkwDsah31WZq/0fIkBrvaRN2W5m+0PAnDrrZRz6X5Gy1PzM+G77HzIlC0vxPuF1H/RcCAP7E/G8THLoxAMX8a9LdxfOzFCBT2p3F/G8rHjoxAkX8a+rfRfOzLCBT8p9F/G9DH7oxA8X8KABoCAD0agRAAZQA2rI+dGoEoAMUANrKP/RqBQAAhAcIG97FrIwALEAQGiB4aIAAOEIQHCBvixw6OAERAECQgbJQf+zgCQAFBqICwgX7s5gjABQQBA6IhA9DTEQANCMIGhA33Y2dHADogCB4QNuKP/R0BAIEghEA0iAC6PAIwAkEggbBxf+z1CIAJBOEEwsb+seMjACoQhBUIG//Hvo8AuEAQXiAsAsDujwDEQBBkICwFwB6QANBAEGogLAjATpAA3EAQcCAsC8B+kADoQBB2ICwOWG+AKyQAPBCEHggLBKA3JAA+EIQfiAYgRJ4esD6CEISlAtgnEgAiCEIRhAUD2C0SgCMIAhKEZQPYMxIAJQjCEoTFA9g5EoAmCIIThCUE2D8SACgIQhSEhQTYRRKAKQgCFURDFfDoB1hBEK4gGrCARz8gC4KgBWFxAfaVBKALguAFYYkBdpcEAAyCEAbRIAboMQnAGASBDKKhDHj3CDCDIJxBWHSA/SYBSIMgqEFYeoBdJwFggyC0QViAgJ0ngBsE4Q0i6cn6AMRBEOQgLEWIOE8AOghCHYQFCRHnCXAHQcCDaMgD3rwC9CAIexANfMDmD+iDIPhBNPwBmz8AEIIQCNEgCLz5BAxCEAghLFeIOE8AQwjCIYRFCxHnCZAIQVCEsHQh4jwBGCEIjRAWMEScJ8AjBAESwjKGiPMEkIQgTEJYzBBxngCVEARLCEsaIs4TABOCkAlhYUPEeQJsQhA4IRo6ge0P4AlB+IRYx/OQBCAUgiAK0TAKbL8AUghCKYQFDxHnCXAKQUCFsOwh4jwBVCEIqxAWP0ScJ0ArBMEVwhKIiPMEgIUgxEJYCBFxngCzEARaCMshIs4TwBaCcAthUUTEeQLkQhB0ISyNiDhPAF4IQi+EBRIR5wnwC0EAhrBMIuI8AYQhCMMQDcTA2ydAMQTBGKLhGHj8ApIhCMoQFk9EnCdAMwTBGcISiojzBICGIERDWEgRcZ4A0xAEagjLKSLOE8AagnANYVFFxHkCZEMQtCEsrVhvkfME2IYgcENYXoGdJ0A3BMEbouEb+OkBwCEI4RAWWkScJ8A4BIEcwnKLiPMEMIcgnENYdBFxngDpEAR1CEsvIs4TgB2C0A5hAUbEeQK8QxDgISzDiDhPAHkIwjxEAz3w6AfUQxDsIRrugUc/AB+CkA9pUQZ2niRAH5KgD2lRBnaeJEAfkqAP2aAP6DxJgD4kQR+yQR9w9ygB+pAEfUiLMrDzJAH6kAR9SIsysPMkAfqQBH1IizKg8yQB+ZCEfEhLMrDzJAH5kIR8SEsysPMkAfmQhHxISzKw8yQB+ZCEfMiGfMDNqwTkQxLyIRvyAc1fAvIhCfmQDfnA5g/IhyTkQzbkA24+JSAfkpAPaUkGdp4kIB+SkA9pSQZ2niQgH5KQD2lJBnaeJCAfkpAPaUkGdp4kIB+SkA9pSQZ2niQgH5KQD2lJBnaeJCAfkp6BsCQDO08SnYKgxyAsycDOk0QHITonIWTUeZLwLASxv+Y0BD7EgY5D0PMQDfnA9otORNAjEZZkYOdJokMR9FSEJRnYeZLoXAQ9GGFJRuQcCjoaQc9GWJKBnSeJTkfQ4xGWZGDnSaIDEoR8SEsysPMkAfmQhHxISzJip2GA/RHyIS3JwM6TBORDEvIhLcnAzpME5EMS8iGbAxP4fAkgH5KQD9mQD7h9koB8SEI+ZEM+8PgF6EMS9CEty8DOkwTsQxL2IS3LwM6TBOxDEvYhLcvAzpME7EMS9iEty8DOkwTsQxL2IS3LwM6TBOxDEvYhLcvYoLOzEqAPSdCHtCgDOk8SkA9JyIe0JAOfyQLgQxLwIS3IiExeAHxIAj6kBRn4YKkE4EMS8CF1/NiOBOBDEvAhm4MV8IypBOBDEvAhLcjAx0wlAB+SgA9pQQY+aSoB+JAEfEgLMvBhUwnAhyTgQ1qQEdk8A/AhCfiQlmTgI6cSkA9JyIdsyAe2P0A+JCEf0pIMfPBUAvIhCfmQlmTgs6cSkA9JyIe0JAMfP5WAfEhCPqQlGZHNCyAfkpAPaUlGZPEH5EMS8iEtyYicQwXkQxLyIdOexReQD0nIh7QkI3IaFZAPSciHtCQjciAVkA9JyIdsDmJEzqQC+yPkQ1qSETmWCsiHJORDWpIROZkKyIck5ENakhHZPADyIQn5kJZkbARafAD4kAR8SAsycOhNAvAhCfiQFmTg0JsE4EMS8CEtyMChNwnAhyTgQ1qQgUNvEoAPScCHtCADh94kAB+SgA9pQUZk+QLgQxLwIZuDGnjvCcCHJOBDWpCBQ28SgA9JwIe0IAOH3iQAH5KAD2lBRiT0BsCHJOBDWpARCb0B8CEJ+JAWZERCbwB8SAI+pAUZkdAbAB+SgA9pQUYk9AbAhyTgQ1qQEQm9AfAhCfiQFmTg0BvgHpJwD2k5RmT3ALiHJNxDWo4RCb0B7iEJ95CWY0RCb4B7SMI9pOUYkdAb4B6ScA9pQUYk9AbAhyTgQ1qSEQm9AfIhCfmQlmREQm+AfEhCPqQlGZHQGyAfkpAPaUlGJPQGyIck5ENakhEJvQHyIQn5kJZkREJvgHxIQj6kJRmR0BsgH5KQD2lJRiT0BsiHJORDWpIRCb0B8iEJ+ZCWZERCb4B8SEI+lCUZOPSmAPlQhHwoSzLw7lUB8qEI+VCWZODQmwLkQxHyoSzJwKE3BciHIuRDWZKBvVcFyIci5ENZkoF33wqQD0XIh7IoA4feFEAfiqAPZVEGDr0pgD4UQR/KogwcelMAfSiCPpRFGXj3rwD6UAR9KIsycOhNAfShCPpQFmXg0JsC6EMR9KEsysC7ZwXQhyLoQ1mUgUNvCqAPRdCHsigDh94UQB+KoA9lUQYOvSmAPhRBH8qiDBx6UwB9KII+lEUZOPSmAPpQBH0oizJw6E0B9KEI+lAWZeDQmwLoQxH0oSzK2Eh0Ow8gH4qQD2VJBvQdFQAfioAPZUEGjt0oAD4UAR9KxrOuFAAfioAPZUEGjr0pAD4UAR/KgozIlTkAfCgCPlQDPmDsTQHwoQj4UBZk4NibAuBDEfChLMjAsTcFwIci4ENZkIF3vwqAD0WvhrIgA8fOFLodil4PZUEGjp0pdEMUvSLKggwcO1PokqjOLVEqGjtT8J4oYn8WZODYmUJXRdG7oizIiOw+0G1R9LooCzIiqze6MIreGGVBBo6dKXRnFL00SsWz/hS6NoreG2VBBo6dKXRzFAEfyoIMHDtTAHwoAj6UBRk4dqYA+FAEfKjm0Ae2P0A+FCEfyqIMHDtTAH0ogj6UjoM3BdiHIuxDWZaxgXe7AfShCPpQDfrA0wdAH4qgD6Xj1/0ogD4UQR/KoozILW8AfSiCPpSOX/qjAPpQBH2oJH7vjwLoQxH0oZIe5wOgD0XQh0risRcF0Ici6ENZlBGZPgD6UAR9KIsyIpt/gD4UQR8qiZ+4VAB9KII+lEUZEfMH6EMR9KEsyohsfgH6UAR9qCR+W4sC6EMR9KGS+IUtCqAPRdCHSuPcVwH0oQj6UBZlbDQa/oB8KEI+lCUZmwQWB9ZHwIdK47fMKgA+FAEfyoKMDbzuGHAPRbiHshxjg26OUQB7KII9lMUYG3TaUgHqoQj1UJZibFC+sQLQQxHooSzF2CLirgD0UAR6KAsxtoiZKMA8FGEeyjKMLXQ6APJQBHkoizC2cNUBxEMR4qEswdhCqwXAQxHgodbxixsVAB6KAA9lAcYWWj3gHYrwDmX5xRZaLcAdiuAOZfHFFlotoB2K0A5l6cUWWi2AHYrADmXhxXb7mMh36YY+O2B3BHYoCy/ECtotgB2KwA61aa44gIYLYIcisENZeCFW0HIB7FAEdigLL8QKmi6AHYrADrVp/F1ouwB2KAI71KaJ9kHjA7RDEdqhGtqxgtYHaIcitENtmkQ/aH6AdihCO9SmuX0P2h+gHYrQDmXphVhhAwS4QxHcoTY9N9UC3KEI7lDNLVYCGjDAHYrgDmXxhRDQgAHuUAR3KIsvhIAGDHCHIrhDbeO0TQHcoQjuUNsm4AIHAMAdiuAOZfGFEHAAANyhCO5QzUEPkUADALxDEd6httErbBXAHYrgDrWNnzJXAHcogjuUxRdCwAEIcIciuEOvGvuD32oAuEMT3KEtvsAejwa4QxPcoVeN/aEBrAHu0AR3aIsvhIADWAPeoQnv0A3vkCtcAbg7mQAPvWpCfgJXAO5PJsRDr5qzRhJXAO5QJshDN6c9JBpDGiAPTZCHtghDSDSGNEAemiAPvWq+Z4EWEQ2QhybIQzcftZApfACAeWjCPHTzYQu5xhWga7uJFTYft5AbXAEwQ0I9dPOBC4nNEGAPTbCHbj5yodA6oAH20AR76OY7FwpbIeAemnAP3XzrQmErBOBDE/ChLcgQ5l5/VAEwQ0I+tGjyTjWuANghQR/aogyhoB0C9KEJ+tDNfVcK2yGAH5rAD21phlBwMgX0QxP6oRv6oeBkCOiHJvRDN/RDYSsE+EMT/KEb/BGxIsA/NOEfuuEfESsCAEQTAKJbAIKNABAQTQiIbghIZDIBCEQTBKIbBKLhSAQIRBMEohsEotGOTAMEogkC0Q0C0WhHpgEC0QSB6AaBaLgaAASiCQLRFmkIDVcDgEA0QSDaIg2h4SgECEQTBKIt0hAa7Wg0QCCaIBBtkYbQcBACBKIJAtEq7VkLAAPRhIFoyzSwT6sBA9GEgWjVGGBEALBAAkG02sadGg0oiKYf0NCr+KZYo29o0I9o6MYGUTRKo89o0O9oWKwhEjgG0Zc06Kc0mruvEjgG0cc0Ol/TsDaYwDEIv6dBbLA5AhJZSdA3NehHNRoQksBBjD6rQb+r0ZwBiawE6Nsa9OMazSGQBM4C6PMa9PsazSGQyIYIfWKDoBDdngLBNghYiCYsRDfHQBL8DgAM0QSG6OYcSAInEgBDNIEhujkHksDVHMAQTWCIbs6BRFwbQEM0oSHa0g2RwFEIaIgmNEQnaY9rBHCIJjhEW7wRfYfACgkP0cmm7x0CMyRARCfbnrkUEBFNiIhOVz3eHUAimiARnYoe7w5AEU2giE6blBg4FwIqogkV0S0VgXMhoCKaUBFtMYdI4VwIsIgmWESnSY9fAMCIJmBEp2k0J0UDMqIJGdHNFzpSOJcCNKIJGtGWdYgUToWAjWjCRnS67fFOAR3RhI5oiztECndUAI9ogkf0ujkQB3dUgI9owkf0urFAOBECQKIJINHNVVgpnAgBINEEkOjmREgK5zFASDQhJHrdpOTDEQQQiSaIRK+brAQ4ggAj0YSR6HVzGwccQQCSuH+zX6b9lJ/rfP9984Xa9+8fsg8n8w8Pj78//Ff73Vqzz7EtmU/Ymq3MN7//8cftS7Xf/P6H97Fa8zfTWvahqs/Zrn49nQ5+ZRuvLnO0aUxdv9nP/Qa1yVttJlWQVduuLj7lRVnn509ZoG17qyxtCpuzt/Z/TCIhq/L9vs6qj0/XL457j3F9q1601epN819zNX/zP0n7F3NlSvM/iWz/Z5M4Ldv2f3TKE/VU52cjK/+c7y5G18vp9NHXpjfeG946TdJpSpymjZMyouHmrZWnfV7l9eU1aNZ74snKNatcs+4lrLau2TWv2eeifH7KzNeSgxegV14vJdP2Xgu/Dq8GprW5r0a/+h+Y9q3CM2EzMjmVfsh2H1/PeWW+Th48T+3V1T7GbfsUhXuvcnU1qPaRG2I8tlnvrQZDKPEG5Frzqs2fTue81z4T77knbqistDMUN1TEyvWM93I/XKovwfNL/ImufX5r14qr3BmoOVnGbSX2uFL/cSWs6nYv+e5jVu7zY1Hvv5TZsdg1te/OeWYeXt5+b957fN6k66YT8zWMtmNuVAvhOradp2SfV/X5souI8Qw+cWN95aw0cVYqnJVueQNtZz86H7xNb6XhVXG4VHV+NkvW6dV++D1cBv1JMuENmbbK7srlLQa8UbI7lbvL+ZyXuy/hpOYvzpL54k5l84LCCdLrn1tqWovYuKGm3GjYutHA3A9Y48yzcm8XgcBazKgIDER5OlzDbjk09wC3BuKG4ZY3DEMFkaY9m3GrnnCrnrlCuG3aLdJbnmHtszoLTcmf9DXPAPb5U3Y51GYrVOfPgRFs1/40wlub9/k5fy5uxnnMqyp7NutTnZehrSbetOgWZeEWZXMxcvtU3DZhyzMJO0ucgo4k3nzoZnXhZnVzhXLbktsZbN32TPMWzrbJonz2W1Xa30W2Fu/evnJvf+vefsobZG1bEUPz3pibf4Wbf81dz21H3cq25a0N+6Lancoy39XBuPYX5ZRpss0I9abE4Il5Q1Tx5ue2wvrlnGd7Wt/aexwbpvXQKSRcWDf+iOAZR364BFVs/Srad6QVs65jUdfhKFL+W2gteeNGk3KjaetG09ptzjRvL5OXZpfZXW6F73eY9Ap+ZWZLVv3zkl9C0/WXCSfbrdbmmvHWdN2uwm1AlduA6hVvws7LT2FH/PV3xTPj/HwmToBK/fWyfcgmPs6u7iUr94fw3Zooqqetfbs64c3s9qWhWhO/1oQp0e6hwzfmO7ZuMnXLp7nYvX1jbuvltrwqYVpL06T1fEPbW638McSbN1snoHwG1Xl7HbXhiivgs5W+M+hcCZ3wFs+nrDjA/vrxCKZ78FQY57B+CeYK3y9otW3ceqjdK9y69XDNbelzvo/M6GtvcJkv7bDri0zonskJpjvxdMieb9N5VpWn2lQdbBBS76257Zhw2zHzjYHmgbhxbU7v85q+VC94uks9m3NbHeG2OiJ1s5x0u4Mtr7PPZpMVhp+8hnjv8zmvj1lRdp0Lf6a87sqcr6WYC/Zz3gbcivLpFDwRz8jdlky4LZlI3Swi24elmGvO86XY54eiDBdyOfahNGO9O+/7BulmPOddKDWm7o/F4dDulgOlnmle923OiVCKt161M5Uxe9SEbyLO8tyOXCnexqlpwo9Snl7zs40coCb9F+BerduaK8Vb4F6yKhYVld5O0o1at/0V7jEKtxkyF8m2EjbOuoTT4h51wnuZRRjkTv35zzXi6r7acsp7xsX+EIuQmWR8b43gmQUdgtrfxLT93jo3wqmWblWTGyc/4TZX5+cyO8TijKnXBbfhE84gxdq1L93wYm7Wrs2SsFzq+WdutyKcMZoPo7TNOQNYMV9Sh034b4a5IywqMwWHL/hWS2u/bl0SzsLF2pmYvJKGq/orcmB2A2AR36FNecPBzGpBHf4WJOWNc1PHh/wl+1SQydePIGgXSNUJz5fyaw2HUuoPA+YmyNQG99rBkBJOIm//cMiq2sxwdXHMqzo7BpRDeLO2m7S1m7Ql78masIw/hVavZzNr1wVZLf2YZ9sHt0UR7h/E2s0L8rpMOaK0uq5XTiAz0Hk4Zfv88+upNP8YxCf9UBdz63HMXoEbk3pG5HYZws3MYu32OfK6Mly7wHvGx+xzcbwcy8vxQ34+PTXDKni8yo+zte1t3OPV7vG6oJRc86Y9027ZUEljP6FV+s47c/Y+Zp/tLhb5J/7EwAy0HLPPVfGvUNbKj2VsmI83z8w6cuwYiO/Wu2ibTnjbaK9SELLf+u7Ymml7txrJZOO/Cu6rzfdFFqwOW3+NYU5ZYFsm/CC5ZnLgth7oDfsUwU0COuU+smjoWHqG4oaqdDEIxQymHYtyaGD64b522G/cFKHdFLF1UwSTdx6Lsmv5/rK44e0R7O+DGJQf13FbWs2MYYf7540/JaU8PacyBGWb4OnxbOlUGlcNmpI/4bs5WDN3IadXMuq8ytwa1S5ajkAJR7rF9rqXcuva+rqX4j0ZsyO00bhw5PuhImb8/FoTmUT8yY5phqYq6gBs/YmcORnFuKbv+ihm+MLUVX95Dc3aD5VopqfkKiKPyR8gzDSC13NxOhd1SEeVL8mFQjRz0/V6Ph2LKj/n1euprPJjFmzr/EHsli3HiITLHhDbqynyLDC6cvvjnJl+04memYPMXi28+cZhQjNrDKJCf0funHbhZjixdgP0msG0GqdhuH3vMTk/VDg/VKzdy1BuBVrx9vfn/Hj6lEdjGF6nXV+dVyqcVyocQpLqChJdeMGxVOXsSDGD/WfjbZzbON2p7Ea9/PCK5j7sS9g775G6JyldJFQp3nxxvpRZ9aXcBRV7xuieknQBRaV5e4/zpezU6w3Mq3udXkkxbyE6X8rOZnwVjPgrEeQ9gSov9/ZlXV5b+61PXc/dXx9cjEC4Toi1C8A5Sq0E7ymZxiPuY33CMWTlLXpXP9EFe5TmLTm23VgDfiaoGxvpFRbylo+mAfAcvVflNgHCdUO4xDfpOKwSPKuo8rpNw4jNBcrbsLhZzrmmwnVTbNwUoK4DyoVUHUlV19RTJpOq8vpGMMA6v/bjUs6inEThQoTyGkZ1UVDFDNOY9ovymWzf/IxE5mRr83NoBuDasxY3jQs3jYuNC6ddwxaCt8RXDnI06WMoucZP0HRzuHBzuHCZUVJdX+A1Ds3uLpKA3qA3mbupQLipQLiMFXldRMQ1AMKcol6yw6FJkwqyKwIN3gt1w0i4YSRcPoN0+QxKMI2H+lnaX7iYeKY6B+uAv63lla+zXWB0ws8H08xEDDvJB4/M84HdwBdu4AuHdaXDusoF0hXT/bYNhin7fqazexUus0S4SLNwxEC66UAxSa1tkSRRBXmIbVccoBYu3Cm2bgVj5uR42xsysfgR5RVbdl1UdbELq/Is7ZpA7BLzlWROvnVWX0i1fryIeXygqvPsUJTPMXYkgvfKNY/TIS+7HoUfllbMHMp2ciJRZz/GM6Ya4qr5cQM3dWmm4+5qPOf1uaAPzY8CMjM2zeOyR2GuO6ZwdvJMxi3lLr1JSZ5p2ybM3hUeFvEhu2bil+jJEz9dTzuoqpnRooAUf/hvklso/H2iZq66ED6f8+pyIHX7g1zwBrlfN4Ykwo8Wask3CGwLnsZrzrpDXMrt+DQzrGaH6VNRFtVLvjcOyOlCouXBEQ++9ui2UPjeq3YToB5hxJWbtU5lDBiL4GQFM1EhqNvaSFilr5uZiGCrbGsMK/Mna8UfGPHx6w+5lPkw8/OxKLOQem18p5Nbkc3JChMctv7SwTx4d8vtQobjY3k9qkZArH1vk+lc0vhj8A7b9cPtN8T1FJ2DG9L5DIqZrn4pz/lT8ET9BZSZFH6pi0Pxr6xjLv4mRG15xvwpP1edevy4MDNp/LesqDuxDn9aUy6wrplBmd/y4vmFRL79s36aGYQBQQOy1Xh8cLF+sXLeiEt0kw4+SOekqS1v/AB/jK4hvjetmbFdXO3uVNb552CWD5h5u79wVFlc4YbrsFzzxt6Qoyv8SJ92+xrNtGymDyv8qJ92C6ZmZpw2jXTDnP75QM2cPgZjyWtvgXHhEeHCI2JzTeVwUVzmBuW2t/+YfyEbE39GdW6gZrogEZ8hcKTbXjgQKpybI10WnXRxBcXMnG1Dz+hF+wNeXCHnmIfUJUz+NoIJ9G9VkRHsO6ycQ1O/Pj68Fq82RfXhm/e//vHH/wcHrTeT"; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css index 44328e99a..ec257d517 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -504,8 +504,15 @@ body { background: var(--color-background); font-family: - -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", - Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + -apple-system, + BlinkMacSystemFont, + "Segoe UI", + "Noto Sans", + Helvetica, + Arial, + sans-serif, + "Apple Color Emoji", + "Segoe UI Emoji"; font-size: 16px; color: var(--color-text); margin: 0; @@ -531,6 +538,14 @@ scroll-margin-block: calc(var(--dim-header-height) + 0.5rem); } + math[display="block"] { + position: relative; + padding: 10px; + border: 1px solid var(--color-accent); + border-radius: 0.8em; + margin-bottom: 8px; + } + code, pre { font-family: Menlo, Monaco, Consolas, "Courier New", monospace; @@ -1047,7 +1062,7 @@ cursor: pointer; } - .tsd-accordion-summary a { + .tsd-accordion-summary > a { width: calc(100% - 1.5rem); } .tsd-accordion-summary > * { diff --git a/docs/classes/src.ClusterWorker.html b/docs/classes/src.ClusterWorker.html index 3f37cb46d..acbddbf90 100644 --- a/docs/classes/src.ClusterWorker.html +++ b/docs/classes/src.ClusterWorker.html @@ -1,22 +1,73 @@ -ClusterWorker | poolifier - v5.3.2
poolifier - v5.3.2
    Preparing search index...

    Class ClusterWorker<Data, Response>

    A cluster worker used by a poolifier ClusterPool.

    +ClusterWorker | poolifier - v5.4.0
    +
    poolifier - v5.4.0 + +
      +
      +
      Preparing search index...
      +
      +
      +
      + +

      Class ClusterWorker<Data, Response>

      +
      +

      A cluster worker used by a poolifier ClusterPool.

      When this worker is inactive for more than the given maxInactiveTime, it will send a termination request to its main worker.

      If you use a DynamicClusterPool the extra workers that were created will be terminated, but the minimum number of workers will be guaranteed.

      -

      Christopher Quadflieg

      -

      2.0.0

      -

      Type Parameters

      • Data = unknown

        Type of data this worker receives from pool's execution. This can only be structured-cloneable data.

        -
      • Response = unknown

        Type of response the worker sends back to the main worker. This can only be structured-cloneable data.

        -

      Hierarchy (View Summary)

      Index

      Constructors

      constructor -

      Properties

      activeInterval? +
      +
      +
      +

      Christopher Quadflieg

      +
      +
      +

      2.0.0

      +
      +
      +

      Type Parameters

      +
        +
      • Data = unknown +

        Type of data this worker receives from pool's execution. This can only be structured-cloneable data.

        +
        • +
      • Response = unknown +

        Type of response the worker sends back to the main worker. This can only be structured-cloneable data.

        +
      +
      +

      Hierarchy (View Summary)

      +
      +
      +
      +
      +
      Index
       +
      +
      + +
      constructor +
      +
      + +
      activeInterval? isMain lastTaskTimestamp opts statistics? taskAbortFunctions taskFunctions -

      Accessors

      id -

      Methods

      addTaskFunction +
      +
      + +
      id +
      +
      + +
      addTaskFunction getMainWorker handleError handleKillMessage @@ -32,56 +83,430 @@ but the minimum number of workers will be guaranteed.

      sendTaskFunctionsPropertiesToMainWorker sendToMainWorker setDefaultTaskFunction -

      Constructors

      Properties

      activeInterval?: Timeout

      Handler id of the activeInterval worker activity check.

      -
      isMain: boolean | undefined

      Whether this is the main worker or not.

      -
      lastTaskTimestamp: number

      Timestamp of the last task processed by this worker.

      -
      opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

      Options for the worker.

      -
      statistics?: WorkerStatistics

      Performance statistics computation requirements.

      -
      taskAbortFunctions: Map<
          `${string}-${string}-${string}-${string}-${string}`,
          () => void,
      >

      Task abort functions processed by the worker when task operation 'abort' is received.

      -
      taskFunctions: Map<string, TaskFunctionObject<Data, Response>>

      Task function object(s) processed by the worker when the pool's execute method is invoked.

      -

      Accessors

      Methods

      +
      + +
      +
      + +
      +
      + +
      +
      + +
      activeInterval?: Timeout
      +

      Handler id of the activeInterval worker activity check.

      +
      +
      + +
      isMain: boolean | undefined
      +

      Whether this is the main worker or not.

      +
      +
      + +
      lastTaskTimestamp: number
      +

      Timestamp of the last task processed by this worker.

      +
      +
      + +
      opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
      +

      Options for the worker.

      +
      +
      + +
      statistics?: WorkerStatistics
      +

      Performance statistics computation requirements.

      +
      +
      + +
      taskAbortFunctions: Map<
          `${string}-${string}-${string}-${string}-${string}`,
          () => void,
      >
      +

      Task abort functions processed by the worker when task operation 'abort' is received.

      +
      +
      + +
      taskFunctions: Map<string, TaskFunctionObject<Data, Response>>
      +

      Task function object(s) processed by the worker when the pool's execute method is invoked.

      +
      +
      + +
      +
      + +
      +
      + +
      +
      + +

      • Handles a worker error.

        -

        Parameters

        • error: Error

          The error raised by the worker.

          -

        Returns { aborted: boolean; message: string; stack?: string }

        The worker error object.

        -

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      Accessors
      Methods
      +
      +
      +

      Parameters

      +
      +

      Returns TaskFunctionOperationResult

      Whether the task function was added or not.

      +
      +
      + +
      +
      + +
        +
      • + +
        +

        Handles a worker error.

        +
        +
        +

        Parameters

        +
          +
        • error: Error +

          The error raised by the worker.

          +
        +

        Returns { aborted: boolean; message: string; stack?: string }

        The worker error object.

        +
      +
      + +
      +
      + +
      +
      + +
      +
      + +
      +
      + +
      +
      + +
      +
      + +
      +
      + +
      +
      + +
      +
      + +
      +
      + +
      +
      + +
      +
      + +
      +
      +
      +
      +
      +

      Settings

       +
      +
      Member Visibility +
        +
        • +
        • +
      +
      +
      +

      On This Page

       +
      +
      Constructors +
      +
      Properties +
      +
      Accessors +
      +
      Methods +
      +
      +
      +
      diff --git a/docs/classes/src.DynamicClusterPool.html b/docs/classes/src.DynamicClusterPool.html index b99eb9f77..2433edc41 100644 --- a/docs/classes/src.DynamicClusterPool.html +++ b/docs/classes/src.DynamicClusterPool.html @@ -1,12 +1,57 @@ -DynamicClusterPool | poolifier - v5.3.2
      poolifier - v5.3.2
        Preparing search index...

        Class DynamicClusterPool<Data, Response>

        A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.

        +DynamicClusterPool | poolifier - v5.4.0
        +
        poolifier - v5.4.0 + +
          +
          +
          Preparing search index...
          +
          +
          +
          + +

          Class DynamicClusterPool<Data, Response>

          +
          +

          A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.

          This cluster pool creates new workers when the others are busy, up to the maximum number of workers. When the maximum number of workers is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's emitter.

          -

          Christopher Quadflieg

          -

          2.0.0

          -

          Type Parameters

          • Data = unknown

            Type of data sent to the worker. This can only be structured-cloneable data.

            -
          • Response = unknown

            Type of execution response. This can only be structured-cloneable data.

            -

          Hierarchy (View Summary)

          Index

          Constructors

          constructor -

          Properties

          destroying +
          +
          +
          +

          Christopher Quadflieg

          +
          +
          +

          2.0.0

          +
          +
          +

          Type Parameters

          +
            +
          • Data = unknown +

            Type of data sent to the worker. This can only be structured-cloneable data.

            +
            • +
          • Response = unknown +

            Type of execution response. This can only be structured-cloneable data.

            +
          +
          +

          Hierarchy (View Summary)

          +
          +
          +
          +
          +
          Index
           +
          +
          + +
          constructor +
          +
          + +
          destroying emitter? filePath maximumNumberOfWorkers? @@ -17,12 +62,18 @@ When the maximum number of workers is reached and workers are busy, an event is starting workerChoiceStrategiesContext? workerNodes -

          Accessors

          backPressure +
          +
          + +
          backPressure busy info type worker -

          Methods

          addTaskFunction +
          +
          + +
          addTaskFunction afterTaskExecutionHook afterWorkerNodeSetup beforeTaskExecutionHook @@ -57,80 +108,833 @@ When the maximum number of workers is reached and workers are busy, an event is shallCreateDynamicWorker start workerMessageListener -

          Constructors

          • Constructs a new poolifier dynamic cluster pool.

            -

            Type Parameters

            • Data = unknown

              Type of data sent to the worker. This can only be structured-cloneable data.

              -
            • Response = unknown

              Type of execution response. This can only be structured-cloneable data.

              -

            Parameters

            • min: number

              Minimum number of workers which are always active.

              -
            • max: number

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

              -
            • filePath: string

              Path to an implementation of a ClusterWorker file, which can be relative or absolute.

              -
            • opts: ClusterPoolOptions = {}

              Options for this dynamic cluster pool.

              -

            Returns DynamicClusterPool<Data, Response>

          Properties

          destroying: boolean

          Whether the pool is destroying or not.

          -
          emitter?: EventEmitterAsyncResource
          filePath: string

          Path to the worker file.

          -
          maximumNumberOfWorkers?: number

          Maximum number of workers that this pool manages.

          -
          minimumNumberOfWorkers: number

          Minimum number of workers that this pool manages.

          -
          opts: PoolOptions<Worker>

          Options for the pool.

          -
          promiseResponseMap: Map<
              `${string}-${string}-${string}-${string}-${string}`,
              PromiseResponseWrapper<Response>,
          > = ...

          The task execution response promise map:

          +
          +
          + +
          +
          + +
            +
          • + +
            +

            Constructs a new poolifier dynamic cluster pool.

            +
            +
            +

            Type Parameters

            +
              +
            • Data = unknown +

              Type of data sent to the worker. This can only be structured-cloneable data.

              +
              • +
            • Response = unknown +

              Type of execution response. This can only be structured-cloneable data.

              +
            +
            +

            Parameters

            +
              +
            • min: number +

              Minimum number of workers which are always active.

              +
              • +
            • max: number +

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

              +
              • +
            • filePath: string +

              Path to an implementation of a ClusterWorker file, which can be relative or absolute.

              +
              • +
            • opts: ClusterPoolOptions = {} +

              Options for this dynamic cluster pool.

              +
            +

            Returns DynamicClusterPool<Data, Response>

          +
          + +
          +
          + +
          destroying: boolean
          +

          Whether the pool is destroying or not.

          +
          +
          + +
          emitter?: EventEmitterAsyncResource
          +
          +
          +
          +
          + +
          filePath: string
          +

          Path to the worker file.

          +
          +
          + +
          maximumNumberOfWorkers?: number
          +

          Maximum number of workers that this pool manages.

          +
          +
          + +
          minimumNumberOfWorkers: number
          +

          Minimum number of workers that this pool manages.

          +
          +
          + +
          opts: PoolOptions<Worker>
          +

          Options for the pool.

          +
          +
          + +
          promiseResponseMap: Map<
              `${string}-${string}-${string}-${string}-${string}`,
              PromiseResponseWrapper<Response>,
          > = ...
          +

          The task execution response promise map:

          • key: The message id of each submitted task.
          • value: An object that contains task's worker node key, execution response promise resolve and reject callbacks, async resource.

          When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.

          -
          started: boolean

          Whether the pool is started or not.

          -
          starting: boolean

          Whether the pool is starting or not.

          -
          workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<
              Worker,
              Data,
              Response,
          >

          Worker choice strategies context referencing worker choice algorithms implementation.

          -
          workerNodes: IWorkerNode<Worker, Data>[] = []

          Accessors

          • get backPressure(): boolean

            Whether the pool is back pressured or not.

            -

            Returns boolean

            The pool back pressure boolean status.

            -
          • get busy(): boolean

            Whether the pool is busy or not.

            -

            Returns boolean

            The pool busyness boolean status.

            -
          +
          + +
          started: boolean
          +

          Whether the pool is started or not.

          +
          +
          + +
          starting: boolean
          +

          Whether the pool is starting or not.

          +
          +
          + +
          workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<
              Worker,
              Data,
              Response,
          >
          +

          Worker choice strategies context referencing worker choice algorithms implementation.

          +
          +
          + +
          workerNodes: IWorkerNode<Worker, Data>[] = []
          +
          +
          +
          +
          + +
          +
          + +
            +
          • +
            get backPressure(): boolean
            +
            +

            Whether the pool is back pressured or not.

            +
            +

            Returns boolean

            The pool back pressure boolean status.

            +
          +
          + +
            +
          • +
            get busy(): boolean
            +
            +

            Whether the pool is busy or not.

            +
            +

            Returns boolean

            The pool busyness boolean status.

            +
          +
          + +
          +
          + +
            +
          • +
            get type(): "fixed" | "dynamic"
            +
            +

            The pool type.

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

            -

            Returns "fixed" | "dynamic"

          • get worker(): "cluster" | "thread"

            The worker type.

            -

            Returns "cluster" | "thread"

          Methods

          • Hook executed after the worker task execution. +

            +

            Returns "fixed" | "dynamic"

          +
          + +
            +
          • +
            get worker(): "cluster" | "thread"
            +
            +

            The worker type.

            +
            +

            Returns "cluster" | "thread"

          +
          + +
          +
          + +
          +
          + +
          +
          + +
          +
          + +

          • Parameters

            • Optionaldata: Data
            • Optionalname: string
            • OptionalabortSignal: AbortSignal
            • OptionaltransferList: readonly Transferable[]

            Returns Promise<Response>

          • Parameters

            • data: Iterable<Data>
            • Optionalname: string
            • OptionalabortSignals: Iterable<AbortSignal, any, any>
            • OptionaltransferList: readonly Transferable[]

            Returns Promise<Response[]>

          +
          + +
          +
          + +
          +
          + +
          +
          + +
          +
          + +
            +
          • + +
            +

            Deregisters a listener callback on the worker given its worker node key.

            +
            +
            +

            Type Parameters

            +
              +
            • Message
            +
            +

            Parameters

            +
              +
            • workerNodeKey: number +

              The worker node key.

              +
              • +
            • listener: (message: MessageValue<Message>) => void +

              The message listener callback.

              +
            +

            Returns void

          +
          + +
          +
          + +
          +
          + +
          +
          + +
            +
          • + +
            +
            +

            Parameters

            +
              +
            • Optionaldata: Data
              • +
            • Optionalname: string
              • +
            • OptionalabortSignal: AbortSignal
              • +
            • OptionaltransferList: readonly Transferable[]
            +

            Returns Promise<Response>

            +
            +
            +
          +
          + +
          +
          + +
          +
          + +
            +
          • + +
            +

            Gets the worker information given its worker node key.

            +
            +
            +

            Parameters

            +
              +
            • workerNodeKey: number +

              The worker node key.

              +
            +

            Returns WorkerInfo | undefined

            The worker information.

            +
          +
          + +
          +
          + +
          +
          + +
          +
          + +
          +
          + +
          +
          + +
            +
          • + +
            +
            +

            Parameters

            +
              +
            • data: Iterable<Data>
              • +
            • Optionalname: string
              • +
            • OptionalabortSignals: Iterable<AbortSignal, any, any>
              • +
            • OptionaltransferList: readonly Transferable[]
            +

            Returns Promise<Response[]>

            +
            +
            +
          +
          + +
            +
          • + +
            +

            Registers once a listener callback on the worker given its worker node key.

            +
            +
            +

            Type Parameters

            +
              +
            • Message
            +
            +

            Parameters

            +
              +
            • workerNodeKey: number +

              The worker node key.

              +
              • +
            • listener: (message: MessageValue<Message>) => void +

              The message listener callback.

              +
            +

            Returns void

          +
          + +
            +
          • + +
            +

            Registers a listener callback on the worker given its worker node key.

            +
            +
            +

            Type Parameters

            +
              +
            • Message
            +
            +

            Parameters

            +
              +
            • workerNodeKey: number +

              The worker node key.

              +
              • +
            • listener: (message: MessageValue<Message>) => void +

              The message listener callback.

              +
            +

            Returns void

          +
          + +
          +
          + +
          +
          + +
            +
          • + +
            +

            Sends a message to worker given its worker node key.

            +
            +
            +

            Parameters

            +
              +
            • workerNodeKey: number +

              The worker node key.

              +
              • +
            • message: MessageValue<Data> +

              The message.

              +
            +

            Returns void

          +
          + +
          +
          + +
          +
          + +

          • Parameters

            • workerChoiceStrategy:
                  | "FAIR_SHARE"
                  | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                  | "LEAST_BUSY"
                  | "LEAST_ELU"
                  | "LEAST_USED"
                  | "ROUND_ROBIN"
                  | "WEIGHTED_ROUND_ROBIN"
            • OptionalworkerChoiceStrategyOptions: WorkerChoiceStrategyOptions

            Returns void

          Settings

          Member Visibility

          On This Page

          Constructors
          Properties
          Accessors
          Methods
          +
          +

          Returns void

          +
          + +
            +
          • + +
            +
            +

            Parameters

            +
              +
            • workerChoiceStrategy:
                  | "FAIR_SHARE"
                  | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                  | "LEAST_BUSY"
                  | "LEAST_ELU"
                  | "LEAST_USED"
                  | "ROUND_ROBIN"
                  | "WEIGHTED_ROUND_ROBIN"
              • +
            • OptionalworkerChoiceStrategyOptions: WorkerChoiceStrategyOptions
            +

            Returns void

            +
            +
            +
          +
          + +
          +
          + +
          +
          + +
          +
          + +
          +
          +
          +
          +
          +

          Settings

           +
          +
          Member Visibility +
            +
            • +
            • +
          +
          +
          +

          On This Page

           +
          +
          Constructors +
          +
          Properties +
          +
          Accessors +
          +
          Methods +
          +
          +
          +
          diff --git a/docs/classes/src.DynamicThreadPool.html b/docs/classes/src.DynamicThreadPool.html index f29f0126d..8b669cbed 100644 --- a/docs/classes/src.DynamicThreadPool.html +++ b/docs/classes/src.DynamicThreadPool.html @@ -1,12 +1,57 @@ -DynamicThreadPool | poolifier - v5.3.2
          poolifier - v5.3.2
            Preparing search index...

            Class DynamicThreadPool<Data, Response>

            A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.

            +DynamicThreadPool | poolifier - v5.4.0
            +
            poolifier - v5.4.0 + +
              +
              +
              Preparing search index...
              +
              +
              +
              + +

              Class DynamicThreadPool<Data, Response>

              +
              +

              A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.

              This thread pool creates new threads when the others are busy, up to the maximum number of threads. When the maximum number of threads is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's emitter.

              -

              Alessandro Pio Ardizio

              -

              0.0.1

              -

              Type Parameters

              • Data = unknown

                Type of data sent to the worker. This can only be structured-cloneable data.

                -
              • Response = unknown

                Type of execution response. This can only be structured-cloneable data.

                -

              Hierarchy (View Summary)

              Index

              Constructors

              constructor -

              Properties

              destroying +
              +
              +
              +

              Alessandro Pio Ardizio

              +
              +
              +

              0.0.1

              +
              +
              +

              Type Parameters

              +
                +
              • Data = unknown +

                Type of data sent to the worker. This can only be structured-cloneable data.

                +
                • +
              • Response = unknown +

                Type of execution response. This can only be structured-cloneable data.

                +
              +
              +

              Hierarchy (View Summary)

              +
              +
              +
              +
              +
              Index
               +
              +
              + +
              constructor +
              +
              + +
              destroying emitter? filePath maximumNumberOfWorkers? @@ -17,12 +62,18 @@ When the maximum number of threads is reached and workers are busy, an event is starting workerChoiceStrategiesContext? workerNodes -

              Accessors

              backPressure +
              +
              + +
              backPressure busy info type worker -

              Methods

              addTaskFunction +
              +
              + +
              addTaskFunction afterTaskExecutionHook afterWorkerNodeSetup beforeTaskExecutionHook @@ -57,81 +108,836 @@ When the maximum number of threads is reached and workers are busy, an event is shallCreateDynamicWorker start workerMessageListener -

              Constructors

              • Constructs a new poolifier dynamic thread pool.

                -

                Type Parameters

                • Data = unknown

                  Type of data sent to the worker. This can only be structured-cloneable data.

                  -
                • Response = unknown

                  Type of execution response. This can only be structured-cloneable data.

                  -

                Parameters

                • min: number

                  Minimum number of threads which are always active.

                  -
                • max: number

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

                  -
                • filePath: string

                  Path to an implementation of a ThreadWorker file, which can be relative or absolute.

                  -
                • opts: ThreadPoolOptions = {}

                  Options for this dynamic thread pool.

                  -

                Returns DynamicThreadPool<Data, Response>

              Properties

              destroying: boolean

              Whether the pool is destroying or not.

              -
              emitter?: EventEmitterAsyncResource
              filePath: string

              Path to the worker file.

              -
              maximumNumberOfWorkers?: number

              Maximum number of workers that this pool manages.

              -
              minimumNumberOfWorkers: number

              Minimum number of workers that this pool manages.

              -
              opts: PoolOptions<Worker>

              Options for the pool.

              -
              promiseResponseMap: Map<
                  `${string}-${string}-${string}-${string}-${string}`,
                  PromiseResponseWrapper<Response>,
              > = ...

              The task execution response promise map:

              +
              +
              + +
              +
              + +
                +
              • + +
                +

                Constructs a new poolifier dynamic thread pool.

                +
                +
                +

                Type Parameters

                +
                  +
                • Data = unknown +

                  Type of data sent to the worker. This can only be structured-cloneable data.

                  +
                  • +
                • Response = unknown +

                  Type of execution response. This can only be structured-cloneable data.

                  +
                +
                +

                Parameters

                +
                  +
                • min: number +

                  Minimum number of threads which are always active.

                  +
                  • +
                • max: number +

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

                  +
                  • +
                • filePath: string +

                  Path to an implementation of a ThreadWorker file, which can be relative or absolute.

                  +
                  • +
                • opts: ThreadPoolOptions = {} +

                  Options for this dynamic thread pool.

                  +
                +

                Returns DynamicThreadPool<Data, Response>

              +
              + +
              +
              + +
              destroying: boolean
              +

              Whether the pool is destroying or not.

              +
              +
              + +
              emitter?: EventEmitterAsyncResource
              +
              +
              +
              +
              + +
              filePath: string
              +

              Path to the worker file.

              +
              +
              + +
              maximumNumberOfWorkers?: number
              +

              Maximum number of workers that this pool manages.

              +
              +
              + +
              minimumNumberOfWorkers: number
              +

              Minimum number of workers that this pool manages.

              +
              +
              + +
              opts: PoolOptions<Worker>
              +

              Options for the pool.

              +
              +
              + +
              promiseResponseMap: Map<
                  `${string}-${string}-${string}-${string}-${string}`,
                  PromiseResponseWrapper<Response>,
              > = ...
              +

              The task execution response promise map:

              • key: The message id of each submitted task.
              • value: An object that contains task's worker node key, execution response promise resolve and reject callbacks, async resource.

              When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.

              -
              started: boolean

              Whether the pool is started or not.

              -
              starting: boolean

              Whether the pool is starting or not.

              -
              workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<
                  Worker,
                  Data,
                  Response,
              >

              Worker choice strategies context referencing worker choice algorithms implementation.

              -
              workerNodes: IWorkerNode<Worker, Data>[] = []

              Accessors

              • get backPressure(): boolean

                Whether the pool is back pressured or not.

                -

                Returns boolean

                The pool back pressure boolean status.

                -
              • get busy(): boolean

                Whether the pool is busy or not.

                -

                Returns boolean

                The pool busyness boolean status.

                -
              +
              + +
              started: boolean
              +

              Whether the pool is started or not.

              +
              +
              + +
              starting: boolean
              +

              Whether the pool is starting or not.

              +
              +
              + +
              workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<
                  Worker,
                  Data,
                  Response,
              >
              +

              Worker choice strategies context referencing worker choice algorithms implementation.

              +
              +
              + +
              workerNodes: IWorkerNode<Worker, Data>[] = []
              +
              +
              +
              +
              + +
              +
              + +
                +
              • +
                get backPressure(): boolean
                +
                +

                Whether the pool is back pressured or not.

                +
                +

                Returns boolean

                The pool back pressure boolean status.

                +
              +
              + +
                +
              • +
                get busy(): boolean
                +
                +

                Whether the pool is busy or not.

                +
                +

                Returns boolean

                The pool busyness boolean status.

                +
              +
              + +
              +
              + +
                +
              • +
                get type(): "fixed" | "dynamic"
                +
                +

                The pool type.

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

                -

                Returns "fixed" | "dynamic"

              • get worker(): "cluster" | "thread"

                The worker type.

                -

                Returns "cluster" | "thread"

              Methods

              • Hook executed after the worker task execution. +

                +

                Returns "fixed" | "dynamic"

              +
              + +
                +
              • +
                get worker(): "cluster" | "thread"
                +
                +

                The worker type.

                +
                +

                Returns "cluster" | "thread"

              +
              + +
              +
              + +
              +
              + +
              +
              + +
              +
              + +

              • Parameters

                • Optionaldata: Data
                • Optionalname: string
                • OptionalabortSignal: AbortSignal
                • OptionaltransferList: readonly Transferable[]

                Returns Promise<Response>

              • Parameters

                • data: Iterable<Data>
                • Optionalname: string
                • OptionalabortSignals: Iterable<AbortSignal, any, any>
                • OptionaltransferList: readonly Transferable[]

                Returns Promise<Response[]>

              • Sends a message to worker given its worker node key.

                -

                Parameters

                • workerNodeKey: number

                  The worker node key.

                  -
                • message: MessageValue<Data>

                  The message.

                  -
                • OptionaltransferList: readonly Transferable[]

                  The optional array of transferable objects.

                  -

                Returns void

              +
              + +
              +
              + +
              +
              + +
              +
              + +
              +
              + +
                +
              • + +
                +

                Deregisters a listener callback on the worker given its worker node key.

                +
                +
                +

                Type Parameters

                +
                  +
                • Message
                +
                +

                Parameters

                +
                  +
                • workerNodeKey: number +

                  The worker node key.

                  +
                  • +
                • listener: (message: MessageValue<Message>) => void +

                  The message listener callback.

                  +
                +

                Returns void

              +
              + +
              +
              + +
              +
              + +
              +
              + +
                +
              • + +
                +
                +

                Parameters

                +
                  +
                • Optionaldata: Data
                  • +
                • Optionalname: string
                  • +
                • OptionalabortSignal: AbortSignal
                  • +
                • OptionaltransferList: readonly Transferable[]
                +

                Returns Promise<Response>

                +
                +
                +
              +
              + +
              +
              + +
              +
              + +
                +
              • + +
                +

                Gets the worker information given its worker node key.

                +
                +
                +

                Parameters

                +
                  +
                • workerNodeKey: number +

                  The worker node key.

                  +
                +

                Returns WorkerInfo | undefined

                The worker information.

                +
              +
              + +
              +
              + +
              +
              + +
              +
              + +
              +
              + +
              +
              + +
                +
              • + +
                +
                +

                Parameters

                +
                  +
                • data: Iterable<Data>
                  • +
                • Optionalname: string
                  • +
                • OptionalabortSignals: Iterable<AbortSignal, any, any>
                  • +
                • OptionaltransferList: readonly Transferable[]
                +

                Returns Promise<Response[]>

                +
                +
                +
              +
              + +
                +
              • + +
                +

                Registers once a listener callback on the worker given its worker node key.

                +
                +
                +

                Type Parameters

                +
                  +
                • Message
                +
                +

                Parameters

                +
                  +
                • workerNodeKey: number +

                  The worker node key.

                  +
                  • +
                • listener: (message: MessageValue<Message>) => void +

                  The message listener callback.

                  +
                +

                Returns void

              +
              + +
                +
              • + +
                +

                Registers a listener callback on the worker given its worker node key.

                +
                +
                +

                Type Parameters

                +
                  +
                • Message
                +
                +

                Parameters

                +
                  +
                • workerNodeKey: number +

                  The worker node key.

                  +
                  • +
                • listener: (message: MessageValue<Message>) => void +

                  The message listener callback.

                  +
                +

                Returns void

              +
              + +
              +
              + +
              +
              + +
                +
              • + +
                +

                Sends a message to worker given its worker node key.

                +
                +
                +

                Parameters

                +
                  +
                • workerNodeKey: number +

                  The worker node key.

                  +
                  • +
                • message: MessageValue<Data> +

                  The message.

                  +
                  • +
                • OptionaltransferList: readonly Transferable[] +

                  The optional array of transferable objects.

                  +
                +

                Returns void

              +
              + +
              +
              + +
              +
              + +

              • Parameters

                • workerChoiceStrategy:
                      | "FAIR_SHARE"
                      | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                      | "LEAST_BUSY"
                      | "LEAST_ELU"
                      | "LEAST_USED"
                      | "ROUND_ROBIN"
                      | "WEIGHTED_ROUND_ROBIN"
                • OptionalworkerChoiceStrategyOptions: WorkerChoiceStrategyOptions

                Returns void

              Settings

              Member Visibility

              On This Page

              Constructors
              Properties
              Accessors
              Methods
              +
              +

              Returns void

              +
              + +
                +
              • + +
                +
                +

                Parameters

                +
                  +
                • workerChoiceStrategy:
                      | "FAIR_SHARE"
                      | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                      | "LEAST_BUSY"
                      | "LEAST_ELU"
                      | "LEAST_USED"
                      | "ROUND_ROBIN"
                      | "WEIGHTED_ROUND_ROBIN"
                  • +
                • OptionalworkerChoiceStrategyOptions: WorkerChoiceStrategyOptions
                +

                Returns void

                +
                +
                +
              +
              + +
              +
              + +
              +
              + +
              +
              + +
              +
              +
              +
              +
              +

              Settings

               +
              +
              Member Visibility +
                +
                • +
                • +
              +
              +
              +

              On This Page

               +
              +
              Constructors +
              +
              Properties +
              +
              Accessors +
              +
              Methods +
              +
              +
              +
              diff --git a/docs/classes/src.FixedClusterPool.html b/docs/classes/src.FixedClusterPool.html index ad8a17687..23d2634bb 100644 --- a/docs/classes/src.FixedClusterPool.html +++ b/docs/classes/src.FixedClusterPool.html @@ -1,10 +1,57 @@ -FixedClusterPool | poolifier - v5.3.2
              poolifier - v5.3.2
                Preparing search index...

                Class FixedClusterPool<Data, Response>

                A cluster pool with a fixed number of workers.

                -

                Christopher Quadflieg

                -

                2.0.0

                -

                Type Parameters

                • Data = unknown

                  Type of data sent to the worker. This can only be structured-cloneable data.

                  -
                • Response = unknown

                  Type of execution response. This can only be structured-cloneable data.

                  -

                Hierarchy (View Summary)

                Index

                Constructors

                constructor -

                Properties

                destroying +FixedClusterPool | poolifier - v5.4.0
                +
                poolifier - v5.4.0 + +
                  +
                  +
                  Preparing search index...
                  +
                  +
                  +
                  + +

                  Class FixedClusterPool<Data, Response>

                  +
                  +

                  A cluster pool with a fixed number of workers.

                  +
                  +
                  +
                  +

                  Christopher Quadflieg

                  +
                  +
                  +

                  2.0.0

                  +
                  +
                  +

                  Type Parameters

                  +
                    +
                  • Data = unknown +

                    Type of data sent to the worker. This can only be structured-cloneable data.

                    +
                    • +
                  • Response = unknown +

                    Type of execution response. This can only be structured-cloneable data.

                    +
                  +
                  +

                  Hierarchy (View Summary)

                  +
                  +
                  +
                  +
                  +
                  Index
                   +
                  +
                  + +
                  constructor +
                  +
                  + +
                  destroying emitter? filePath maximumNumberOfWorkers? @@ -15,12 +62,18 @@ starting workerChoiceStrategiesContext? workerNodes -

                  Accessors

                  backPressure +
                  +
                  + +
                  backPressure busy info type worker -

                  Methods

                  addTaskFunction +
                  +
                  + +
                  addTaskFunction afterTaskExecutionHook afterWorkerNodeSetup beforeTaskExecutionHook @@ -55,80 +108,833 @@ shallCreateDynamicWorker start workerMessageListener -

                  Constructors

                  • Constructs a new poolifier fixed cluster pool.

                    -

                    Type Parameters

                    • Data = unknown

                      Type of data sent to the worker. This can only be structured-cloneable data.

                      -
                    • Response = unknown

                      Type of execution response. This can only be structured-cloneable data.

                      -

                    Parameters

                    • numberOfWorkers: number

                      Number of workers for this pool.

                      -
                    • filePath: string

                      Path to an implementation of a ClusterWorker file, which can be relative or absolute.

                      -
                    • opts: ClusterPoolOptions = {}

                      Options for this fixed cluster pool.

                      -
                    • OptionalmaximumNumberOfWorkers: number

                      The maximum number of workers for this pool.

                      -

                    Returns FixedClusterPool<Data, Response>

                  Properties

                  destroying: boolean

                  Whether the pool is destroying or not.

                  -
                  emitter?: EventEmitterAsyncResource
                  filePath: string

                  Path to the worker file.

                  -
                  maximumNumberOfWorkers?: number

                  Maximum number of workers that this pool manages.

                  -
                  minimumNumberOfWorkers: number

                  Minimum number of workers that this pool manages.

                  -
                  opts: PoolOptions<Worker>

                  Options for the pool.

                  -
                  promiseResponseMap: Map<
                      `${string}-${string}-${string}-${string}-${string}`,
                      PromiseResponseWrapper<Response>,
                  > = ...

                  The task execution response promise map:

                  +
                  +
                  + +
                  +
                  + +
                    +
                  • + +
                    +

                    Constructs a new poolifier fixed cluster pool.

                    +
                    +
                    +

                    Type Parameters

                    +
                      +
                    • Data = unknown +

                      Type of data sent to the worker. This can only be structured-cloneable data.

                      +
                      • +
                    • Response = unknown +

                      Type of execution response. This can only be structured-cloneable data.

                      +
                    +
                    +

                    Parameters

                    +
                      +
                    • numberOfWorkers: number +

                      Number of workers for this pool.

                      +
                      • +
                    • filePath: string +

                      Path to an implementation of a ClusterWorker file, which can be relative or absolute.

                      +
                      • +
                    • opts: ClusterPoolOptions = {} +

                      Options for this fixed cluster pool.

                      +
                      • +
                    • OptionalmaximumNumberOfWorkers: number +

                      The maximum number of workers for this pool.

                      +
                    +

                    Returns FixedClusterPool<Data, Response>

                  +
                  + +
                  +
                  + +
                  destroying: boolean
                  +

                  Whether the pool is destroying or not.

                  +
                  +
                  + +
                  emitter?: EventEmitterAsyncResource
                  +
                  +
                  +
                  +
                  + +
                  filePath: string
                  +

                  Path to the worker file.

                  +
                  +
                  + +
                  maximumNumberOfWorkers?: number
                  +

                  Maximum number of workers that this pool manages.

                  +
                  +
                  + +
                  minimumNumberOfWorkers: number
                  +

                  Minimum number of workers that this pool manages.

                  +
                  +
                  + +
                  opts: PoolOptions<Worker>
                  +

                  Options for the pool.

                  +
                  +
                  + +
                  promiseResponseMap: Map<
                      `${string}-${string}-${string}-${string}-${string}`,
                      PromiseResponseWrapper<Response>,
                  > = ...
                  +

                  The task execution response promise map:

                  • key: The message id of each submitted task.
                  • value: An object that contains task's worker node key, execution response promise resolve and reject callbacks, async resource.

                  When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.

                  -
                  started: boolean

                  Whether the pool is started or not.

                  -
                  starting: boolean

                  Whether the pool is starting or not.

                  -
                  workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<
                      Worker,
                      Data,
                      Response,
                  >

                  Worker choice strategies context referencing worker choice algorithms implementation.

                  -
                  workerNodes: IWorkerNode<Worker, Data>[] = []

                  Accessors

                  • get backPressure(): boolean

                    Whether the pool is back pressured or not.

                    -

                    Returns boolean

                    The pool back pressure boolean status.

                    -
                  • get busy(): boolean

                    Whether the pool is busy or not.

                    -

                    Returns boolean

                    The pool busyness boolean status.

                    -
                  +
                  + +
                  started: boolean
                  +

                  Whether the pool is started or not.

                  +
                  +
                  + +
                  starting: boolean
                  +

                  Whether the pool is starting or not.

                  +
                  +
                  + +
                  workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<
                      Worker,
                      Data,
                      Response,
                  >
                  +

                  Worker choice strategies context referencing worker choice algorithms implementation.

                  +
                  +
                  + +
                  workerNodes: IWorkerNode<Worker, Data>[] = []
                  +
                  +
                  +
                  +
                  + +
                  +
                  + +
                    +
                  • +
                    get backPressure(): boolean
                    +
                    +

                    Whether the pool is back pressured or not.

                    +
                    +

                    Returns boolean

                    The pool back pressure boolean status.

                    +
                  +
                  + +
                    +
                  • +
                    get busy(): boolean
                    +
                    +

                    Whether the pool is busy or not.

                    +
                    +

                    Returns boolean

                    The pool busyness boolean status.

                    +
                  +
                  + +
                  +
                  + +
                    +
                  • +
                    get type(): "fixed" | "dynamic"
                    +
                    +

                    The pool type.

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

                    -

                    Returns "fixed" | "dynamic"

                  • get worker(): "cluster" | "thread"

                    The worker type.

                    -

                    Returns "cluster" | "thread"

                  Methods

                  • Hook executed after the worker task execution. +

                    +

                    Returns "fixed" | "dynamic"

                  +
                  + +
                    +
                  • +
                    get worker(): "cluster" | "thread"
                    +
                    +

                    The worker type.

                    +
                    +

                    Returns "cluster" | "thread"

                  +
                  + +
                  +
                  + +
                  +
                  + +
                  +
                  + +
                  +
                  + +

                  • Parameters

                    • Optionaldata: Data
                    • Optionalname: string
                    • OptionalabortSignal: AbortSignal
                    • OptionaltransferList: readonly Transferable[]

                    Returns Promise<Response>

                  • Parameters

                    • data: Iterable<Data>
                    • Optionalname: string
                    • OptionalabortSignals: Iterable<AbortSignal, any, any>
                    • OptionaltransferList: readonly Transferable[]

                    Returns Promise<Response[]>

                  +
                  + +
                  +
                  + +
                  +
                  + +
                  +
                  + +
                  +
                  + +
                    +
                  • + +
                    +

                    Deregisters a listener callback on the worker given its worker node key.

                    +
                    +
                    +

                    Type Parameters

                    +
                      +
                    • Message
                    +
                    +

                    Parameters

                    +
                      +
                    • workerNodeKey: number +

                      The worker node key.

                      +
                      • +
                    • listener: (message: MessageValue<Message>) => void +

                      The message listener callback.

                      +
                    +

                    Returns void

                  +
                  + +
                  +
                  + +
                  +
                  + +
                  +
                  + +
                    +
                  • + +
                    +
                    +

                    Parameters

                    +
                      +
                    • Optionaldata: Data
                      • +
                    • Optionalname: string
                      • +
                    • OptionalabortSignal: AbortSignal
                      • +
                    • OptionaltransferList: readonly Transferable[]
                    +

                    Returns Promise<Response>

                    +
                    +
                    +
                  +
                  + +
                  +
                  + +
                  +
                  + +
                    +
                  • + +
                    +

                    Gets the worker information given its worker node key.

                    +
                    +
                    +

                    Parameters

                    +
                      +
                    • workerNodeKey: number +

                      The worker node key.

                      +
                    +

                    Returns WorkerInfo | undefined

                    The worker information.

                    +
                  +
                  + +
                  +
                  + +
                  +
                  + +
                  +
                  + +
                  +
                  + +
                  +
                  + +
                    +
                  • + +
                    +
                    +

                    Parameters

                    +
                      +
                    • data: Iterable<Data>
                      • +
                    • Optionalname: string
                      • +
                    • OptionalabortSignals: Iterable<AbortSignal, any, any>
                      • +
                    • OptionaltransferList: readonly Transferable[]
                    +

                    Returns Promise<Response[]>

                    +
                    +
                    +
                  +
                  + +
                    +
                  • + +
                    +

                    Registers once a listener callback on the worker given its worker node key.

                    +
                    +
                    +

                    Type Parameters

                    +
                      +
                    • Message
                    +
                    +

                    Parameters

                    +
                      +
                    • workerNodeKey: number +

                      The worker node key.

                      +
                      • +
                    • listener: (message: MessageValue<Message>) => void +

                      The message listener callback.

                      +
                    +

                    Returns void

                  +
                  + +
                    +
                  • + +
                    +

                    Registers a listener callback on the worker given its worker node key.

                    +
                    +
                    +

                    Type Parameters

                    +
                      +
                    • Message
                    +
                    +

                    Parameters

                    +
                      +
                    • workerNodeKey: number +

                      The worker node key.

                      +
                      • +
                    • listener: (message: MessageValue<Message>) => void +

                      The message listener callback.

                      +
                    +

                    Returns void

                  +
                  + +
                  +
                  + +
                  +
                  + +
                    +
                  • + +
                    +

                    Sends a message to worker given its worker node key.

                    +
                    +
                    +

                    Parameters

                    +
                      +
                    • workerNodeKey: number +

                      The worker node key.

                      +
                      • +
                    • message: MessageValue<Data> +

                      The message.

                      +
                    +

                    Returns void

                  +
                  + +
                  +
                  + +
                  +
                  + +

                  • Parameters

                    • workerChoiceStrategy:
                          | "FAIR_SHARE"
                          | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                          | "LEAST_BUSY"
                          | "LEAST_ELU"
                          | "LEAST_USED"
                          | "ROUND_ROBIN"
                          | "WEIGHTED_ROUND_ROBIN"
                    • OptionalworkerChoiceStrategyOptions: WorkerChoiceStrategyOptions

                    Returns void

                  Settings

                  Member Visibility

                  On This Page

                  Constructors
                  Properties
                  Accessors
                  Methods
                  + +

                  Returns void

                  +
                  + +
                    +
                  • + +
                    +
                    +

                    Parameters

                    +
                      +
                    • workerChoiceStrategy:
                          | "FAIR_SHARE"
                          | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                          | "LEAST_BUSY"
                          | "LEAST_ELU"
                          | "LEAST_USED"
                          | "ROUND_ROBIN"
                          | "WEIGHTED_ROUND_ROBIN"
                      • +
                    • OptionalworkerChoiceStrategyOptions: WorkerChoiceStrategyOptions
                    +

                    Returns void

                    +
                    +
                    +
                  +
                  + +
                  +
                  + +
                  +
                  + +
                  +
                  + +
                  +
                  +
                  +
                  +
                  +

                  Settings

                   +
                  +
                  Member Visibility +
                    +
                    • +
                    • +
                  +
                  +
                  +

                  On This Page

                   +
                  +
                  Constructors +
                  +
                  Properties +
                  +
                  Accessors +
                  +
                  Methods +
                  +
                  +
                  +
                  diff --git a/docs/classes/src.FixedThreadPool.html b/docs/classes/src.FixedThreadPool.html index b4fef8168..022b5e222 100644 --- a/docs/classes/src.FixedThreadPool.html +++ b/docs/classes/src.FixedThreadPool.html @@ -1,10 +1,57 @@ -FixedThreadPool | poolifier - v5.3.2
                  poolifier - v5.3.2
                    Preparing search index...

                    Class FixedThreadPool<Data, Response>

                    A thread pool with a fixed number of threads.

                    -

                    Alessandro Pio Ardizio

                    -

                    0.0.1

                    -

                    Type Parameters

                    • Data = unknown

                      Type of data sent to the worker. This can only be structured-cloneable data.

                      -
                    • Response = unknown

                      Type of execution response. This can only be structured-cloneable data.

                      -

                    Hierarchy (View Summary)

                    Index

                    Constructors

                    constructor -

                    Properties

                    destroying +FixedThreadPool | poolifier - v5.4.0
                    +
                    poolifier - v5.4.0 + +
                      +
                      +
                      Preparing search index...
                      +
                      +
                      +
                      + +

                      Class FixedThreadPool<Data, Response>

                      +
                      +

                      A thread pool with a fixed number of threads.

                      +
                      +
                      +
                      +

                      Alessandro Pio Ardizio

                      +
                      +
                      +

                      0.0.1

                      +
                      +
                      +

                      Type Parameters

                      +
                        +
                      • Data = unknown +

                        Type of data sent to the worker. This can only be structured-cloneable data.

                        +
                        • +
                      • Response = unknown +

                        Type of execution response. This can only be structured-cloneable data.

                        +
                      +
                      +

                      Hierarchy (View Summary)

                      +
                      +
                      +
                      +
                      +
                      Index
                       +
                      +
                      + +
                      constructor +
                      +
                      + +
                      destroying emitter? filePath maximumNumberOfWorkers? @@ -15,12 +62,18 @@ starting workerChoiceStrategiesContext? workerNodes -

                      Accessors

                      backPressure +
                      +
                      + +
                      backPressure busy info type worker -

                      Methods

                      addTaskFunction +
                      +
                      + +
                      addTaskFunction afterTaskExecutionHook afterWorkerNodeSetup beforeTaskExecutionHook @@ -55,81 +108,836 @@ shallCreateDynamicWorker start workerMessageListener -

                      Constructors

                      • Constructs a new poolifier fixed thread pool.

                        -

                        Type Parameters

                        • Data = unknown

                          Type of data sent to the worker. This can only be structured-cloneable data.

                          -
                        • Response = unknown

                          Type of execution response. This can only be structured-cloneable data.

                          -

                        Parameters

                        • numberOfThreads: number

                          Number of threads for this pool.

                          -
                        • filePath: string

                          Path to an implementation of a ThreadWorker file, which can be relative or absolute.

                          -
                        • opts: ThreadPoolOptions = {}

                          Options for this fixed thread pool.

                          -
                        • OptionalmaximumNumberOfThreads: number

                          The maximum number of threads for this pool.

                          -

                        Returns FixedThreadPool<Data, Response>

                      Properties

                      destroying: boolean

                      Whether the pool is destroying or not.

                      -
                      emitter?: EventEmitterAsyncResource
                      filePath: string

                      Path to the worker file.

                      -
                      maximumNumberOfWorkers?: number

                      Maximum number of workers that this pool manages.

                      -
                      minimumNumberOfWorkers: number

                      Minimum number of workers that this pool manages.

                      -
                      opts: PoolOptions<Worker>

                      Options for the pool.

                      -
                      promiseResponseMap: Map<
                          `${string}-${string}-${string}-${string}-${string}`,
                          PromiseResponseWrapper<Response>,
                      > = ...

                      The task execution response promise map:

                      +
                      +
                      + +
                      +
                      + +
                        +
                      • + +
                        +

                        Constructs a new poolifier fixed thread pool.

                        +
                        +
                        +

                        Type Parameters

                        +
                          +
                        • Data = unknown +

                          Type of data sent to the worker. This can only be structured-cloneable data.

                          +
                          • +
                        • Response = unknown +

                          Type of execution response. This can only be structured-cloneable data.

                          +
                        +
                        +

                        Parameters

                        +
                          +
                        • numberOfThreads: number +

                          Number of threads for this pool.

                          +
                          • +
                        • filePath: string +

                          Path to an implementation of a ThreadWorker file, which can be relative or absolute.

                          +
                          • +
                        • opts: ThreadPoolOptions = {} +

                          Options for this fixed thread pool.

                          +
                          • +
                        • OptionalmaximumNumberOfThreads: number +

                          The maximum number of threads for this pool.

                          +
                        +

                        Returns FixedThreadPool<Data, Response>

                      +
                      + +
                      +
                      + +
                      destroying: boolean
                      +

                      Whether the pool is destroying or not.

                      +
                      +
                      + +
                      emitter?: EventEmitterAsyncResource
                      +
                      +
                      +
                      +
                      + +
                      filePath: string
                      +

                      Path to the worker file.

                      +
                      +
                      + +
                      maximumNumberOfWorkers?: number
                      +

                      Maximum number of workers that this pool manages.

                      +
                      +
                      + +
                      minimumNumberOfWorkers: number
                      +

                      Minimum number of workers that this pool manages.

                      +
                      +
                      + +
                      opts: PoolOptions<Worker>
                      +

                      Options for the pool.

                      +
                      +
                      + +
                      promiseResponseMap: Map<
                          `${string}-${string}-${string}-${string}-${string}`,
                          PromiseResponseWrapper<Response>,
                      > = ...
                      +

                      The task execution response promise map:

                      • key: The message id of each submitted task.
                      • value: An object that contains task's worker node key, execution response promise resolve and reject callbacks, async resource.

                      When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.

                      -
                      started: boolean

                      Whether the pool is started or not.

                      -
                      starting: boolean

                      Whether the pool is starting or not.

                      -
                      workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<
                          Worker,
                          Data,
                          Response,
                      >

                      Worker choice strategies context referencing worker choice algorithms implementation.

                      -
                      workerNodes: IWorkerNode<Worker, Data>[] = []

                      Accessors

                      • get backPressure(): boolean

                        Whether the pool is back pressured or not.

                        -

                        Returns boolean

                        The pool back pressure boolean status.

                        -
                      • get busy(): boolean

                        Whether the pool is busy or not.

                        -

                        Returns boolean

                        The pool busyness boolean status.

                        -
                      +
                      + +
                      started: boolean
                      +

                      Whether the pool is started or not.

                      +
                      +
                      + +
                      starting: boolean
                      +

                      Whether the pool is starting or not.

                      +
                      +
                      + +
                      workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<
                          Worker,
                          Data,
                          Response,
                      >
                      +

                      Worker choice strategies context referencing worker choice algorithms implementation.

                      +
                      +
                      + +
                      workerNodes: IWorkerNode<Worker, Data>[] = []
                      +
                      +
                      +
                      +
                      + +
                      +
                      + +
                        +
                      • +
                        get backPressure(): boolean
                        +
                        +

                        Whether the pool is back pressured or not.

                        +
                        +

                        Returns boolean

                        The pool back pressure boolean status.

                        +
                      +
                      + +
                        +
                      • +
                        get busy(): boolean
                        +
                        +

                        Whether the pool is busy or not.

                        +
                        +

                        Returns boolean

                        The pool busyness boolean status.

                        +
                      +
                      + +
                      +
                      + +
                        +
                      • +
                        get type(): "fixed" | "dynamic"
                        +
                        +

                        The pool type.

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

                        -

                        Returns "fixed" | "dynamic"

                      • get worker(): "cluster" | "thread"

                        The worker type.

                        -

                        Returns "cluster" | "thread"

                      Methods

                      • Hook executed after the worker task execution. +

                        +

                        Returns "fixed" | "dynamic"

                      +
                      + +
                        +
                      • +
                        get worker(): "cluster" | "thread"
                        +
                        +

                        The worker type.

                        +
                        +

                        Returns "cluster" | "thread"

                      +
                      + +
                      +
                      + +
                      +
                      + +
                      +
                      + +
                      +
                      + +

                      • Parameters

                        • Optionaldata: Data
                        • Optionalname: string
                        • OptionalabortSignal: AbortSignal
                        • OptionaltransferList: readonly Transferable[]

                        Returns Promise<Response>

                      • Parameters

                        • data: Iterable<Data>
                        • Optionalname: string
                        • OptionalabortSignals: Iterable<AbortSignal, any, any>
                        • OptionaltransferList: readonly Transferable[]

                        Returns Promise<Response[]>

                      • Sends a message to worker given its worker node key.

                        -

                        Parameters

                        • workerNodeKey: number

                          The worker node key.

                          -
                        • message: MessageValue<Data>

                          The message.

                          -
                        • OptionaltransferList: readonly Transferable[]

                          The optional array of transferable objects.

                          -

                        Returns void

                      +
                      + +
                      +
                      + +
                      +
                      + +
                      +
                      + +
                      +
                      + +
                        +
                      • + +
                        +

                        Deregisters a listener callback on the worker given its worker node key.

                        +
                        +
                        +

                        Type Parameters

                        +
                          +
                        • Message
                        +
                        +

                        Parameters

                        +
                          +
                        • workerNodeKey: number +

                          The worker node key.

                          +
                          • +
                        • listener: (message: MessageValue<Message>) => void +

                          The message listener callback.

                          +
                        +

                        Returns void

                      +
                      + +
                      +
                      + +
                      +
                      + +
                      +
                      + +
                        +
                      • + +
                        +
                        +

                        Parameters

                        +
                          +
                        • Optionaldata: Data
                          • +
                        • Optionalname: string
                          • +
                        • OptionalabortSignal: AbortSignal
                          • +
                        • OptionaltransferList: readonly Transferable[]
                        +

                        Returns Promise<Response>

                        +
                        +
                        +
                      +
                      + +
                      +
                      + +
                      +
                      + +
                        +
                      • + +
                        +

                        Gets the worker information given its worker node key.

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • workerNodeKey: number +

                          The worker node key.

                          +
                        +

                        Returns WorkerInfo | undefined

                        The worker information.

                        +
                      +
                      + +
                      +
                      + +
                      +
                      + +
                      +
                      + +
                      +
                      + +
                      +
                      + +
                        +
                      • + +
                        +
                        +

                        Parameters

                        +
                          +
                        • data: Iterable<Data>
                          • +
                        • Optionalname: string
                          • +
                        • OptionalabortSignals: Iterable<AbortSignal, any, any>
                          • +
                        • OptionaltransferList: readonly Transferable[]
                        +

                        Returns Promise<Response[]>

                        +
                        +
                        +
                      +
                      + +
                        +
                      • + +
                        +

                        Registers once a listener callback on the worker given its worker node key.

                        +
                        +
                        +

                        Type Parameters

                        +
                          +
                        • Message
                        +
                        +

                        Parameters

                        +
                          +
                        • workerNodeKey: number +

                          The worker node key.

                          +
                          • +
                        • listener: (message: MessageValue<Message>) => void +

                          The message listener callback.

                          +
                        +

                        Returns void

                      +
                      + +
                        +
                      • + +
                        +

                        Registers a listener callback on the worker given its worker node key.

                        +
                        +
                        +

                        Type Parameters

                        +
                          +
                        • Message
                        +
                        +

                        Parameters

                        +
                          +
                        • workerNodeKey: number +

                          The worker node key.

                          +
                          • +
                        • listener: (message: MessageValue<Message>) => void +

                          The message listener callback.

                          +
                        +

                        Returns void

                      +
                      + +
                      +
                      + +
                      +
                      + +
                        +
                      • + +
                        +

                        Sends a message to worker given its worker node key.

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • workerNodeKey: number +

                          The worker node key.

                          +
                          • +
                        • message: MessageValue<Data> +

                          The message.

                          +
                          • +
                        • OptionaltransferList: readonly Transferable[] +

                          The optional array of transferable objects.

                          +
                        +

                        Returns void

                      +
                      + +
                      +
                      + +
                      +
                      + +

                      • Parameters

                        • workerChoiceStrategy:
                              | "FAIR_SHARE"
                              | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                              | "LEAST_BUSY"
                              | "LEAST_ELU"
                              | "LEAST_USED"
                              | "ROUND_ROBIN"
                              | "WEIGHTED_ROUND_ROBIN"
                        • OptionalworkerChoiceStrategyOptions: WorkerChoiceStrategyOptions

                        Returns void

                      Settings

                      Member Visibility

                      On This Page

                      Constructors
                      Properties
                      Accessors
                      Methods
                      + +

                      Returns void

                      +
                      + +
                        +
                      • + +
                        +
                        +

                        Parameters

                        +
                          +
                        • workerChoiceStrategy:
                              | "FAIR_SHARE"
                              | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                              | "LEAST_BUSY"
                              | "LEAST_ELU"
                              | "LEAST_USED"
                              | "ROUND_ROBIN"
                              | "WEIGHTED_ROUND_ROBIN"
                          • +
                        • OptionalworkerChoiceStrategyOptions: WorkerChoiceStrategyOptions
                        +

                        Returns void

                        +
                        +
                        +
                      +
                      + +
                      +
                      + +
                      +
                      + +
                      +
                      + +
                      +
                      +
                      +
                      +
                      +

                      Settings

                       +
                      +
                      Member Visibility +
                        +
                        • +
                        • +
                      +
                      +
                      +

                      On This Page

                       +
                      +
                      Constructors +
                      +
                      Properties +
                      +
                      Accessors +
                      +
                      Methods +
                      +
                      +
                      +
                      diff --git a/docs/classes/src.ThreadWorker.html b/docs/classes/src.ThreadWorker.html index d7326c642..9f2eb1983 100644 --- a/docs/classes/src.ThreadWorker.html +++ b/docs/classes/src.ThreadWorker.html @@ -1,22 +1,73 @@ -ThreadWorker | poolifier - v5.3.2
                      poolifier - v5.3.2
                        Preparing search index...

                        Class ThreadWorker<Data, Response>

                        A thread worker used by a poolifier ThreadPool.

                        +ThreadWorker | poolifier - v5.4.0
                        +
                        poolifier - v5.4.0 + +
                          +
                          +
                          Preparing search index...
                          +
                          +
                          +
                          + +

                          Class ThreadWorker<Data, Response>

                          +
                          +

                          A thread worker used by a poolifier ThreadPool.

                          When this worker is inactive for more than the given maxInactiveTime, it will send a termination request to its main thread.

                          If you use a DynamicThreadPool the extra workers that were created will be terminated, but the minimum number of workers will be guaranteed.

                          -

                          Alessandro Pio Ardizio

                          -

                          0.0.1

                          -

                          Type Parameters

                          • Data = unknown

                            Type of data this worker receives from pool's execution. This can only be structured-cloneable data.

                            -
                          • Response = unknown

                            Type of response the worker sends back to the main thread. This can only be structured-cloneable data.

                            -

                          Hierarchy (View Summary)

                          Index

                          Constructors

                          constructor -

                          Properties

                          activeInterval? +
                          +
                          +
                          +

                          Alessandro Pio Ardizio

                          +
                          +
                          +

                          0.0.1

                          +
                          +
                          +

                          Type Parameters

                          +
                            +
                          • Data = unknown +

                            Type of data this worker receives from pool's execution. This can only be structured-cloneable data.

                            +
                            • +
                          • Response = unknown +

                            Type of response the worker sends back to the main thread. This can only be structured-cloneable data.

                            +
                          +
                          +

                          Hierarchy (View Summary)

                          +
                          +
                          +
                          +
                          +
                          Index
                           +
                          +
                          + +
                          constructor +
                          +
                          + +
                          activeInterval? isMain lastTaskTimestamp opts statistics? taskAbortFunctions taskFunctions -

                          Accessors

                          id -

                          Methods

                          addTaskFunction +
                          +
                          + +
                          id +
                          +
                          + +
                          addTaskFunction getMainWorker handleError handleKillMessage @@ -32,56 +83,430 @@ but the minimum number of workers will be guaranteed.

                          sendTaskFunctionsPropertiesToMainWorker sendToMainWorker setDefaultTaskFunction -

                          Constructors

                          Properties

                          activeInterval?: Timeout

                          Handler id of the activeInterval worker activity check.

                          -
                          isMain: boolean | undefined

                          Whether this is the main worker or not.

                          -
                          lastTaskTimestamp: number

                          Timestamp of the last task processed by this worker.

                          -
                          opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

                          Options for the worker.

                          -
                          statistics?: WorkerStatistics

                          Performance statistics computation requirements.

                          -
                          taskAbortFunctions: Map<
                              `${string}-${string}-${string}-${string}-${string}`,
                              () => void,
                          >

                          Task abort functions processed by the worker when task operation 'abort' is received.

                          -
                          taskFunctions: Map<string, TaskFunctionObject<Data, Response>>

                          Task function object(s) processed by the worker when the pool's execute method is invoked.

                          -

                          Accessors

                          Methods

                          +
                          + +
                          +
                          + +
                          +
                          + +
                          +
                          + +
                          activeInterval?: Timeout
                          +

                          Handler id of the activeInterval worker activity check.

                          +
                          +
                          + +
                          isMain: boolean | undefined
                          +

                          Whether this is the main worker or not.

                          +
                          +
                          + +
                          lastTaskTimestamp: number
                          +

                          Timestamp of the last task processed by this worker.

                          +
                          +
                          + +
                          opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
                          +

                          Options for the worker.

                          +
                          +
                          + +
                          statistics?: WorkerStatistics
                          +

                          Performance statistics computation requirements.

                          +
                          +
                          + +
                          taskAbortFunctions: Map<
                              `${string}-${string}-${string}-${string}-${string}`,
                              () => void,
                          >
                          +

                          Task abort functions processed by the worker when task operation 'abort' is received.

                          +
                          +
                          + +
                          taskFunctions: Map<string, TaskFunctionObject<Data, Response>>
                          +

                          Task function object(s) processed by the worker when the pool's execute method is invoked.

                          +
                          +
                          + +
                          +
                          + +
                          +
                          + +
                          +
                          + +

                          • Handles a worker error.

                            -

                            Parameters

                            • error: Error

                              The error raised by the worker.

                              -

                            Returns { aborted: boolean; error: Error; message: string; stack?: string }

                            The worker error object.

                            -

                          Settings

                          Member Visibility

                          On This Page

                          Constructors
                          Properties
                          Accessors
                          Methods
                          +
                          +
                          +

                          Parameters

                          +
                          +

                          Returns TaskFunctionOperationResult

                          Whether the task function was added or not.

                          +
                          +
                          + +
                          +
                          + +
                            +
                          • + +
                            +

                            Handles a worker error.

                            +
                            +
                            +

                            Parameters

                            +
                              +
                            • error: Error +

                              The error raised by the worker.

                              +
                            +

                            Returns { aborted: boolean; error: Error; message: string; stack?: string }

                            The worker error object.

                            +
                          +
                          + +
                          +
                          + +
                          +
                          + +
                          +
                          + +
                          +
                          + +
                          +
                          + +
                          +
                          + +
                          +
                          + +
                          +
                          + +
                          +
                          + +
                          +
                          + +
                          +
                          + +
                          +
                          + +
                          +
                          +
                          +
                          +
                          +

                          Settings

                           +
                          +
                          Member Visibility +
                            +
                            • +
                            • +
                          +
                          +
                          +

                          On This Page

                           +
                          +
                          Constructors +
                          +
                          Properties +
                          +
                          Accessors +
                          +
                          Methods +
                          +
                          +
                          +
                          diff --git a/docs/documents/api.html b/docs/documents/api.html index f22e42bbc..89bf8d952 100644 --- a/docs/documents/api.html +++ b/docs/documents/api.html @@ -1,4 +1,15 @@ -api | poolifier - v5.3.2
                          poolifier - v5.3.2
                            Preparing search index...

                            API

                            +api | poolifier - v5.4.0
                            +
                            poolifier - v5.4.0 + +
                              +
                              +
                              Preparing search index...
                              +
                              +
                              +
                              +
                              +

                              API

                              • Pool @@ -204,4 +215,56 @@ Default: () => {}

                                YourWorker.setDefaultTaskFunction(name)

                                name (mandatory) The task function name.

                                This method is available on both worker implementations and returns { status: boolean, error?: Error }.

                                -

                              Settings

                              Member Visibility

                              On This Page

                              API
                              +
                              +
                              +
                              +
                              +
                              +

                              Settings

                               +
                              +
                              Member Visibility +
                                +
                                • +
                                • +
                              +
                              +
                              +

                              On This Page

                               +
                              API +
                              +
                              +
                              +
                              diff --git a/docs/documents/general-guidelines.html b/docs/documents/general-guidelines.html index 307012511..653493d53 100644 --- a/docs/documents/general-guidelines.html +++ b/docs/documents/general-guidelines.html @@ -1,4 +1,15 @@ -general-guidelines | poolifier - v5.3.2
                              poolifier - v5.3.2
                                Preparing search index...

                                General guidelines

                                +general-guidelines | poolifier - v5.4.0
                                +
                                poolifier - v5.4.0 + +
                                  +
                                  +
                                  Preparing search index...
                                  +
                                  +
                                  +
                                  +
                                  +

                                  General guidelines

                                  Performance is one of the main target of these worker pool implementations, poolifier team wants to have a strong focus on this.
                                  Poolifier already has benchmarks where you can find some comparisons.

                                  @@ -32,4 +43,30 @@ By doing so, your application will be ready to execute in parallel more tasks, b One good choice from poolifier team point of view is to profile your application using a fixed or dynamic worker pool, and analyze your application metrics when you increase/decrease the number of workers.
                                  For example you could keep the memory footprint low by choosing a DynamicThreadPool/DynamicClusterPool with a minimum of 5 workers, and allowing it to create new workers until a maximum of 50 workers if needed. This is the advantage of using a DynamicThreadPool/DynamicClusterPool.
                                  But in general, always profile your application.

                                  -

                                  Settings

                                  Member Visibility

                                  On This Page

                                  General guidelines
                                  +
                                  +
                                  +
                                  +
                                  +
                                  +

                                  Settings

                                   +
                                  +
                                  Member Visibility +
                                    +
                                    • +
                                    • +
                                  +
                                  +
                                  +

                                  On This Page

                                   +
                                  General guidelines +
                                  +
                                  +
                                  +
                                  diff --git a/docs/documents/worker-choice-strategies.html b/docs/documents/worker-choice-strategies.html index 7109867dc..9b3f4380a 100644 --- a/docs/documents/worker-choice-strategies.html +++ b/docs/documents/worker-choice-strategies.html @@ -1,4 +1,15 @@ -worker-choice-strategies | poolifier - v5.3.2
                                  poolifier - v5.3.2
                                    Preparing search index...

                                    Worker choice strategies

                                    +worker-choice-strategies | poolifier - v5.4.0
                                    +
                                    poolifier - v5.4.0 + +
                                      +
                                      +
                                      Preparing search index...
                                      +
                                      +
                                      +
                                      +
                                      +

                                      Worker choice strategies

                                      All duration or timestamp are expressed in milliseconds.

                                        @@ -29,4 +40,37 @@ The default worker weights is the same for each and computed given the CPU cores

                                        Worker choice strategies enable only the statistics that are needed to choose the next worker to avoid unnecessary overhead.

                                        Strategies using the simple moving average task execution time for each worker can use the simple moving median instead. Simple moving median is more robust to outliers and can be used to avoid assigning tasks to workers that are currently overloaded.

                                        -

                                      Settings

                                      Member Visibility

                                      On This Page

                                      Worker choice strategies
                                      +
                                      +
                                      +
                                      +
                                      +
                                      +

                                      Settings

                                       +
                                      +
                                      Member Visibility +
                                        +
                                        • +
                                        • +
                                      +
                                      +
                                      +

                                      On This Page

                                       +
                                      Worker choice strategies +
                                      +
                                      +
                                      +
                                      diff --git a/docs/functions/src.availableParallelism.html b/docs/functions/src.availableParallelism.html index ff19384d3..d9dec83db 100644 --- a/docs/functions/src.availableParallelism.html +++ b/docs/functions/src.availableParallelism.html @@ -1,4 +1,43 @@ -availableParallelism | poolifier - v5.3.2
                                      poolifier - v5.3.2
                                        Preparing search index...

                                        Function availableParallelism

                                        • Returns safe host OS optimized estimate of the default amount of parallelism a pool should use. +availableParallelism | poolifier - v5.4.0

                                          +
                                          poolifier - v5.4.0 + +
                                            +
                                            +
                                            Preparing search index...
                                            +
                                            +
                                            +
                                            + +

                                            Function availableParallelism

                                            +
                                            +
                                              +
                                            • + +
                                              +

                                              Returns safe host OS optimized estimate of the default amount of parallelism a pool should use. Always returns a value greater than zero.

                                              -

                                              Returns number

                                              The host OS optimized maximum pool size.

                                              -

                                            Settings

                                            Member Visibility
                                            +
                                            +

                                            Returns number

                                            The host OS optimized maximum pool size.

                                            +
                                          +
                                          +
                                          +
                                          +
                                          +

                                          Settings

                                           +
                                          +
                                          Member Visibility +
                                            +
                                            • +
                                            • +
                                          +
                                          +
                                          +
                                          +
                                          diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 8e1e6bad7..4a9c676eb 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1,45 @@ -poolifier - v5.3.2
                                          poolifier - v5.3.2
                                            Preparing search index...

                                            poolifier - v5.3.2

                                            Hierarchy Summary

                                            Settings

                                            Member Visibility
                                            +poolifier - v5.4.0
                                            +
                                            poolifier - v5.4.0 + +
                                              +
                                              +
                                              Preparing search index...
                                              +
                                              +
                                              +
                                              +

                                              poolifier - v5.4.0

                                              +

                                              Hierarchy Summary

                                              + +
                                              +
                                              +
                                              +
                                              +
                                              +

                                              Settings

                                               +
                                              +
                                              Member Visibility +
                                                +
                                                • +
                                                • +
                                              +
                                              +
                                              +
                                              +
                                              diff --git a/docs/index.html b/docs/index.html index e7b322416..b5d150fbb 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1 +1,39 @@ -poolifier - v5.3.2
                                              poolifier - v5.3.2
                                                Preparing search index...

                                                poolifier - v5.3.2

                                                Documents

                                                api
                                                general-guidelines
                                                worker-choice-strategies

                                                Modules

                                                src

                                                Settings

                                                Member Visibility

                                                On This Page

                                                Documents
                                                Modules
                                                +poolifier - v5.4.0
                                                +
                                                poolifier - v5.4.0 + +
                                                  +
                                                  +
                                                  Preparing search index...
                                                  +
                                                  +
                                                  +
                                                  +

                                                  poolifier - v5.4.0

                                                  +
                                                  +
                                                  api
                                                  general-guidelines
                                                  worker-choice-strategies
                                                  +
                                                  +
                                                  src
                                                  +
                                                  +
                                                  +
                                                  +
                                                  +

                                                  Settings

                                                   +
                                                  +
                                                  Member Visibility +
                                                    +
                                                    • +
                                                    • +
                                                  +
                                                  +
                                                  +

                                                  On This Page

                                                   +
                                                  +
                                                  Documents +
                                                  +
                                                  Modules +
                                                  +
                                                  +
                                                  +
                                                  diff --git a/docs/interfaces/src.AbstractPool.html b/docs/interfaces/src.AbstractPool.html index b2cdfc0b8..d5167a07b 100644 --- a/docs/interfaces/src.AbstractPool.html +++ b/docs/interfaces/src.AbstractPool.html @@ -1,8 +1,53 @@ -AbstractPool | poolifier - v5.3.2
                                                  poolifier - v5.3.2
                                                    Preparing search index...

                                                    Interface AbstractPool<Worker, Data, Response>Abstract

                                                    Base class that implements some shared logic for all poolifier pools.

                                                    -
                                                    interface AbstractPool<
                                                        Worker extends IWorker,
                                                        Data = unknown,
                                                        Response = unknown,
                                                    > {
                                                        destroying: boolean;
                                                        emitter?: EventEmitterAsyncResource;
                                                        filePath: string;
                                                        maximumNumberOfWorkers?: number;
                                                        minimumNumberOfWorkers: number;
                                                        opts: PoolOptions<Worker>;
                                                        promiseResponseMap: Map<
                                                            `${string}-${string}-${string}-${string}-${string}`,
                                                            PromiseResponseWrapper<Response>,
                                                        >;
                                                        started: boolean;
                                                        starting: boolean;
                                                        workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<
                                                            Worker,
                                                            Data,
                                                            Response,
                                                        >;
                                                        workerNodes: IWorkerNode<Worker, Data>[];
                                                        get backPressure(): boolean;
                                                        get busy(): boolean;
                                                        get info(): PoolInfo;
                                                        get type(): "fixed" | "dynamic";
                                                        get worker(): "cluster" | "thread";
                                                        addTaskFunction(
                                                            name: string,
                                                            fn: TaskFunction<Data, Response> | TaskFunctionObject<Data, Response>,
                                                        ): Promise<boolean>;
                                                        afterTaskExecutionHook(
                                                            workerNodeKey: number,
                                                            message: MessageValue<Response>,
                                                        ): void;
                                                        afterWorkerNodeSetup(workerNodeKey: number): void;
                                                        beforeTaskExecutionHook(workerNodeKey: number, task: Task<Data>): void;
                                                        checkAndEmitDynamicWorkerCreationEvents(): void;
                                                        checkAndEmitDynamicWorkerDestructionEvents(): void;
                                                        createAndSetupDynamicWorkerNode(): number;
                                                        createAndSetupWorkerNode(): number;
                                                        deregisterWorkerMessageListener<Message>(
                                                            workerNodeKey: number,
                                                            listener: (message: MessageValue<Message>) => void,
                                                        ): void;
                                                        destroy(): Promise<void>;
                                                        destroyWorkerNode(workerNodeKey: number): Promise<void>;
                                                        enableTasksQueue(
                                                            enable: boolean,
                                                            tasksQueueOptions?: TasksQueueOptions,
                                                        ): void;
                                                        execute(
                                                            data?: Data,
                                                            name?: string,
                                                            abortSignal?: AbortSignal,
                                                            transferList?: readonly Transferable[],
                                                        ): Promise<Response>;
                                                        flagWorkerNodeAsNotReady(workerNodeKey: number): void;
                                                        flushTasksQueue(workerNodeKey: number): number;
                                                        getWorkerInfo(workerNodeKey: number): WorkerInfo | undefined;
                                                        hasTaskFunction(name: string): boolean;
                                                        internalBackPressure(): boolean;
                                                        internalBusy(): boolean;
                                                        isMain(): boolean;
                                                        listTaskFunctionsProperties(): TaskFunctionProperties[];
                                                        mapExecute(
                                                            data: Iterable<Data>,
                                                            name?: string,
                                                            abortSignals?: Iterable<AbortSignal, any, any>,
                                                            transferList?: readonly Transferable[],
                                                        ): Promise<Response[]>;
                                                        registerOnceWorkerMessageListener<Message>(
                                                            workerNodeKey: number,
                                                            listener: (message: MessageValue<Message>) => void,
                                                        ): void;
                                                        registerWorkerMessageListener<Message>(
                                                            workerNodeKey: number,
                                                            listener: (message: MessageValue<Message>) => void,
                                                        ): void;
                                                        removeTaskFunction(name: string): Promise<boolean>;
                                                        sendStartupMessageToWorker(workerNodeKey: number): void;
                                                        sendToWorker(
                                                            workerNodeKey: number,
                                                            message: MessageValue<Data>,
                                                            transferList?: readonly Transferable[],
                                                        ): void;
                                                        setDefaultTaskFunction(name: string): Promise<boolean>;
                                                        setTasksQueueOptions(
                                                            tasksQueueOptions: TasksQueueOptions | undefined,
                                                        ): void;
                                                        setupHook(): void;
                                                        setWorkerChoiceStrategy(
                                                            workerChoiceStrategy:
                                                                | "FAIR_SHARE"
                                                                | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                | "LEAST_BUSY"
                                                                | "LEAST_ELU"
                                                                | "LEAST_USED"
                                                                | "ROUND_ROBIN"
                                                                | "WEIGHTED_ROUND_ROBIN",
                                                            workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions,
                                                        ): void;
                                                        setWorkerChoiceStrategyOptions(
                                                            workerChoiceStrategyOptions: WorkerChoiceStrategyOptions | undefined,
                                                        ): boolean;
                                                        shallCreateDynamicWorker(): boolean;
                                                        start(): void;
                                                        workerMessageListener(message: MessageValue<Response>): void;
                                                    }

                                                    Type Parameters

                                                    • Worker extends IWorker

                                                      Type of worker which manages this pool.

                                                      -
                                                    • Data = unknown

                                                      Type of data sent to the worker. This can only be structured-cloneable data.

                                                      -
                                                    • Response = unknown

                                                      Type of execution response. This can only be structured-cloneable data.

                                                      -

                                                    Hierarchy (View Summary)

                                                    Implements

                                                    Index

                                                    Properties

                                                    destroying +AbstractPool | poolifier - v5.4.0
                                                    +
                                                    poolifier - v5.4.0 + +
                                                      +
                                                      +
                                                      Preparing search index...
                                                      +
                                                      +
                                                      +
                                                      + +

                                                      Interface AbstractPool<Worker, Data, Response>Abstract

                                                      +
                                                      +

                                                      Base class that implements some shared logic for all poolifier pools.

                                                      +
                                                      +
                                                      interface AbstractPool<
                                                          Worker extends IWorker,
                                                          Data = unknown,
                                                          Response = unknown,
                                                      > {
                                                          destroying: boolean;
                                                          emitter?: EventEmitterAsyncResource;
                                                          filePath: string;
                                                          maximumNumberOfWorkers?: number;
                                                          minimumNumberOfWorkers: number;
                                                          opts: PoolOptions<Worker>;
                                                          promiseResponseMap: Map<
                                                              `${string}-${string}-${string}-${string}-${string}`,
                                                              PromiseResponseWrapper<Response>,
                                                          >;
                                                          started: boolean;
                                                          starting: boolean;
                                                          workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<
                                                              Worker,
                                                              Data,
                                                              Response,
                                                          >;
                                                          workerNodes: IWorkerNode<Worker, Data>[];
                                                          get backPressure(): boolean;
                                                          get busy(): boolean;
                                                          get info(): PoolInfo;
                                                          get type(): "fixed" | "dynamic";
                                                          get worker(): "cluster" | "thread";
                                                          addTaskFunction(
                                                              name: string,
                                                              fn: TaskFunction<Data, Response> | TaskFunctionObject<Data, Response>,
                                                          ): Promise<boolean>;
                                                          afterTaskExecutionHook(
                                                              workerNodeKey: number,
                                                              message: MessageValue<Response>,
                                                          ): void;
                                                          afterWorkerNodeSetup(workerNodeKey: number): void;
                                                          beforeTaskExecutionHook(workerNodeKey: number, task: Task<Data>): void;
                                                          checkAndEmitDynamicWorkerCreationEvents(): void;
                                                          checkAndEmitDynamicWorkerDestructionEvents(): void;
                                                          createAndSetupDynamicWorkerNode(): number;
                                                          createAndSetupWorkerNode(): number;
                                                          deregisterWorkerMessageListener<Message>(
                                                              workerNodeKey: number,
                                                              listener: (message: MessageValue<Message>) => void,
                                                          ): void;
                                                          destroy(): Promise<void>;
                                                          destroyWorkerNode(workerNodeKey: number): Promise<void>;
                                                          enableTasksQueue(
                                                              enable: boolean,
                                                              tasksQueueOptions?: TasksQueueOptions,
                                                          ): void;
                                                          execute(
                                                              data?: Data,
                                                              name?: string,
                                                              abortSignal?: AbortSignal,
                                                              transferList?: readonly Transferable[],
                                                          ): Promise<Response>;
                                                          flagWorkerNodeAsNotReady(workerNodeKey: number): void;
                                                          flushTasksQueue(workerNodeKey: number): number;
                                                          getWorkerInfo(workerNodeKey: number): WorkerInfo | undefined;
                                                          hasTaskFunction(name: string): boolean;
                                                          internalBackPressure(): boolean;
                                                          internalBusy(): boolean;
                                                          isMain(): boolean;
                                                          listTaskFunctionsProperties(): TaskFunctionProperties[];
                                                          mapExecute(
                                                              data: Iterable<Data>,
                                                              name?: string,
                                                              abortSignals?: Iterable<AbortSignal, any, any>,
                                                              transferList?: readonly Transferable[],
                                                          ): Promise<Response[]>;
                                                          registerOnceWorkerMessageListener<Message>(
                                                              workerNodeKey: number,
                                                              listener: (message: MessageValue<Message>) => void,
                                                          ): void;
                                                          registerWorkerMessageListener<Message>(
                                                              workerNodeKey: number,
                                                              listener: (message: MessageValue<Message>) => void,
                                                          ): void;
                                                          removeTaskFunction(name: string): Promise<boolean>;
                                                          sendStartupMessageToWorker(workerNodeKey: number): void;
                                                          sendToWorker(
                                                              workerNodeKey: number,
                                                              message: MessageValue<Data>,
                                                              transferList?: readonly Transferable[],
                                                          ): void;
                                                          setDefaultTaskFunction(name: string): Promise<boolean>;
                                                          setTasksQueueOptions(
                                                              tasksQueueOptions: TasksQueueOptions | undefined,
                                                          ): void;
                                                          setupHook(): void;
                                                          setWorkerChoiceStrategy(
                                                              workerChoiceStrategy:
                                                                  | "FAIR_SHARE"
                                                                  | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                  | "LEAST_BUSY"
                                                                  | "LEAST_ELU"
                                                                  | "LEAST_USED"
                                                                  | "ROUND_ROBIN"
                                                                  | "WEIGHTED_ROUND_ROBIN",
                                                              workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions,
                                                          ): void;
                                                          setWorkerChoiceStrategyOptions(
                                                              workerChoiceStrategyOptions: WorkerChoiceStrategyOptions | undefined,
                                                          ): boolean;
                                                          shallCreateDynamicWorker(): boolean;
                                                          start(): void;
                                                          workerMessageListener(message: MessageValue<Response>): void;
                                                      }
                                                      +
                                                      +

                                                      Type Parameters

                                                      +
                                                        +
                                                      • Worker extends IWorker +

                                                        Type of worker which manages this pool.

                                                        +
                                                        • +
                                                      • Data = unknown +

                                                        Type of data sent to the worker. This can only be structured-cloneable data.

                                                        +
                                                        • +
                                                      • Response = unknown +

                                                        Type of execution response. This can only be structured-cloneable data.

                                                        +
                                                      +
                                                      +

                                                      Hierarchy (View Summary)

                                                      +
                                                      +
                                                      +

                                                      Implements

                                                      +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      Index
                                                       +
                                                      +
                                                      + +
                                                      destroying emitter? filePath maximumNumberOfWorkers? @@ -13,12 +58,18 @@ starting workerChoiceStrategiesContext? workerNodes -

                                                      Accessors

                                                      backPressure +
                                                      +
                                                      + +
                                                      backPressure busy info type worker -

                                                      Methods

                                                      addTaskFunction +
                                                      +
                                                      + +
                                                      addTaskFunction afterTaskExecutionHook afterWorkerNodeSetup beforeTaskExecutionHook @@ -53,74 +104,760 @@ shallCreateDynamicWorker start workerMessageListener -

                                                      Properties

                                                      destroying: boolean

                                                      Whether the pool is destroying or not.

                                                      -
                                                      emitter?: EventEmitterAsyncResource
                                                      filePath: string

                                                      Path to the worker file.

                                                      -
                                                      maximumNumberOfWorkers?: number

                                                      Maximum number of workers that this pool manages.

                                                      -
                                                      minimumNumberOfWorkers: number

                                                      Minimum number of workers that this pool manages.

                                                      -
                                                      opts: PoolOptions<Worker>

                                                      Options for the pool.

                                                      -
                                                      promiseResponseMap: Map<
                                                          `${string}-${string}-${string}-${string}-${string}`,
                                                          PromiseResponseWrapper<Response>,
                                                      > = ...

                                                      The task execution response promise map:

                                                      +
                                                      +
                                                      + +
                                                      +
                                                      + +
                                                      destroying: boolean
                                                      +

                                                      Whether the pool is destroying or not.

                                                      +
                                                      +
                                                      + +
                                                      emitter?: EventEmitterAsyncResource
                                                      +
                                                      +
                                                      +
                                                      +
                                                      + +
                                                      filePath: string
                                                      +

                                                      Path to the worker file.

                                                      +
                                                      +
                                                      + +
                                                      maximumNumberOfWorkers?: number
                                                      +

                                                      Maximum number of workers that this pool manages.

                                                      +
                                                      +
                                                      + +
                                                      minimumNumberOfWorkers: number
                                                      +

                                                      Minimum number of workers that this pool manages.

                                                      +
                                                      +
                                                      + +
                                                      opts: PoolOptions<Worker>
                                                      +

                                                      Options for the pool.

                                                      +
                                                      +
                                                      + +
                                                      promiseResponseMap: Map<
                                                          `${string}-${string}-${string}-${string}-${string}`,
                                                          PromiseResponseWrapper<Response>,
                                                      > = ...
                                                      +

                                                      The task execution response promise map:

                                                      • key: The message id of each submitted task.
                                                      • value: An object that contains task's worker node key, execution response promise resolve and reject callbacks, async resource.

                                                      When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.

                                                      -
                                                      started: boolean

                                                      Whether the pool is started or not.

                                                      -
                                                      starting: boolean

                                                      Whether the pool is starting or not.

                                                      -
                                                      workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<
                                                          Worker,
                                                          Data,
                                                          Response,
                                                      >

                                                      Worker choice strategies context referencing worker choice algorithms implementation.

                                                      -
                                                      workerNodes: IWorkerNode<Worker, Data>[] = []

                                                      Accessors

                                                      • get backPressure(): boolean

                                                        Whether the pool is back pressured or not.

                                                        -

                                                        Returns boolean

                                                        The pool back pressure boolean status.

                                                        -
                                                      +
                                                      + +
                                                      started: boolean
                                                      +

                                                      Whether the pool is started or not.

                                                      +
                                                      +
                                                      + +
                                                      starting: boolean
                                                      +

                                                      Whether the pool is starting or not.

                                                      +
                                                      +
                                                      + +
                                                      workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<
                                                          Worker,
                                                          Data,
                                                          Response,
                                                      >
                                                      +

                                                      Worker choice strategies context referencing worker choice algorithms implementation.

                                                      +
                                                      +
                                                      + +
                                                      workerNodes: IWorkerNode<Worker, Data>[] = []
                                                      +
                                                      +
                                                      +
                                                      +
                                                      + +
                                                      +
                                                      + +
                                                        +
                                                      • +
                                                        get backPressure(): boolean
                                                        +
                                                        +

                                                        Whether the pool is back pressured or not.

                                                        +
                                                        +

                                                        Returns boolean

                                                        The pool back pressure boolean status.

                                                        +
                                                      +
                                                      + +
                                                        +
                                                      • +
                                                        get busy(): boolean
                                                        +
                                                        +

                                                        Whether the pool is busy or not.

                                                        +
                                                        +

                                                        Returns boolean

                                                        The pool busyness boolean status.

                                                        +
                                                      +
                                                      + +
                                                      +
                                                      + +
                                                        +
                                                      • +
                                                        get type(): "fixed" | "dynamic"
                                                        +
                                                        +

                                                        The pool type.

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

                                                        -

                                                        Returns "fixed" | "dynamic"

                                                      Methods

                                                      +
                                                      + +
                                                      +
                                                      + +
                                                      +
                                                      + +
                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +

                                                        Hook executed after the worker task execution. Can be overridden.

                                                        -

                                                        Parameters

                                                        Returns void

                                                      • Method hooked up after a worker node has been newly created. +

                                                        +
                                                        +

                                                        Parameters

                                                        +
                                                          +
                                                        • workerNodeKey: number +

                                                          The worker node key.

                                                          +
                                                          • +
                                                        • message: MessageValue<Response> +

                                                          The received message.

                                                          +
                                                        +

                                                        Returns void

                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +

                                                        Method hooked up after a worker node has been newly created. Can be overridden.

                                                        -

                                                        Parameters

                                                        • workerNodeKey: number

                                                          The newly created worker node key.

                                                          -

                                                        Returns void

                                                      • Hook executed before the worker task execution. +

                                                        +
                                                        +

                                                        Parameters

                                                        +
                                                          +
                                                        • workerNodeKey: number +

                                                          The newly created worker node key.

                                                          +
                                                        +

                                                        Returns void

                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +

                                                        Hook executed before the worker task execution. Can be overridden.

                                                        -

                                                        Parameters

                                                        • workerNodeKey: number

                                                          The worker node key.

                                                          -
                                                        • task: Task<Data>

                                                          The task to execute.

                                                          -

                                                        Returns void

                                                      • Creates a new, completely set up dynamic worker node.

                                                        -

                                                        Returns number

                                                        New, completely set up dynamic worker node key.

                                                        -

                                                      • Creates a new, completely set up worker node.

                                                        -

                                                        Returns number

                                                        New, completely set up worker node key.

                                                        -

                                                      • Deregisters a listener callback on the worker given its worker node key.

                                                        -

                                                        Type Parameters

                                                        • Message

                                                        Parameters

                                                        • workerNodeKey: number

                                                          The worker node key.

                                                          -
                                                        • listener: (message: MessageValue<Message>) => void

                                                          The message listener callback.

                                                          -

                                                        Returns void

                                                      • Terminates the worker node given its worker node key.

                                                        -

                                                        Parameters

                                                        • workerNodeKey: number

                                                          The worker node key.

                                                          -

                                                        Returns Promise<void>

                                                      • Parameters

                                                        • Optionaldata: Data
                                                        • Optionalname: string
                                                        • OptionalabortSignal: AbortSignal
                                                        • OptionaltransferList: readonly Transferable[]

                                                        Returns Promise<Response>

                                                      • Gets the worker information given its worker node key.

                                                        -

                                                        Parameters

                                                        • workerNodeKey: number

                                                          The worker node key.

                                                          -

                                                        Returns WorkerInfo | undefined

                                                        The worker information.

                                                        -

                                                      • Parameters

                                                        • name: string

                                                        Returns boolean

                                                      • Whether the worker nodes are back pressured or not.

                                                        -

                                                        Returns boolean

                                                        Worker nodes back pressure boolean status.

                                                        -

                                                      • Whether worker nodes are executing concurrently their tasks quota or not.

                                                        -

                                                        Returns boolean

                                                        Worker nodes busyness boolean status.

                                                        -

                                                      • Returns whether the worker is the main worker or not.

                                                        -

                                                        Returns boolean

                                                        true if the worker is the main worker, false otherwise.

                                                        -

                                                      • Parameters

                                                        • data: Iterable<Data>
                                                        • Optionalname: string
                                                        • OptionalabortSignals: Iterable<AbortSignal, any, any>
                                                        • OptionaltransferList: readonly Transferable[]

                                                        Returns Promise<Response[]>

                                                      • Registers once a listener callback on the worker given its worker node key.

                                                        -

                                                        Type Parameters

                                                        • Message

                                                        Parameters

                                                        • workerNodeKey: number

                                                          The worker node key.

                                                          -
                                                        • listener: (message: MessageValue<Message>) => void

                                                          The message listener callback.

                                                          -

                                                        Returns void

                                                      • Registers a listener callback on the worker given its worker node key.

                                                        -

                                                        Type Parameters

                                                        • Message

                                                        Parameters

                                                        • workerNodeKey: number

                                                          The worker node key.

                                                          -
                                                        • listener: (message: MessageValue<Message>) => void

                                                          The message listener callback.

                                                          -

                                                        Returns void

                                                      • Parameters

                                                        • name: string

                                                        Returns Promise<boolean>

                                                      • Sends the startup message to worker given its worker node key.

                                                        -

                                                        Parameters

                                                        • workerNodeKey: number

                                                          The worker node key.

                                                          -

                                                        Returns void

                                                      • Sends a message to worker given its worker node key.

                                                        -

                                                        Parameters

                                                        • workerNodeKey: number

                                                          The worker node key.

                                                          -
                                                        • message: MessageValue<Data>

                                                          The message.

                                                          -
                                                        • OptionaltransferList: readonly Transferable[]

                                                          The optional array of transferable objects.

                                                          -

                                                        Returns void

                                                      • Parameters

                                                        • name: string

                                                        Returns Promise<boolean>

                                                      • Setup hook to execute code before worker nodes are created in the abstract constructor. +

                                                        +
                                                        +

                                                        Parameters

                                                        +
                                                          +
                                                        • workerNodeKey: number +

                                                          The worker node key.

                                                          +
                                                          • +
                                                        • task: Task<Data> +

                                                          The task to execute.

                                                          +
                                                        +

                                                        Returns void

                                                      +
                                                      + +
                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +

                                                        Emits dynamic worker destruction events.

                                                        +
                                                        +

                                                        Returns void

                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +

                                                        Creates a new, completely set up dynamic worker node.

                                                        +
                                                        +

                                                        Returns number

                                                        New, completely set up dynamic worker node key.

                                                        +
                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +

                                                        Creates a new, completely set up worker node.

                                                        +
                                                        +

                                                        Returns number

                                                        New, completely set up worker node key.

                                                        +
                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +

                                                        Deregisters a listener callback on the worker given its worker node key.

                                                        +
                                                        +
                                                        +

                                                        Type Parameters

                                                        +
                                                          +
                                                        • Message
                                                        +
                                                        +

                                                        Parameters

                                                        +
                                                          +
                                                        • workerNodeKey: number +

                                                          The worker node key.

                                                          +
                                                          • +
                                                        • listener: (message: MessageValue<Message>) => void +

                                                          The message listener callback.

                                                          +
                                                        +

                                                        Returns void

                                                      +
                                                      + +
                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +

                                                        Terminates the worker node given its worker node key.

                                                        +
                                                        +
                                                        +

                                                        Parameters

                                                        +
                                                          +
                                                        • workerNodeKey: number +

                                                          The worker node key.

                                                          +
                                                        +

                                                        Returns Promise<void>

                                                      +
                                                      + +
                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +
                                                        +

                                                        Parameters

                                                        +
                                                          +
                                                        • Optionaldata: Data
                                                          • +
                                                        • Optionalname: string
                                                          • +
                                                        • OptionalabortSignal: AbortSignal
                                                          • +
                                                        • OptionaltransferList: readonly Transferable[]
                                                        +

                                                        Returns Promise<Response>

                                                        +
                                                        +
                                                        +
                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +
                                                        +

                                                        Parameters

                                                        +
                                                          +
                                                        • workerNodeKey: number
                                                        +

                                                        Returns void

                                                      +
                                                      + +
                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +

                                                        Gets the worker information given its worker node key.

                                                        +
                                                        +
                                                        +

                                                        Parameters

                                                        +
                                                          +
                                                        • workerNodeKey: number +

                                                          The worker node key.

                                                          +
                                                        +

                                                        Returns WorkerInfo | undefined

                                                        The worker information.

                                                        +
                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +
                                                        +

                                                        Parameters

                                                        +
                                                          +
                                                        • name: string
                                                        +

                                                        Returns boolean

                                                        +
                                                        +
                                                        +
                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +

                                                        Whether the worker nodes are back pressured or not.

                                                        +
                                                        +

                                                        Returns boolean

                                                        Worker nodes back pressure boolean status.

                                                        +
                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +

                                                        Whether worker nodes are executing concurrently their tasks quota or not.

                                                        +
                                                        +

                                                        Returns boolean

                                                        Worker nodes busyness boolean status.

                                                        +
                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +

                                                        Returns whether the worker is the main worker or not.

                                                        +
                                                        +

                                                        Returns boolean

                                                        true if the worker is the main worker, false otherwise.

                                                        +
                                                      +
                                                      + +
                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +
                                                        +

                                                        Parameters

                                                        +
                                                          +
                                                        • data: Iterable<Data>
                                                          • +
                                                        • Optionalname: string
                                                          • +
                                                        • OptionalabortSignals: Iterable<AbortSignal, any, any>
                                                          • +
                                                        • OptionaltransferList: readonly Transferable[]
                                                        +

                                                        Returns Promise<Response[]>

                                                        +
                                                        +
                                                        +
                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +

                                                        Registers once a listener callback on the worker given its worker node key.

                                                        +
                                                        +
                                                        +

                                                        Type Parameters

                                                        +
                                                          +
                                                        • Message
                                                        +
                                                        +

                                                        Parameters

                                                        +
                                                          +
                                                        • workerNodeKey: number +

                                                          The worker node key.

                                                          +
                                                          • +
                                                        • listener: (message: MessageValue<Message>) => void +

                                                          The message listener callback.

                                                          +
                                                        +

                                                        Returns void

                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +

                                                        Registers a listener callback on the worker given its worker node key.

                                                        +
                                                        +
                                                        +

                                                        Type Parameters

                                                        +
                                                          +
                                                        • Message
                                                        +
                                                        +

                                                        Parameters

                                                        +
                                                          +
                                                        • workerNodeKey: number +

                                                          The worker node key.

                                                          +
                                                          • +
                                                        • listener: (message: MessageValue<Message>) => void +

                                                          The message listener callback.

                                                          +
                                                        +

                                                        Returns void

                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +
                                                        +

                                                        Parameters

                                                        +
                                                          +
                                                        • name: string
                                                        +

                                                        Returns Promise<boolean>

                                                        +
                                                        +
                                                        +
                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +

                                                        Sends the startup message to worker given its worker node key.

                                                        +
                                                        +
                                                        +

                                                        Parameters

                                                        +
                                                          +
                                                        • workerNodeKey: number +

                                                          The worker node key.

                                                          +
                                                        +

                                                        Returns void

                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +

                                                        Sends a message to worker given its worker node key.

                                                        +
                                                        +
                                                        +

                                                        Parameters

                                                        +
                                                          +
                                                        • workerNodeKey: number +

                                                          The worker node key.

                                                          +
                                                          • +
                                                        • message: MessageValue<Data> +

                                                          The message.

                                                          +
                                                          • +
                                                        • OptionaltransferList: readonly Transferable[] +

                                                          The optional array of transferable objects.

                                                          +
                                                        +

                                                        Returns void

                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +
                                                        +

                                                        Parameters

                                                        +
                                                          +
                                                        • name: string
                                                        +

                                                        Returns Promise<boolean>

                                                        +
                                                        +
                                                        +
                                                      +
                                                      + +
                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +

                                                        Setup hook to execute code before worker nodes are created in the abstract constructor. Can be overridden.

                                                        -

                                                        Returns void

                                                      • Parameters

                                                        • workerChoiceStrategy:
                                                              | "FAIR_SHARE"
                                                              | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                              | "LEAST_BUSY"
                                                              | "LEAST_ELU"
                                                              | "LEAST_USED"
                                                              | "ROUND_ROBIN"
                                                              | "WEIGHTED_ROUND_ROBIN"
                                                        • OptionalworkerChoiceStrategyOptions: WorkerChoiceStrategyOptions

                                                        Returns void

                                                      • Conditions for dynamic worker creation.

                                                        -

                                                        Returns boolean

                                                        Whether to create a dynamic worker or not.

                                                        -

                                                      Settings

                                                      Member Visibility

                                                      On This Page

                                                      Properties
                                                      Accessors
                                                      Methods
                                                      + +

                                                      Returns void

                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +
                                                        +

                                                        Parameters

                                                        +
                                                          +
                                                        • workerChoiceStrategy:
                                                              | "FAIR_SHARE"
                                                              | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                              | "LEAST_BUSY"
                                                              | "LEAST_ELU"
                                                              | "LEAST_USED"
                                                              | "ROUND_ROBIN"
                                                              | "WEIGHTED_ROUND_ROBIN"
                                                          • +
                                                        • OptionalworkerChoiceStrategyOptions: WorkerChoiceStrategyOptions
                                                        +

                                                        Returns void

                                                        +
                                                        +
                                                        +
                                                      +
                                                      + +
                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +

                                                        Conditions for dynamic worker creation.

                                                        +
                                                        +

                                                        Returns boolean

                                                        Whether to create a dynamic worker or not.

                                                        +
                                                      +
                                                      + +
                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +

                                                        This method is the message listener registered on each worker.

                                                        +
                                                        +
                                                        +

                                                        Parameters

                                                        +
                                                          +
                                                        • message: MessageValue<Response> +

                                                          The message received from the worker.

                                                          +
                                                        +

                                                        Returns void

                                                      +
                                                      +
                                                      +
                                                      +
                                                      +

                                                      Settings

                                                       +
                                                      +
                                                      Member Visibility +
                                                        +
                                                        • +
                                                        • +
                                                      +
                                                      +
                                                      +

                                                      On This Page

                                                       +
                                                      +
                                                      Properties +
                                                      +
                                                      Accessors +
                                                      +
                                                      Methods +
                                                      +
                                                      +
                                                      +
                                                      diff --git a/docs/interfaces/src.AbstractWorker.html b/docs/interfaces/src.AbstractWorker.html index 687e20a0a..5dff1d852 100644 --- a/docs/interfaces/src.AbstractWorker.html +++ b/docs/interfaces/src.AbstractWorker.html @@ -1,8 +1,49 @@ -AbstractWorker | poolifier - v5.3.2
                                                      poolifier - v5.3.2
                                                        Preparing search index...

                                                        Interface AbstractWorker<MainWorker, Data, Response>Abstract

                                                        Base class that implements some shared logic for all poolifier workers.

                                                        -
                                                        interface AbstractWorker<
                                                            MainWorker extends MessagePort
                                                            | Worker,
                                                            Data = unknown,
                                                            Response = unknown,
                                                        > {
                                                            activeInterval?: Timeout;
                                                            id: number;
                                                            isMain: boolean | undefined;
                                                            lastTaskTimestamp: number;
                                                            opts: WorkerOptions;
                                                            statistics?: WorkerStatistics;
                                                            taskAbortFunctions: Map<
                                                                `${string}-${string}-${string}-${string}-${string}`,
                                                                () => void,
                                                            >;
                                                            taskFunctions: Map<string, TaskFunctionObject<Data, Response>>;
                                                            addTaskFunction(
                                                                name: string,
                                                                fn: TaskFunctionObject<Data, Response> | TaskFunction<Data, Response>,
                                                            ): TaskFunctionOperationResult;
                                                            getMainWorker(): MainWorker;
                                                            handleError(
                                                                error: Error,
                                                            ): { aborted: boolean; error?: Error; message: string; stack?: string };
                                                            handleKillMessage(message: MessageValue<Data>): void;
                                                            handleReadyMessage(message: MessageValue<Data>): void;
                                                            handleTaskFunctionOperationMessage(message: MessageValue<Data>): void;
                                                            hasTaskFunction(name: string): TaskFunctionOperationResult;
                                                            listTaskFunctionsProperties(): TaskFunctionProperties[];
                                                            messageListener(message: MessageValue<Data>): void;
                                                            removeTaskFunction(name: string): TaskFunctionOperationResult;
                                                            run(task: Task<Data>): void;
                                                            runAsync(fn: TaskAsyncFunction<Data, Response>, task: Task<Data>): void;
                                                            runSync(fn: TaskSyncFunction<Data, Response>, task: Task<Data>): void;
                                                            sendTaskFunctionsPropertiesToMainWorker(): void;
                                                            sendToMainWorker(message: MessageValue<Response, Data>): void;
                                                            setDefaultTaskFunction(name: string): TaskFunctionOperationResult;
                                                        }

                                                        Type Parameters

                                                        • MainWorker extends MessagePort | Worker

                                                          Type of main worker.

                                                          -
                                                        • Data = unknown

                                                          Type of data this worker receives from pool's execution. This can only be structured-cloneable data.

                                                          -
                                                        • Response = unknown

                                                          Type of response the worker sends back to the main worker. This can only be structured-cloneable data.

                                                          -

                                                        Hierarchy (View Summary)

                                                        Index

                                                        Properties

                                                        activeInterval? +AbstractWorker | poolifier - v5.4.0
                                                        +
                                                        poolifier - v5.4.0 + +
                                                          +
                                                          +
                                                          Preparing search index...
                                                          +
                                                          +
                                                          +
                                                          + +

                                                          Interface AbstractWorker<MainWorker, Data, Response>Abstract

                                                          +
                                                          +

                                                          Base class that implements some shared logic for all poolifier workers.

                                                          +
                                                          +
                                                          interface AbstractWorker<
                                                              MainWorker extends MessagePort
                                                              | Worker,
                                                              Data = unknown,
                                                              Response = unknown,
                                                          > {
                                                              activeInterval?: Timeout;
                                                              id: number;
                                                              isMain: boolean | undefined;
                                                              lastTaskTimestamp: number;
                                                              opts: WorkerOptions;
                                                              statistics?: WorkerStatistics;
                                                              taskAbortFunctions: Map<
                                                                  `${string}-${string}-${string}-${string}-${string}`,
                                                                  () => void,
                                                              >;
                                                              taskFunctions: Map<string, TaskFunctionObject<Data, Response>>;
                                                              addTaskFunction(
                                                                  name: string,
                                                                  fn: TaskFunctionObject<Data, Response> | TaskFunction<Data, Response>,
                                                              ): TaskFunctionOperationResult;
                                                              getMainWorker(): MainWorker;
                                                              handleError(
                                                                  error: Error,
                                                              ): { aborted: boolean; error?: Error; message: string; stack?: string };
                                                              handleKillMessage(message: MessageValue<Data>): void;
                                                              handleReadyMessage(message: MessageValue<Data>): void;
                                                              handleTaskFunctionOperationMessage(message: MessageValue<Data>): void;
                                                              hasTaskFunction(name: string): TaskFunctionOperationResult;
                                                              listTaskFunctionsProperties(): TaskFunctionProperties[];
                                                              messageListener(message: MessageValue<Data>): void;
                                                              removeTaskFunction(name: string): TaskFunctionOperationResult;
                                                              run(task: Task<Data>): void;
                                                              runAsync(fn: TaskAsyncFunction<Data, Response>, task: Task<Data>): void;
                                                              runSync(fn: TaskSyncFunction<Data, Response>, task: Task<Data>): void;
                                                              sendTaskFunctionsPropertiesToMainWorker(): void;
                                                              sendToMainWorker(message: MessageValue<Response, Data>): void;
                                                              setDefaultTaskFunction(name: string): TaskFunctionOperationResult;
                                                          }
                                                          +
                                                          +

                                                          Type Parameters

                                                          +
                                                            +
                                                          • MainWorker extends MessagePort | Worker +

                                                            Type of main worker.

                                                            +
                                                            • +
                                                          • Data = unknown +

                                                            Type of data this worker receives from pool's execution. This can only be structured-cloneable data.

                                                            +
                                                            • +
                                                          • Response = unknown +

                                                            Type of response the worker sends back to the main worker. This can only be structured-cloneable data.

                                                            +
                                                          +
                                                          +

                                                          Hierarchy (View Summary)

                                                          +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          Index
                                                           +
                                                          +
                                                          + +
                                                          activeInterval? id isMain lastTaskTimestamp @@ -10,7 +51,10 @@ statistics? taskAbortFunctions taskFunctions -

                                                          Methods

                                                          addTaskFunction +
                                                          +
                                                          + +
                                                          addTaskFunction getMainWorker handleError handleKillMessage @@ -26,51 +70,362 @@ sendTaskFunctionsPropertiesToMainWorker sendToMainWorker setDefaultTaskFunction -

                                                          Properties

                                                          activeInterval?: Timeout

                                                          Handler id of the activeInterval worker activity check.

                                                          -
                                                          id: number

                                                          Worker id.

                                                          -
                                                          isMain: boolean | undefined

                                                          Whether this is the main worker or not.

                                                          -
                                                          lastTaskTimestamp: number

                                                          Timestamp of the last task processed by this worker.

                                                          -
                                                          opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

                                                          Options for the worker.

                                                          -
                                                          statistics?: WorkerStatistics

                                                          Performance statistics computation requirements.

                                                          -
                                                          taskAbortFunctions: Map<
                                                              `${string}-${string}-${string}-${string}-${string}`,
                                                              () => void,
                                                          >

                                                          Task abort functions processed by the worker when task operation 'abort' is received.

                                                          -
                                                          taskFunctions: Map<string, TaskFunctionObject<Data, Response>>

                                                          Task function object(s) processed by the worker when the pool's execute method is invoked.

                                                          -

                                                          Methods

                                                          +
                                                          + +
                                                          +
                                                          + +
                                                          activeInterval?: Timeout
                                                          +

                                                          Handler id of the activeInterval worker activity check.

                                                          +
                                                          +
                                                          + +
                                                          id: number
                                                          +

                                                          Worker id.

                                                          +
                                                          +
                                                          + +
                                                          isMain: boolean | undefined
                                                          +

                                                          Whether this is the main worker or not.

                                                          +
                                                          +
                                                          + +
                                                          lastTaskTimestamp: number
                                                          +

                                                          Timestamp of the last task processed by this worker.

                                                          +
                                                          +
                                                          + +
                                                          opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
                                                          +

                                                          Options for the worker.

                                                          +
                                                          +
                                                          + +
                                                          statistics?: WorkerStatistics
                                                          +

                                                          Performance statistics computation requirements.

                                                          +
                                                          +
                                                          + +
                                                          taskAbortFunctions: Map<
                                                              `${string}-${string}-${string}-${string}-${string}`,
                                                              () => void,
                                                          >
                                                          +

                                                          Task abort functions processed by the worker when task operation 'abort' is received.

                                                          +
                                                          +
                                                          + +
                                                          taskFunctions: Map<string, TaskFunctionObject<Data, Response>>
                                                          +

                                                          Task function object(s) processed by the worker when the pool's execute method is invoked.

                                                          +
                                                          +
                                                          + +
                                                          +
                                                          + +

                                                          • Handles a worker error.

                                                            -

                                                            Parameters

                                                            • error: Error

                                                              The error raised by the worker.

                                                              -

                                                            Returns { aborted: boolean; error?: Error; message: string; stack?: string }

                                                            The worker error object.

                                                            -

                                                          Settings

                                                          Member Visibility

                                                          On This Page

                                                          Properties
                                                          Methods
                                                          + +
                                                          +

                                                          Parameters

                                                          +
                                                          +

                                                          Returns TaskFunctionOperationResult

                                                          Whether the task function was added or not.

                                                          + +
                                                          + +
                                                          +
                                                          + +
                                                            +
                                                          • + +
                                                            +

                                                            Handles a worker error.

                                                            +
                                                            +
                                                            +

                                                            Parameters

                                                            +
                                                              +
                                                            • error: Error +

                                                              The error raised by the worker.

                                                              +
                                                            +

                                                            Returns { aborted: boolean; error?: Error; message: string; stack?: string }

                                                            The worker error object.

                                                            +
                                                          +
                                                          + +
                                                            +
                                                          • + +
                                                            +

                                                            Handles a kill message sent by the main worker.

                                                            +
                                                            +
                                                            +

                                                            Parameters

                                                            +
                                                              +
                                                            • message: MessageValue<Data> +

                                                              The kill message.

                                                              +
                                                            +

                                                            Returns void

                                                          +
                                                          + +
                                                            +
                                                          • + +
                                                            +

                                                            Handles the ready message sent by the main worker.

                                                            +
                                                            +
                                                            +

                                                            Parameters

                                                            +
                                                              +
                                                            • message: MessageValue<Data> +

                                                              The ready message.

                                                              +
                                                            +

                                                            Returns void

                                                          +
                                                          + +
                                                          +
                                                          + +
                                                          +
                                                          + +
                                                          +
                                                          + +
                                                            +
                                                          • + +
                                                            +

                                                            Worker message listener.

                                                            +
                                                            +
                                                            +

                                                            Parameters

                                                            +
                                                              +
                                                            • message: MessageValue<Data> +

                                                              The received message.

                                                              +
                                                            +

                                                            Returns void

                                                          +
                                                          + +
                                                          +
                                                          + +
                                                          +
                                                          + +
                                                          +
                                                          + +
                                                          +
                                                          + +
                                                            +
                                                          • + +
                                                            +

                                                            Sends task functions properties to the main worker.

                                                            +
                                                            +

                                                            Returns void

                                                          +
                                                          + +
                                                          +
                                                          + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +

                                                          Settings

                                                           +
                                                          +
                                                          Member Visibility +
                                                            +
                                                            • +
                                                            • +
                                                          +
                                                          +
                                                          +

                                                          On This Page

                                                           +
                                                          +
                                                          Properties +
                                                          +
                                                          Methods +
                                                          +
                                                          +
                                                          +
                                                          diff --git a/docs/interfaces/src.CircularBuffer.html b/docs/interfaces/src.CircularBuffer.html deleted file mode 100644 index 8142fdefa..000000000 --- a/docs/interfaces/src.CircularBuffer.html +++ /dev/null @@ -1,20 +0,0 @@ -CircularBuffer | poolifier - v5.3.2
                                                          poolifier - v5.3.2
                                                            Preparing search index...

                                                            Interface CircularBufferInternal

                                                            Circular buffer designed for numbers.

                                                            -
                                                            interface CircularBuffer {
                                                                size: number;
                                                                clear(): void;
                                                                empty(): boolean;
                                                                full(): boolean;
                                                                get(): number | undefined;
                                                                put(number: number): void;
                                                                toArray(): number[];
                                                            }
                                                            Index

                                                            Properties

                                                            size -

                                                            Methods

                                                            clear -empty -full -get -put -toArray -

                                                            Properties

                                                            size: number

                                                            Methods

                                                            • Checks whether the buffer is empty.

                                                              -

                                                              Returns boolean

                                                              Whether the buffer is empty.

                                                              -

                                                            • Checks whether the buffer is full.

                                                              -

                                                              Returns boolean

                                                              Whether the buffer is full.

                                                              -

                                                            • Gets number from buffer.

                                                              -

                                                              Returns number | undefined

                                                              Number from buffer.

                                                              -

                                                            • Puts number into buffer.

                                                              -

                                                              Parameters

                                                              • number: number

                                                                Number to put into buffer.

                                                                -

                                                              Returns void

                                                            Settings

                                                            Member Visibility

                                                            On This Page

                                                            Properties
                                                            Methods
                                                            diff --git a/docs/interfaces/src.EventLoopUtilizationMeasurementStatistics.html b/docs/interfaces/src.EventLoopUtilizationMeasurementStatistics.html deleted file mode 100644 index 5843c016b..000000000 --- a/docs/interfaces/src.EventLoopUtilizationMeasurementStatistics.html +++ /dev/null @@ -1,6 +0,0 @@ -EventLoopUtilizationMeasurementStatistics | poolifier - v5.3.2
                                                            poolifier - v5.3.2
                                                              Preparing search index...

                                                              Interface EventLoopUtilizationMeasurementStatisticsInternal

                                                              Event loop utilization measurement statistics.

                                                              -
                                                              interface EventLoopUtilizationMeasurementStatistics {
                                                                  active: MeasurementStatistics;
                                                                  count?: number;
                                                                  idle: MeasurementStatistics;
                                                                  utilization?: number;
                                                              }
                                                              Index

                                                              Properties

                                                              active -count? -idle -utilization? -

                                                              Properties

                                                              active: MeasurementStatistics
                                                              count?: number
                                                              idle: MeasurementStatistics
                                                              utilization?: number

                                                              Settings

                                                              Member Visibility

                                                              On This Page

                                                              Properties
                                                              diff --git a/docs/interfaces/src.FixedQueueNode.html b/docs/interfaces/src.FixedQueueNode.html deleted file mode 100644 index 9ba646feb..000000000 --- a/docs/interfaces/src.FixedQueueNode.html +++ /dev/null @@ -1,6 +0,0 @@ -FixedQueueNode | poolifier - v5.3.2
                                                              poolifier - v5.3.2
                                                                Preparing search index...

                                                                Interface FixedQueueNode<T>Internal

                                                                Fixed queue node.

                                                                -
                                                                interface FixedQueueNode<T> {
                                                                    data: T;
                                                                    priority: number;
                                                                    timestamp: number;
                                                                }

                                                                Type Parameters

                                                                • T

                                                                  Type of fixed queue node data.

                                                                  -
                                                                Index

                                                                Properties

                                                                data -priority -timestamp -

                                                                Properties

                                                                data: T
                                                                priority: number
                                                                timestamp: number

                                                                Settings

                                                                Member Visibility

                                                                On This Page

                                                                Properties
                                                                diff --git a/docs/interfaces/src.IFixedQueue.html b/docs/interfaces/src.IFixedQueue.html deleted file mode 100644 index aa04b718a..000000000 --- a/docs/interfaces/src.IFixedQueue.html +++ /dev/null @@ -1,38 +0,0 @@ -IFixedQueue | poolifier - v5.3.2
                                                                poolifier - v5.3.2
                                                                  Preparing search index...

                                                                  Interface IFixedQueue<T>Internal

                                                                  Fixed queue.

                                                                  -
                                                                  interface IFixedQueue<T> {
                                                                      "[iterator]": () => Iterator<T>;
                                                                      capacity: number;
                                                                      clear: () => void;
                                                                      delete: (data: T) => boolean;
                                                                      dequeue: () => T | undefined;
                                                                      empty: () => boolean;
                                                                      enqueue: (data: T, priority?: number) => number;
                                                                      full: () => boolean;
                                                                      get: (index: number) => T | undefined;
                                                                      nodeArray: (FixedQueueNode<T> | undefined)[];
                                                                      size: number;
                                                                  }

                                                                  Type Parameters

                                                                  • T

                                                                    Type of fixed queue data.

                                                                    -
                                                                  Index

                                                                  Properties

                                                                  [iterator] -capacity -clear -delete -dequeue -empty -enqueue -full -get -nodeArray -size -

                                                                  Properties

                                                                  "[iterator]": () => Iterator<T>

                                                                  Returns an iterator for the fixed queue.

                                                                  -

                                                                  Type Declaration

                                                                    • (): Iterator<T>

                                                                    • Returns Iterator<T>

                                                                      An iterator for the fixed queue.

                                                                      -

                                                                  https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols

                                                                  -
                                                                  capacity: number

                                                                  The fixed queue capacity.

                                                                  -
                                                                  clear: () => void

                                                                  Clears the fixed queue.

                                                                  -
                                                                  delete: (data: T) => boolean

                                                                  Deletes the given data from the fixed priority queue.

                                                                  -

                                                                  Type Declaration

                                                                    • (data: T): boolean

                                                                    • Parameters

                                                                      • data: T

                                                                        Data to delete.

                                                                        -

                                                                      Returns boolean

                                                                      true if the data was deleted, false otherwise.

                                                                      -
                                                                  dequeue: () => T | undefined

                                                                  Dequeue data from the fixed queue.

                                                                  -

                                                                  Type Declaration

                                                                    • (): T | undefined

                                                                    • Returns T | undefined

                                                                      The dequeued data or undefined if the fixed queue is empty.

                                                                      -
                                                                  empty: () => boolean

                                                                  Checks if the fixed queue is empty.

                                                                  -

                                                                  Type Declaration

                                                                    • (): boolean

                                                                    • Returns boolean

                                                                      true if the fixed queue is empty, false otherwise.

                                                                      -
                                                                  enqueue: (data: T, priority?: number) => number

                                                                  Enqueue data into the fixed queue.

                                                                  -

                                                                  Type Declaration

                                                                    • (data: T, priority?: number): number

                                                                    • Parameters

                                                                      • data: T

                                                                        Data to enqueue.

                                                                        -
                                                                      • Optionalpriority: number

                                                                        Priority of the data. Lower values have higher priority.

                                                                        -

                                                                      Returns number

                                                                      The new size of the fixed queue.

                                                                      -

                                                                  If the fixed queue is full.

                                                                  -
                                                                  full: () => boolean

                                                                  Checks if the fixed queue is full.

                                                                  -

                                                                  Type Declaration

                                                                    • (): boolean

                                                                    • Returns boolean

                                                                      true if the fixed queue is full, false otherwise.

                                                                      -
                                                                  get: (index: number) => T | undefined

                                                                  Gets data from the fixed queue.

                                                                  -

                                                                  Type Declaration

                                                                    • (index: number): T | undefined

                                                                    • Parameters

                                                                      • index: number

                                                                        The index of the data to get.

                                                                        -

                                                                      Returns T | undefined

                                                                      The data at the index or undefined if the fixed queue is empty or the index is out of bounds.

                                                                      -
                                                                  nodeArray: (FixedQueueNode<T> | undefined)[]

                                                                  The fixed queue node array.

                                                                  -
                                                                  size: number

                                                                  The fixed queue size.

                                                                  -

                                                                  Settings

                                                                  Member Visibility

                                                                  On This Page

                                                                  Properties
                                                                  diff --git a/docs/interfaces/src.IPool.html b/docs/interfaces/src.IPool.html index 84a080228..1847051c3 100644 --- a/docs/interfaces/src.IPool.html +++ b/docs/interfaces/src.IPool.html @@ -1,8 +1,46 @@ -IPool | poolifier - v5.3.2
                                                                  poolifier - v5.3.2
                                                                    Preparing search index...

                                                                    Interface IPool<Worker, Data, Response>

                                                                    Contract definition for a poolifier pool.

                                                                    -
                                                                    interface IPool<Worker extends IWorker, Data = unknown, Response = unknown> {
                                                                        addTaskFunction: (
                                                                            name: string,
                                                                            fn: TaskFunction<Data, Response> | TaskFunctionObject<Data, Response>,
                                                                        ) => Promise<boolean>;
                                                                        destroy: () => Promise<void>;
                                                                        emitter?: EventEmitterAsyncResource;
                                                                        enableTasksQueue: (
                                                                            enable: boolean,
                                                                            tasksQueueOptions?: TasksQueueOptions,
                                                                        ) => void;
                                                                        execute: (
                                                                            data?: Data,
                                                                            name?: string,
                                                                            abortSignal?: AbortSignal,
                                                                            transferList?: readonly Transferable[],
                                                                        ) => Promise<Response>;
                                                                        hasTaskFunction: (name: string) => boolean;
                                                                        info: PoolInfo;
                                                                        listTaskFunctionsProperties: () => TaskFunctionProperties[];
                                                                        mapExecute: (
                                                                            data: Iterable<Data>,
                                                                            name?: string,
                                                                            abortSignals?: Iterable<AbortSignal, any, any>,
                                                                            transferList?: readonly Transferable[],
                                                                        ) => Promise<Response[]>;
                                                                        removeTaskFunction: (name: string) => Promise<boolean>;
                                                                        setDefaultTaskFunction: (name: string) => Promise<boolean>;
                                                                        setTasksQueueOptions: (tasksQueueOptions: TasksQueueOptions) => void;
                                                                        setWorkerChoiceStrategy: (
                                                                            workerChoiceStrategy:
                                                                                | "FAIR_SHARE"
                                                                                | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                | "LEAST_BUSY"
                                                                                | "LEAST_ELU"
                                                                                | "LEAST_USED"
                                                                                | "ROUND_ROBIN"
                                                                                | "WEIGHTED_ROUND_ROBIN",
                                                                            workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions,
                                                                        ) => void;
                                                                        setWorkerChoiceStrategyOptions: (
                                                                            workerChoiceStrategyOptions: WorkerChoiceStrategyOptions,
                                                                        ) => boolean;
                                                                        start: () => void;
                                                                        workerNodes: IWorkerNode<Worker, Data>[];
                                                                    }

                                                                    Type Parameters

                                                                    • Worker extends IWorker

                                                                      Type of worker which manages this pool.

                                                                      -
                                                                    • Data = unknown

                                                                      Type of data sent to the worker. This can only be structured-cloneable data.

                                                                      -
                                                                    • Response = unknown

                                                                      Type of execution response. This can only be structured-cloneable data.

                                                                      -

                                                                    Implemented by

                                                                    Index

                                                                    Properties

                                                                    addTaskFunction +IPool | poolifier - v5.4.0
                                                                    +
                                                                    poolifier - v5.4.0 + +
                                                                      +
                                                                      +
                                                                      Preparing search index...
                                                                      +
                                                                      +
                                                                      +
                                                                      + +

                                                                      Interface IPool<Worker, Data, Response>

                                                                      +
                                                                      +

                                                                      Contract definition for a poolifier pool.

                                                                      +
                                                                      +
                                                                      interface IPool<Worker extends IWorker, Data = unknown, Response = unknown> {
                                                                          addTaskFunction: (
                                                                              name: string,
                                                                              fn: TaskFunction<Data, Response> | TaskFunctionObject<Data, Response>,
                                                                          ) => Promise<boolean>;
                                                                          destroy: () => Promise<void>;
                                                                          emitter?: EventEmitterAsyncResource;
                                                                          enableTasksQueue: (
                                                                              enable: boolean,
                                                                              tasksQueueOptions?: TasksQueueOptions,
                                                                          ) => void;
                                                                          execute: (
                                                                              data?: Data,
                                                                              name?: string,
                                                                              abortSignal?: AbortSignal,
                                                                              transferList?: readonly Transferable[],
                                                                          ) => Promise<Response>;
                                                                          hasTaskFunction: (name: string) => boolean;
                                                                          info: PoolInfo;
                                                                          listTaskFunctionsProperties: () => TaskFunctionProperties[];
                                                                          mapExecute: (
                                                                              data: Iterable<Data>,
                                                                              name?: string,
                                                                              abortSignals?: Iterable<AbortSignal, any, any>,
                                                                              transferList?: readonly Transferable[],
                                                                          ) => Promise<Response[]>;
                                                                          removeTaskFunction: (name: string) => Promise<boolean>;
                                                                          setDefaultTaskFunction: (name: string) => Promise<boolean>;
                                                                          setTasksQueueOptions: (tasksQueueOptions: TasksQueueOptions) => void;
                                                                          setWorkerChoiceStrategy: (
                                                                              workerChoiceStrategy:
                                                                                  | "FAIR_SHARE"
                                                                                  | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                  | "LEAST_BUSY"
                                                                                  | "LEAST_ELU"
                                                                                  | "LEAST_USED"
                                                                                  | "ROUND_ROBIN"
                                                                                  | "WEIGHTED_ROUND_ROBIN",
                                                                              workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions,
                                                                          ) => void;
                                                                          setWorkerChoiceStrategyOptions: (
                                                                              workerChoiceStrategyOptions: WorkerChoiceStrategyOptions,
                                                                          ) => boolean;
                                                                          start: () => void;
                                                                      }
                                                                      +
                                                                      +

                                                                      Type Parameters

                                                                      +
                                                                        +
                                                                      • Worker extends IWorker +

                                                                        Type of worker which manages this pool.

                                                                        +
                                                                        • +
                                                                      • Data = unknown +

                                                                        Type of data sent to the worker. This can only be structured-cloneable data.

                                                                        +
                                                                        • +
                                                                      • Response = unknown +

                                                                        Type of execution response. This can only be structured-cloneable data.

                                                                        +
                                                                      +
                                                                      +

                                                                      Implemented by

                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      Index
                                                                       +
                                                                      +
                                                                      + +
                                                                      addTaskFunction destroy emitter? enableTasksQueue @@ -17,16 +55,54 @@ setWorkerChoiceStrategy setWorkerChoiceStrategyOptions start -workerNodes -

                                                                      Properties

                                                                      addTaskFunction: (
                                                                          name: string,
                                                                          fn: TaskFunction<Data, Response> | TaskFunctionObject<Data, Response>,
                                                                      ) => Promise<boolean>

                                                                      Adds a task function to this pool. +

                                                                      +
                                                                      + +
                                                                      +
                                                                      + +
                                                                      addTaskFunction: (
                                                                          name: string,
                                                                          fn: TaskFunction<Data, Response> | TaskFunctionObject<Data, Response>,
                                                                      ) => Promise<boolean>
                                                                      +

                                                                      Adds a task function to this pool. If a task function with the same name already exists, it will be overwritten.

                                                                      -

                                                                      Type Declaration

                                                                      If the name parameter is not a string or an empty string.

                                                                      -

                                                                      If the fn parameter is not a function or task function object.

                                                                      -
                                                                      destroy: () => Promise<void>

                                                                      Terminates all workers in this pool.

                                                                      -
                                                                      emitter?: EventEmitterAsyncResource

                                                                      Pool event emitter integrated with async resource. +

                                                                      +
                                                                      +

                                                                      Type Declaration

                                                                      +
                                                                      +
                                                                      +
                                                                      +

                                                                      If the name parameter is not a string or an empty string.

                                                                      +
                                                                      +
                                                                      +

                                                                      If the fn parameter is not a function or task function object.

                                                                      +
                                                                      +
                                                                      + +
                                                                      destroy: () => Promise<void>
                                                                      +

                                                                      Terminates all workers in this pool.

                                                                      +
                                                                      +
                                                                      + +
                                                                      emitter?: EventEmitterAsyncResource
                                                                      +

                                                                      Pool event emitter integrated with async resource. The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

                                                                      Events that can currently be listened to:

                                                                        @@ -42,41 +118,278 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
                                                                      • 'backPressure': Emitted when the number of workers created in the pool has reached the maximum size expected and are back pressured (i.e. their tasks queue is full: queue size >= maximum queue size).
                                                                      • 'backPressureEnd': Emitted when the number of workers created in the pool has reached the maximum size expected and are no longer back pressured (i.e. their tasks queue is no longer full: queue size < maximum queue size).
                                                                      -
                                                                      enableTasksQueue: (
                                                                          enable: boolean,
                                                                          tasksQueueOptions?: TasksQueueOptions,
                                                                      ) => void

                                                                      Enables/disables the worker node tasks queue in this pool.

                                                                      -

                                                                      Type Declaration

                                                                        • (enable: boolean, tasksQueueOptions?: TasksQueueOptions): void

                                                                        • Parameters

                                                                          • enable: boolean

                                                                            Whether to enable or disable the worker node tasks queue.

                                                                            -
                                                                          • OptionaltasksQueueOptions: TasksQueueOptions

                                                                            The worker node tasks queue options.

                                                                            -

                                                                          Returns void

                                                                      execute: (
                                                                          data?: Data,
                                                                          name?: string,
                                                                          abortSignal?: AbortSignal,
                                                                          transferList?: readonly Transferable[],
                                                                      ) => Promise<Response>

                                                                      Executes the specified function in the worker constructor with the task data input parameter.

                                                                      -

                                                                      Type Declaration

                                                                        • (
                                                                              data?: Data,
                                                                              name?: string,
                                                                              abortSignal?: AbortSignal,
                                                                              transferList?: readonly Transferable[],
                                                                          ): Promise<Response>

                                                                        • Parameters

                                                                          • Optionaldata: Data

                                                                            The optional task input data for the specified task function. This can only be structured-cloneable data.

                                                                            -
                                                                          • Optionalname: string

                                                                            The optional name of the task function to execute. If not specified, the default task function will be executed.

                                                                            -
                                                                          • OptionalabortSignal: AbortSignal

                                                                            The optional AbortSignal to abort the task.

                                                                            -
                                                                          • OptionaltransferList: readonly Transferable[]

                                                                            The optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards.

                                                                            -

                                                                          Returns Promise<Response>

                                                                          Promise with a task function response that will be fulfilled when the task is completed.

                                                                          -
                                                                      hasTaskFunction: (name: string) => boolean

                                                                      Whether the specified task function exists in this pool.

                                                                      -

                                                                      Type Declaration

                                                                        • (name: string): boolean

                                                                        • Parameters

                                                                          • name: string

                                                                            The name of the task function.

                                                                            -

                                                                          Returns boolean

                                                                          true if the task function exists, false otherwise.

                                                                          -
                                                                      info: PoolInfo

                                                                      Pool information.

                                                                      -
                                                                      listTaskFunctionsProperties: () => TaskFunctionProperties[]

                                                                      Lists the properties of task functions available in this pool.

                                                                      -

                                                                      Type Declaration

                                                                      mapExecute: (
                                                                          data: Iterable<Data>,
                                                                          name?: string,
                                                                          abortSignals?: Iterable<AbortSignal, any, any>,
                                                                          transferList?: readonly Transferable[],
                                                                      ) => Promise<Response[]>

                                                                      Executes the specified function in the worker constructor with the tasks data iterable input parameter.

                                                                      -

                                                                      Type Declaration

                                                                        • (
                                                                              data: Iterable<Data>,
                                                                              name?: string,
                                                                              abortSignals?: Iterable<AbortSignal, any, any>,
                                                                              transferList?: readonly Transferable[],
                                                                          ): Promise<Response[]>

                                                                        • Parameters

                                                                          • data: Iterable<Data>

                                                                            The tasks iterable input data for the specified task function. This can only be an iterable of structured-cloneable data.

                                                                            -
                                                                          • Optionalname: string

                                                                            The optional name of the task function to execute. If not specified, the default task function will be executed.

                                                                            -
                                                                          • OptionalabortSignals: Iterable<AbortSignal, any, any>

                                                                            The optional iterable of AbortSignal to abort the tasks iterable.

                                                                            -
                                                                          • OptionaltransferList: readonly Transferable[]

                                                                            The optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards.

                                                                            -

                                                                          Returns Promise<Response[]>

                                                                          Promise with an array of task function responses that will be fulfilled when the tasks are completed.

                                                                          -
                                                                      removeTaskFunction: (name: string) => Promise<boolean>

                                                                      Removes a task function from this pool.

                                                                      -

                                                                      Type Declaration

                                                                        • (name: string): Promise<boolean>

                                                                        • Parameters

                                                                          • name: string

                                                                            The name of the task function.

                                                                            -

                                                                          Returns Promise<boolean>

                                                                          true if the task function was removed, false otherwise.

                                                                          -
                                                                      setDefaultTaskFunction: (name: string) => Promise<boolean>

                                                                      Sets the default task function in this pool.

                                                                      -

                                                                      Type Declaration

                                                                        • (name: string): Promise<boolean>

                                                                        • Parameters

                                                                          • name: string

                                                                            The name of the task function.

                                                                            -

                                                                          Returns Promise<boolean>

                                                                          true if the default task function was set, false otherwise.

                                                                          -
                                                                      setTasksQueueOptions: (tasksQueueOptions: TasksQueueOptions) => void

                                                                      Sets the worker node tasks queue options in this pool.

                                                                      -

                                                                      Type Declaration

                                                                      setWorkerChoiceStrategy: (
                                                                          workerChoiceStrategy:
                                                                              | "FAIR_SHARE"
                                                                              | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                              | "LEAST_BUSY"
                                                                              | "LEAST_ELU"
                                                                              | "LEAST_USED"
                                                                              | "ROUND_ROBIN"
                                                                              | "WEIGHTED_ROUND_ROBIN",
                                                                          workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions,
                                                                      ) => void

                                                                      Sets the default worker choice strategy in this pool.

                                                                      -

                                                                      Type Declaration

                                                                        • (
                                                                              workerChoiceStrategy:
                                                                                  | "FAIR_SHARE"
                                                                                  | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                  | "LEAST_BUSY"
                                                                                  | "LEAST_ELU"
                                                                                  | "LEAST_USED"
                                                                                  | "ROUND_ROBIN"
                                                                                  | "WEIGHTED_ROUND_ROBIN",
                                                                              workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions,
                                                                          ): void

                                                                        • Parameters

                                                                          • workerChoiceStrategy:
                                                                                | "FAIR_SHARE"
                                                                                | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                | "LEAST_BUSY"
                                                                                | "LEAST_ELU"
                                                                                | "LEAST_USED"
                                                                                | "ROUND_ROBIN"
                                                                                | "WEIGHTED_ROUND_ROBIN"

                                                                            The default worker choice strategy.

                                                                            -
                                                                          • OptionalworkerChoiceStrategyOptions: WorkerChoiceStrategyOptions

                                                                            The worker choice strategy options.

                                                                            -

                                                                          Returns void

                                                                      setWorkerChoiceStrategyOptions: (
                                                                          workerChoiceStrategyOptions: WorkerChoiceStrategyOptions,
                                                                      ) => boolean

                                                                      Sets the worker choice strategy options in this pool.

                                                                      -

                                                                      Type Declaration

                                                                      start: () => void

                                                                      Starts the minimum number of workers in this pool.

                                                                      -
                                                                      workerNodes: IWorkerNode<Worker, Data>[]

                                                                      Pool worker nodes.

                                                                      -

                                                                      Settings

                                                                      Member Visibility

                                                                      On This Page

                                                                      Properties
                                                                      + +
                                                                      + +
                                                                      enableTasksQueue: (
                                                                          enable: boolean,
                                                                          tasksQueueOptions?: TasksQueueOptions,
                                                                      ) => void
                                                                      +

                                                                      Enables/disables the worker node tasks queue in this pool.

                                                                      +
                                                                      +
                                                                      +

                                                                      Type Declaration

                                                                      +
                                                                        +
                                                                      • +
                                                                          +
                                                                        • (enable: boolean, tasksQueueOptions?: TasksQueueOptions): void
                                                                          • +
                                                                        • +
                                                                          +

                                                                          Parameters

                                                                          +
                                                                            +
                                                                          • enable: boolean +

                                                                            Whether to enable or disable the worker node tasks queue.

                                                                            +
                                                                            • +
                                                                          • OptionaltasksQueueOptions: TasksQueueOptions +

                                                                            The worker node tasks queue options.

                                                                            +
                                                                          +

                                                                          Returns void

                                                                      +
                                                                      + +
                                                                      execute: (
                                                                          data?: Data,
                                                                          name?: string,
                                                                          abortSignal?: AbortSignal,
                                                                          transferList?: readonly Transferable[],
                                                                      ) => Promise<Response>
                                                                      +

                                                                      Executes the specified function in the worker constructor with the task data input parameter.

                                                                      +
                                                                      +
                                                                      +

                                                                      Type Declaration

                                                                      +
                                                                        +
                                                                      • +
                                                                          +
                                                                        • (
                                                                              data?: Data,
                                                                              name?: string,
                                                                              abortSignal?: AbortSignal,
                                                                              transferList?: readonly Transferable[],
                                                                          ): Promise<Response>
                                                                          • +
                                                                        • +
                                                                          +

                                                                          Parameters

                                                                          +
                                                                            +
                                                                          • Optionaldata: Data +

                                                                            The optional task input data for the specified task function. This can only be structured-cloneable data.

                                                                            +
                                                                            • +
                                                                          • Optionalname: string +

                                                                            The optional name of the task function to execute. If not specified, the default task function will be executed.

                                                                            +
                                                                            • +
                                                                          • OptionalabortSignal: AbortSignal +

                                                                            The optional AbortSignal to abort the task.

                                                                            +
                                                                            • +
                                                                          • OptionaltransferList: readonly Transferable[] +

                                                                            The optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards.

                                                                            +
                                                                          +

                                                                          Returns Promise<Response>

                                                                          Promise with a task function response that will be fulfilled when the task is completed.

                                                                          +
                                                                      +
                                                                      + +
                                                                      hasTaskFunction: (name: string) => boolean
                                                                      +

                                                                      Whether the specified task function exists in this pool.

                                                                      +
                                                                      +
                                                                      +

                                                                      Type Declaration

                                                                      +
                                                                        +
                                                                      • +
                                                                          +
                                                                        • (name: string): boolean
                                                                          • +
                                                                        • +
                                                                          +

                                                                          Parameters

                                                                          +
                                                                            +
                                                                          • name: string +

                                                                            The name of the task function.

                                                                            +
                                                                          +

                                                                          Returns boolean

                                                                          true if the task function exists, false otherwise.

                                                                          +
                                                                      +
                                                                      + +
                                                                      info: PoolInfo
                                                                      +

                                                                      Pool information.

                                                                      +
                                                                      +
                                                                      + +
                                                                      listTaskFunctionsProperties: () => TaskFunctionProperties[]
                                                                      +

                                                                      Lists the properties of task functions available in this pool.

                                                                      +
                                                                      +
                                                                      +

                                                                      Type Declaration

                                                                      +
                                                                      +
                                                                      + +
                                                                      mapExecute: (
                                                                          data: Iterable<Data>,
                                                                          name?: string,
                                                                          abortSignals?: Iterable<AbortSignal, any, any>,
                                                                          transferList?: readonly Transferable[],
                                                                      ) => Promise<Response[]>
                                                                      +

                                                                      Executes the specified function in the worker constructor with the tasks data iterable input parameter.

                                                                      +
                                                                      +
                                                                      +

                                                                      Type Declaration

                                                                      +
                                                                        +
                                                                      • +
                                                                          +
                                                                        • (
                                                                              data: Iterable<Data>,
                                                                              name?: string,
                                                                              abortSignals?: Iterable<AbortSignal, any, any>,
                                                                              transferList?: readonly Transferable[],
                                                                          ): Promise<Response[]>
                                                                          • +
                                                                        • +
                                                                          +

                                                                          Parameters

                                                                          +
                                                                            +
                                                                          • data: Iterable<Data> +

                                                                            The tasks iterable input data for the specified task function. This can only be an iterable of structured-cloneable data.

                                                                            +
                                                                            • +
                                                                          • Optionalname: string +

                                                                            The optional name of the task function to execute. If not specified, the default task function will be executed.

                                                                            +
                                                                            • +
                                                                          • OptionalabortSignals: Iterable<AbortSignal, any, any> +

                                                                            The optional iterable of AbortSignal to abort the tasks iterable.

                                                                            +
                                                                            • +
                                                                          • OptionaltransferList: readonly Transferable[] +

                                                                            The optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards.

                                                                            +
                                                                          +

                                                                          Returns Promise<Response[]>

                                                                          Promise with an array of task function responses that will be fulfilled when the tasks are completed.

                                                                          +
                                                                      +
                                                                      + +
                                                                      removeTaskFunction: (name: string) => Promise<boolean>
                                                                      +

                                                                      Removes a task function from this pool.

                                                                      +
                                                                      +
                                                                      +

                                                                      Type Declaration

                                                                      +
                                                                        +
                                                                      • +
                                                                          +
                                                                        • (name: string): Promise<boolean>
                                                                          • +
                                                                        • +
                                                                          +

                                                                          Parameters

                                                                          +
                                                                            +
                                                                          • name: string +

                                                                            The name of the task function.

                                                                            +
                                                                          +

                                                                          Returns Promise<boolean>

                                                                          true if the task function was removed, false otherwise.

                                                                          +
                                                                      +
                                                                      + +
                                                                      setDefaultTaskFunction: (name: string) => Promise<boolean>
                                                                      +

                                                                      Sets the default task function in this pool.

                                                                      +
                                                                      +
                                                                      +

                                                                      Type Declaration

                                                                      +
                                                                        +
                                                                      • +
                                                                          +
                                                                        • (name: string): Promise<boolean>
                                                                          • +
                                                                        • +
                                                                          +

                                                                          Parameters

                                                                          +
                                                                            +
                                                                          • name: string +

                                                                            The name of the task function.

                                                                            +
                                                                          +

                                                                          Returns Promise<boolean>

                                                                          true if the default task function was set, false otherwise.

                                                                          +
                                                                      +
                                                                      + +
                                                                      setTasksQueueOptions: (tasksQueueOptions: TasksQueueOptions) => void
                                                                      +

                                                                      Sets the worker node tasks queue options in this pool.

                                                                      +
                                                                      +
                                                                      +

                                                                      Type Declaration

                                                                      +
                                                                      +
                                                                      + +
                                                                      setWorkerChoiceStrategy: (
                                                                          workerChoiceStrategy:
                                                                              | "FAIR_SHARE"
                                                                              | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                              | "LEAST_BUSY"
                                                                              | "LEAST_ELU"
                                                                              | "LEAST_USED"
                                                                              | "ROUND_ROBIN"
                                                                              | "WEIGHTED_ROUND_ROBIN",
                                                                          workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions,
                                                                      ) => void
                                                                      +

                                                                      Sets the default worker choice strategy in this pool.

                                                                      +
                                                                      +
                                                                      +

                                                                      Type Declaration

                                                                      +
                                                                        +
                                                                      • +
                                                                          +
                                                                        • (
                                                                              workerChoiceStrategy:
                                                                                  | "FAIR_SHARE"
                                                                                  | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                  | "LEAST_BUSY"
                                                                                  | "LEAST_ELU"
                                                                                  | "LEAST_USED"
                                                                                  | "ROUND_ROBIN"
                                                                                  | "WEIGHTED_ROUND_ROBIN",
                                                                              workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions,
                                                                          ): void
                                                                          • +
                                                                        • +
                                                                          +

                                                                          Parameters

                                                                          +
                                                                            +
                                                                          • workerChoiceStrategy:
                                                                                | "FAIR_SHARE"
                                                                                | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                | "LEAST_BUSY"
                                                                                | "LEAST_ELU"
                                                                                | "LEAST_USED"
                                                                                | "ROUND_ROBIN"
                                                                                | "WEIGHTED_ROUND_ROBIN"                                                                             +

                                                                            The default worker choice strategy.

                                                                            +
                                                                            • +
                                                                          • OptionalworkerChoiceStrategyOptions: WorkerChoiceStrategyOptions +

                                                                            The worker choice strategy options.

                                                                            +
                                                                          +

                                                                          Returns void

                                                                      +
                                                                      + +
                                                                      setWorkerChoiceStrategyOptions: (
                                                                          workerChoiceStrategyOptions: WorkerChoiceStrategyOptions,
                                                                      ) => boolean
                                                                      +

                                                                      Sets the worker choice strategy options in this pool.

                                                                      +
                                                                      +
                                                                      +

                                                                      Type Declaration

                                                                      +
                                                                        +
                                                                      • +
                                                                          +
                                                                        • (workerChoiceStrategyOptions: WorkerChoiceStrategyOptions): boolean
                                                                          • +
                                                                        • +
                                                                          +

                                                                          Parameters

                                                                          +
                                                                          +

                                                                          Returns boolean

                                                                          true if the worker choice strategy options were set, false otherwise.

                                                                          +
                                                                      +
                                                                      + +
                                                                      start: () => void
                                                                      +

                                                                      Starts the minimum number of workers in this pool.

                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +

                                                                      Settings

                                                                       +
                                                                      +
                                                                      Member Visibility +
                                                                        +
                                                                        • +
                                                                        • +
                                                                      +
                                                                      +
                                                                      +

                                                                      On This Page

                                                                       +
                                                                      +
                                                                      Properties +
                                                                      +
                                                                      +
                                                                      +
                                                                      diff --git a/docs/interfaces/src.IWorker.html b/docs/interfaces/src.IWorker.html index 2fa39503e..7685d1a99 100644 --- a/docs/interfaces/src.IWorker.html +++ b/docs/interfaces/src.IWorker.html @@ -1,5 +1,36 @@ -IWorker | poolifier - v5.3.2
                                                                      poolifier - v5.3.2
                                                                        Preparing search index...

                                                                        Interface IWorker

                                                                        Worker interface.

                                                                        -
                                                                        interface IWorker {
                                                                            disconnect?: () => void;
                                                                            id?: number;
                                                                            kill?: (signal?: string) => void;
                                                                            on: (event: string, handler: EventHandler<IWorker>) => this;
                                                                            once: (event: string, handler: EventHandler<IWorker>) => this;
                                                                            terminate?: () => Promise<number>;
                                                                            threadId?: number;
                                                                            unref?: () => void;
                                                                            "[captureRejectionSymbol]"?<K>(
                                                                                error: Error,
                                                                                event: string | symbol,
                                                                                ...args: AnyRest,
                                                                            ): void;
                                                                            addListener<K>(
                                                                                eventName: string | symbol,
                                                                                listener: (...args: any[]) => void,
                                                                            ): this;
                                                                            emit<K>(eventName: string | symbol, ...args: AnyRest): boolean;
                                                                            eventNames(): (string | symbol)[];
                                                                            getMaxListeners(): number;
                                                                            listenerCount<K>(eventName: string | symbol, listener?: Function): number;
                                                                            listeners<K>(eventName: string | symbol): Function[];
                                                                            off<K>(
                                                                                eventName: string | symbol,
                                                                                listener: (...args: any[]) => void,
                                                                            ): this;
                                                                            prependListener<K>(
                                                                                eventName: string | symbol,
                                                                                listener: (...args: any[]) => void,
                                                                            ): this;
                                                                            prependOnceListener<K>(
                                                                                eventName: string | symbol,
                                                                                listener: (...args: any[]) => void,
                                                                            ): this;
                                                                            rawListeners<K>(eventName: string | symbol): Function[];
                                                                            removeAllListeners(eventName?: string | symbol): this;
                                                                            removeListener<K>(
                                                                                eventName: string | symbol,
                                                                                listener: (...args: any[]) => void,
                                                                            ): this;
                                                                            setMaxListeners(n: number): this;
                                                                        }

                                                                        Hierarchy

                                                                        • EventEmitter
                                                                          • IWorker
                                                                        Index

                                                                        Properties

                                                                        disconnect? +IWorker | poolifier - v5.4.0
                                                                        +
                                                                        poolifier - v5.4.0 + +
                                                                          +
                                                                          +
                                                                          Preparing search index...
                                                                          +
                                                                          +
                                                                          +
                                                                          + +

                                                                          Interface IWorker

                                                                          +
                                                                          +

                                                                          Worker interface.

                                                                          +
                                                                          +
                                                                          interface IWorker {
                                                                              disconnect?: () => void;
                                                                              id?: number;
                                                                              kill?: (signal?: string) => void;
                                                                              on: (event: string, handler: EventHandler<IWorker>) => this;
                                                                              once: (event: string, handler: EventHandler<IWorker>) => this;
                                                                              terminate?: () => Promise<number>;
                                                                              threadId?: number;
                                                                              unref?: () => void;
                                                                              "[captureRejectionSymbol]"?<K>(
                                                                                  error: Error,
                                                                                  event: string | symbol,
                                                                                  ...args: AnyRest,
                                                                              ): void;
                                                                              addListener<K>(
                                                                                  eventName: string | symbol,
                                                                                  listener: (...args: any[]) => void,
                                                                              ): this;
                                                                              emit<K>(eventName: string | symbol, ...args: AnyRest): boolean;
                                                                              eventNames(): (string | symbol)[];
                                                                              getMaxListeners(): number;
                                                                              listenerCount<K>(eventName: string | symbol, listener?: Function): number;
                                                                              listeners<K>(eventName: string | symbol): Function[];
                                                                              off<K>(
                                                                                  eventName: string | symbol,
                                                                                  listener: (...args: any[]) => void,
                                                                              ): this;
                                                                              prependListener<K>(
                                                                                  eventName: string | symbol,
                                                                                  listener: (...args: any[]) => void,
                                                                              ): this;
                                                                              prependOnceListener<K>(
                                                                                  eventName: string | symbol,
                                                                                  listener: (...args: any[]) => void,
                                                                              ): this;
                                                                              rawListeners<K>(eventName: string | symbol): Function[];
                                                                              removeAllListeners(eventName?: string | symbol): this;
                                                                              removeListener<K>(
                                                                                  eventName: string | symbol,
                                                                                  listener: (...args: any[]) => void,
                                                                              ): this;
                                                                              setMaxListeners(n: number): this;
                                                                          }
                                                                          +
                                                                          +

                                                                          Hierarchy

                                                                          +
                                                                            +
                                                                          • EventEmitter +
                                                                              +
                                                                            • IWorker
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          Index
                                                                           +
                                                                          +
                                                                          + +
                                                                          disconnect? id? kill? on @@ -7,7 +38,10 @@ terminate? threadId? unref? -

                                                                          Methods

                                                                          [captureRejectionSymbol]? +
                                                                          +
                                                                          + +
                                                                          [captureRejectionSymbol]? addListener emit eventNames @@ -21,53 +55,313 @@ removeAllListeners removeListener setMaxListeners -

                                                                          Properties

                                                                          disconnect?: () => void

                                                                          Cluster worker disconnect.

                                                                          -
                                                                          id?: number

                                                                          Cluster worker id.

                                                                          -
                                                                          kill?: (signal?: string) => void

                                                                          Cluster worker kill.

                                                                          -
                                                                          on: (event: string, handler: EventHandler<IWorker>) => this

                                                                          Registers an event handler.

                                                                          -

                                                                          Type Declaration

                                                                          once: (event: string, handler: EventHandler<IWorker>) => this

                                                                          Registers once an event handler.

                                                                          -

                                                                          Type Declaration

                                                                          terminate?: () => Promise<number>

                                                                          Stop all JavaScript execution in the worker thread as soon as possible. +

                                                                          +
                                                                          + +
                                                                          +
                                                                          + +
                                                                          disconnect?: () => void
                                                                          +

                                                                          Cluster worker disconnect.

                                                                          +
                                                                          +
                                                                          + +
                                                                          id?: number
                                                                          +

                                                                          Cluster worker id.

                                                                          +
                                                                          +
                                                                          + +
                                                                          kill?: (signal?: string) => void
                                                                          +

                                                                          Cluster worker kill.

                                                                          +
                                                                          +
                                                                          + +
                                                                          on: (event: string, handler: EventHandler<IWorker>) => this
                                                                          +

                                                                          Registers an event handler.

                                                                          +
                                                                          +
                                                                          +

                                                                          Type Declaration

                                                                          +
                                                                          +
                                                                          + +
                                                                          once: (event: string, handler: EventHandler<IWorker>) => this
                                                                          +

                                                                          Registers once an event handler.

                                                                          +
                                                                          +
                                                                          +

                                                                          Type Declaration

                                                                          +
                                                                          +
                                                                          + +
                                                                          terminate?: () => Promise<number>
                                                                          +

                                                                          Stop all JavaScript execution in the worker thread as soon as possible. Returns a Promise for the exit code that is fulfilled when the 'exit' event is emitted.

                                                                          -
                                                                          threadId?: number

                                                                          Worker thread worker id.

                                                                          -
                                                                          unref?: () => void

                                                                          Calling unref() on a worker allows the thread to exit if this is the only +

                                                                          +
                                                                          + +
                                                                          threadId?: number
                                                                          +

                                                                          Worker thread worker id.

                                                                          +
                                                                          +
                                                                          + +
                                                                          unref?: () => void
                                                                          +

                                                                          Calling unref() on a worker allows the thread to exit if this is the only active handle in the event system. If the worker is already unref()ed callingunref() again has no effect.

                                                                          -

                                                                          v10.5.0

                                                                          -

                                                                          Methods

                                                                          • Type Parameters

                                                                            • K

                                                                            Parameters

                                                                            • error: Error
                                                                            • event: string | symbol
                                                                            • ...args: AnyRest

                                                                            Returns void

                                                                          • Alias for emitter.on(eventName, listener).

                                                                            -

                                                                            Type Parameters

                                                                            • K

                                                                            Parameters

                                                                            • eventName: string | symbol
                                                                            • listener: (...args: any[]) => void

                                                                            Returns this

                                                                            v0.1.26

                                                                            -

                                                                          • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments +

                                                                            +
                                                                            +
                                                                            +

                                                                            v10.5.0

                                                                            +
                                                                          +
                                                                          + +
                                                                          +
                                                                          + +
                                                                            +
                                                                          • + +
                                                                            +
                                                                            +

                                                                            Type Parameters

                                                                            +
                                                                              +
                                                                            • K
                                                                            +
                                                                            +

                                                                            Parameters

                                                                            +
                                                                              +
                                                                            • error: Error
                                                                              • +
                                                                            • event: string | symbol
                                                                              • +
                                                                            • ...args: AnyRest
                                                                            +

                                                                            Returns void

                                                                          +
                                                                          + +
                                                                            +
                                                                          • + +
                                                                            +

                                                                            Alias for emitter.on(eventName, listener).

                                                                            +
                                                                            +
                                                                            +

                                                                            Type Parameters

                                                                            +
                                                                              +
                                                                            • K
                                                                            +
                                                                            +

                                                                            Parameters

                                                                            +
                                                                              +
                                                                            • eventName: string | symbol
                                                                              • +
                                                                            • listener: (...args: any[]) => void
                                                                            +

                                                                            Returns this

                                                                            +
                                                                            +
                                                                            +

                                                                            v0.1.26

                                                                            +
                                                                          +
                                                                          + +
                                                                            +
                                                                          • + +
                                                                            +

                                                                            Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

                                                                            Returns true if the event had listeners, false otherwise.

                                                                            import { EventEmitter } from 'node:events';
                                                                            const myEmitter = new EventEmitter();

                                                                            // First listener
                                                                            myEmitter.on('event', function firstListener() {
                                                                              console.log('Helloooo! first listener');
                                                                            });
                                                                            // Second listener
                                                                            myEmitter.on('event', function secondListener(arg1, arg2) {
                                                                              console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
                                                                            });
                                                                            // Third listener
                                                                            myEmitter.on('event', function thirdListener(...args) {
                                                                              const parameters = args.join(', ');
                                                                              console.log(`event with parameters ${parameters} in third listener`);
                                                                            });

                                                                            console.log(myEmitter.listeners('event'));

                                                                            myEmitter.emit('event', 1, 2, 3, 4, 5);

                                                                            // Prints:
                                                                            // [
                                                                            //   [Function: firstListener],
                                                                            //   [Function: secondListener],
                                                                            //   [Function: thirdListener]
                                                                            // ]
                                                                            // Helloooo! first listener
                                                                            // event with parameters 1, 2 in second listener
                                                                            // event with parameters 1, 2, 3, 4, 5 in third listener
                                                                            -

                                                                            Type Parameters

                                                                            • K

                                                                            Parameters

                                                                            • eventName: string | symbol
                                                                            • ...args: AnyRest

                                                                            Returns boolean

                                                                            v0.1.26

                                                                            -

                                                                          • Returns an array listing the events for which the emitter has registered +

                                                                            +
                                                                            +

                                                                            Type Parameters

                                                                            +
                                                                              +
                                                                            • K
                                                                            +
                                                                            +

                                                                            Parameters

                                                                            +
                                                                              +
                                                                            • eventName: string | symbol
                                                                              • +
                                                                            • ...args: AnyRest
                                                                            +

                                                                            Returns boolean

                                                                            +
                                                                            +
                                                                            +

                                                                            v0.1.26

                                                                            +
                                                                          +
                                                                          + +
                                                                            +
                                                                          • + +
                                                                            +

                                                                            Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

                                                                            import { EventEmitter } from 'node:events';

                                                                            const myEE = new EventEmitter();
                                                                            myEE.on('foo', () => {});
                                                                            myEE.on('bar', () => {});

                                                                            const sym = Symbol('symbol');
                                                                            myEE.on(sym, () => {});

                                                                            console.log(myEE.eventNames());
                                                                            // Prints: [ 'foo', 'bar', Symbol(symbol) ]
                                                                            -

                                                                            Returns (string | symbol)[]

                                                                            v6.0.0

                                                                            -

                                                                          • Returns the current max listener value for the EventEmitter which is either -set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

                                                                            -

                                                                            Returns number

                                                                            v1.0.0

                                                                            -

                                                                          • Returns the number of listeners listening for the event named eventName. +

                                                                            +

                                                                            Returns (string | symbol)[]

                                                                            +
                                                                            +
                                                                            +

                                                                            v6.0.0

                                                                            +
                                                                          +
                                                                          + +
                                                                            +
                                                                          • + +
                                                                            +

                                                                            Returns the current max listener value for the EventEmitter which is either +set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

                                                                            +
                                                                            +

                                                                            Returns number

                                                                            +
                                                                            +
                                                                            +

                                                                            v1.0.0

                                                                            +
                                                                          +
                                                                          + +
                                                                            +
                                                                          • + +
                                                                            +

                                                                            Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

                                                                            -

                                                                            Type Parameters

                                                                            • K

                                                                            Parameters

                                                                            • eventName: string | symbol

                                                                              The name of the event being listened for

                                                                              -
                                                                            • Optionallistener: Function

                                                                              The event handler function

                                                                              -

                                                                            Returns number

                                                                            v3.2.0

                                                                            -

                                                                          • Returns a copy of the array of listeners for the event named eventName.

                                                                            +
                                                                            +
                                                                            +

                                                                            Type Parameters

                                                                            +
                                                                              +
                                                                            • K
                                                                            +
                                                                            +

                                                                            Parameters

                                                                            +
                                                                              +
                                                                            • eventName: string | symbol +

                                                                              The name of the event being listened for

                                                                              +
                                                                              • +
                                                                            • Optionallistener: Function +

                                                                              The event handler function

                                                                              +
                                                                            +

                                                                            Returns number

                                                                            +
                                                                            +
                                                                            +

                                                                            v3.2.0

                                                                            +
                                                                          +
                                                                          + +
                                                                            +
                                                                          • + +
                                                                            +

                                                                            Returns a copy of the array of listeners for the event named eventName.

                                                                            server.on('connection', (stream) => {
                                                                              console.log('someone connected!');
                                                                            });
                                                                            console.log(util.inspect(server.listeners('connection')));
                                                                            // Prints: [ [Function] ]
                                                                            -

                                                                            Type Parameters

                                                                            • K

                                                                            Parameters

                                                                            • eventName: string | symbol

                                                                            Returns Function[]

                                                                            v0.1.26

                                                                            -

                                                                          • Alias for emitter.removeListener().

                                                                            -

                                                                            Type Parameters

                                                                            • K

                                                                            Parameters

                                                                            • eventName: string | symbol
                                                                            • listener: (...args: any[]) => void

                                                                            Returns this

                                                                            v10.0.0

                                                                            -

                                                                          • Adds the listener function to the beginning of the listeners array for the +

                                                                            +
                                                                            +

                                                                            Type Parameters

                                                                            +
                                                                              +
                                                                            • K
                                                                            +
                                                                            +

                                                                            Parameters

                                                                            +
                                                                              +
                                                                            • eventName: string | symbol
                                                                            +

                                                                            Returns Function[]

                                                                            +
                                                                            +
                                                                            +

                                                                            v0.1.26

                                                                            +
                                                                          +
                                                                          + +
                                                                            +
                                                                          • + +
                                                                            +

                                                                            Alias for emitter.removeListener().

                                                                            +
                                                                            +
                                                                            +

                                                                            Type Parameters

                                                                            +
                                                                              +
                                                                            • K
                                                                            +
                                                                            +

                                                                            Parameters

                                                                            +
                                                                              +
                                                                            • eventName: string | symbol
                                                                              • +
                                                                            • listener: (...args: any[]) => void
                                                                            +

                                                                            Returns this

                                                                            +
                                                                            +
                                                                            +

                                                                            v10.0.0

                                                                            +
                                                                          +
                                                                          + +
                                                                            +
                                                                          • + +
                                                                            +

                                                                            Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                            @@ -75,31 +369,121 @@ and listener will result in the listener being added,

                                                                            Returns a reference to the EventEmitter, so that calls can be chained.

                                                                            -

                                                                            Type Parameters

                                                                            • K

                                                                            Parameters

                                                                            • eventName: string | symbol

                                                                              The name of the event.

                                                                              -
                                                                            • listener: (...args: any[]) => void

                                                                              The callback function

                                                                              -

                                                                            Returns this

                                                                            v6.0.0

                                                                            -

                                                                          • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this +

                                                                            +
                                                                            +

                                                                            Type Parameters

                                                                            +
                                                                              +
                                                                            • K
                                                                            +
                                                                            +

                                                                            Parameters

                                                                            +
                                                                              +
                                                                            • eventName: string | symbol +

                                                                              The name of the event.

                                                                              +
                                                                              • +
                                                                            • listener: (...args: any[]) => void +

                                                                              The callback function

                                                                              +
                                                                            +

                                                                            Returns this

                                                                            +
                                                                            +
                                                                            +

                                                                            v6.0.0

                                                                            +
                                                                          +
                                                                          + +
                                                                            +
                                                                          • + +
                                                                            +

                                                                            Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

                                                                            server.prependOnceListener('connection', (stream) => {
                                                                              console.log('Ah, we have our first user!');
                                                                            });

                                                                            Returns a reference to the EventEmitter, so that calls can be chained.

                                                                            -

                                                                            Type Parameters

                                                                            • K

                                                                            Parameters

                                                                            • eventName: string | symbol

                                                                              The name of the event.

                                                                              -
                                                                            • listener: (...args: any[]) => void

                                                                              The callback function

                                                                              -

                                                                            Returns this

                                                                            v6.0.0

                                                                            -

                                                                          • Returns a copy of the array of listeners for the event named eventName, +

                                                                            +
                                                                            +

                                                                            Type Parameters

                                                                            +
                                                                              +
                                                                            • K
                                                                            +
                                                                            +

                                                                            Parameters

                                                                            +
                                                                              +
                                                                            • eventName: string | symbol +

                                                                              The name of the event.

                                                                              +
                                                                              • +
                                                                            • listener: (...args: any[]) => void +

                                                                              The callback function

                                                                              +
                                                                            +

                                                                            Returns this

                                                                            +
                                                                            +
                                                                            +

                                                                            v6.0.0

                                                                            +
                                                                          +
                                                                          + +
                                                                            +
                                                                          • + +
                                                                            +

                                                                            Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

                                                                            import { EventEmitter } from 'node:events';
                                                                            const emitter = new EventEmitter();
                                                                            emitter.once('log', () => console.log('log once'));

                                                                            // Returns a new Array with a function `onceWrapper` which has a property
                                                                            // `listener` which contains the original listener bound above
                                                                            const listeners = emitter.rawListeners('log');
                                                                            const logFnWrapper = listeners[0];

                                                                            // Logs "log once" to the console and does not unbind the `once` event
                                                                            logFnWrapper.listener();

                                                                            // Logs "log once" to the console and removes the listener
                                                                            logFnWrapper();

                                                                            emitter.on('log', () => console.log('log persistently'));
                                                                            // Will return a new Array with a single function bound by `.on()` above
                                                                            const newListeners = emitter.rawListeners('log');

                                                                            // Logs "log persistently" twice
                                                                            newListeners[0]();
                                                                            emitter.emit('log');
                                                                            -

                                                                            Type Parameters

                                                                            • K

                                                                            Parameters

                                                                            • eventName: string | symbol

                                                                            Returns Function[]

                                                                            v9.4.0

                                                                            -

                                                                          • Removes all listeners, or those of the specified eventName.

                                                                            +
                                                                            +
                                                                            +

                                                                            Type Parameters

                                                                            +
                                                                              +
                                                                            • K
                                                                            +
                                                                            +

                                                                            Parameters

                                                                            +
                                                                              +
                                                                            • eventName: string | symbol
                                                                            +

                                                                            Returns Function[]

                                                                            +
                                                                            +
                                                                            +

                                                                            v9.4.0

                                                                            +
                                                                          +
                                                                          + +
                                                                            +
                                                                          • + +
                                                                            +

                                                                            Removes all listeners, or those of the specified eventName.

                                                                            It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

                                                                            Returns a reference to the EventEmitter, so that calls can be chained.

                                                                            -

                                                                            Parameters

                                                                            • OptionaleventName: string | symbol

                                                                            Returns this

                                                                            v0.1.26

                                                                            -

                                                                          • Removes the specified listener from the listener array for the event named eventName.

                                                                            +
                                                                            +
                                                                            +

                                                                            Parameters

                                                                            +
                                                                              +
                                                                            • OptionaleventName: string | symbol
                                                                            +

                                                                            Returns this

                                                                            +
                                                                            +
                                                                            +

                                                                            v0.1.26

                                                                            +
                                                                          +
                                                                          + +
                                                                            +
                                                                          • + +
                                                                            +

                                                                            Removes the specified listener from the listener array for the event named eventName.

                                                                            const callback = (stream) => {
                                                                              console.log('someone connected!');
                                                                            };
                                                                            server.on('connection', callback);
                                                                            // ...
                                                                            server.removeListener('connection', callback);
                                                                            @@ -125,11 +509,70 @@ recently added instance. In the example the once('ping') listener i

                                                                            Returns a reference to the EventEmitter, so that calls can be chained.

                                                                            -

                                                                            Type Parameters

                                                                            • K

                                                                            Parameters

                                                                            • eventName: string | symbol
                                                                            • listener: (...args: any[]) => void

                                                                            Returns this

                                                                            v0.1.26

                                                                            -

                                                                          • By default EventEmitters will print a warning if more than 10 listeners are +

                                                                            +
                                                                            +

                                                                            Type Parameters

                                                                            +
                                                                              +
                                                                            • K
                                                                            +
                                                                            +

                                                                            Parameters

                                                                            +
                                                                              +
                                                                            • eventName: string | symbol
                                                                              • +
                                                                            • listener: (...args: any[]) => void
                                                                            +

                                                                            Returns this

                                                                            +
                                                                            +
                                                                            +

                                                                            v0.1.26

                                                                            +
                                                                          +
                                                                          + +
                                                                            +
                                                                          • + +
                                                                            +

                                                                            By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

                                                                            Returns a reference to the EventEmitter, so that calls can be chained.

                                                                            -

                                                                            Parameters

                                                                            • n: number

                                                                            Returns this

                                                                            v0.3.5

                                                                            -

                                                                          Settings

                                                                          Member Visibility

                                                                          On This Page

                                                                          Properties
                                                                          Methods
                                                                          + +
                                                                          +

                                                                          Parameters

                                                                          +
                                                                            +
                                                                          • n: number
                                                                          +

                                                                          Returns this

                                                                          +
                                                                          +
                                                                          +

                                                                          v0.3.5

                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          +

                                                                          Settings

                                                                           +
                                                                          +
                                                                          Member Visibility +
                                                                            +
                                                                            • +
                                                                            • +
                                                                          +
                                                                          +
                                                                          +

                                                                          On This Page

                                                                           +
                                                                          +
                                                                          Properties +
                                                                          +
                                                                          Methods +
                                                                          +
                                                                          +
                                                                          +
                                                                          diff --git a/docs/interfaces/src.IWorkerChoiceStrategy.html b/docs/interfaces/src.IWorkerChoiceStrategy.html deleted file mode 100644 index aded2463b..000000000 --- a/docs/interfaces/src.IWorkerChoiceStrategy.html +++ /dev/null @@ -1,29 +0,0 @@ -IWorkerChoiceStrategy | poolifier - v5.3.2
                                                                          poolifier - v5.3.2
                                                                            Preparing search index...

                                                                            Interface IWorkerChoiceStrategyInternal

                                                                            Worker choice strategy interface.

                                                                            -
                                                                            interface IWorkerChoiceStrategy {
                                                                                choose: (workerNodeKeysSet?: ReadonlySet<number>) => number | undefined;
                                                                                name:
                                                                                    | "FAIR_SHARE"
                                                                                    | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                    | "LEAST_BUSY"
                                                                                    | "LEAST_ELU"
                                                                                    | "LEAST_USED"
                                                                                    | "ROUND_ROBIN"
                                                                                    | "WEIGHTED_ROUND_ROBIN";
                                                                                remove: (workerNodeKey: number) => boolean;
                                                                                reset: () => boolean;
                                                                                retriesCount: number;
                                                                                setOptions: (opts: WorkerChoiceStrategyOptions | undefined) => void;
                                                                                strategyPolicy: StrategyPolicy;
                                                                                taskStatisticsRequirements: TaskStatisticsRequirements;
                                                                                update: (workerNodeKey: number) => boolean;
                                                                            }
                                                                            Index

                                                                            Properties

                                                                            choose -name -remove -reset -retriesCount -setOptions -strategyPolicy -taskStatisticsRequirements -update -

                                                                            Properties

                                                                            choose: (workerNodeKeysSet?: ReadonlySet<number>) => number | undefined

                                                                            Chooses a worker node in the pool and returns its key. -If no worker nodes are eligible, undefined is returned and the caller retries.

                                                                            -

                                                                            Type Declaration

                                                                              • (workerNodeKeysSet?: ReadonlySet<number>): number | undefined

                                                                              • Parameters

                                                                                • OptionalworkerNodeKeysSet: ReadonlySet<number>

                                                                                  The worker node keys affinity set. If undefined, all workers are eligible.

                                                                                  -

                                                                                Returns number | undefined

                                                                                The worker node key or undefined.

                                                                                -
                                                                            name:
                                                                                | "FAIR_SHARE"
                                                                                | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                | "LEAST_BUSY"
                                                                                | "LEAST_ELU"
                                                                                | "LEAST_USED"
                                                                                | "ROUND_ROBIN"
                                                                                | "WEIGHTED_ROUND_ROBIN"

                                                                            The worker choice strategy name.

                                                                            -
                                                                            remove: (workerNodeKey: number) => boolean

                                                                            Removes the worker node key from strategy internals.

                                                                            -

                                                                            Type Declaration

                                                                              • (workerNodeKey: number): boolean

                                                                              • Parameters

                                                                                • workerNodeKey: number

                                                                                  The worker node key.

                                                                                  -

                                                                                Returns boolean

                                                                                true if the worker node key is removed, false otherwise.

                                                                                -
                                                                            reset: () => boolean

                                                                            Resets strategy internals.

                                                                            -

                                                                            Type Declaration

                                                                              • (): boolean

                                                                              • Returns boolean

                                                                                true if the reset is successful, false otherwise.

                                                                                -
                                                                            retriesCount: number

                                                                            The worker choice strategy execution retries count.

                                                                            -
                                                                            setOptions: (opts: WorkerChoiceStrategyOptions | undefined) => void

                                                                            Sets the worker choice strategy options.

                                                                            -

                                                                            Type Declaration

                                                                            strategyPolicy: StrategyPolicy

                                                                            Strategy policy.

                                                                            -
                                                                            taskStatisticsRequirements: TaskStatisticsRequirements

                                                                            Tasks statistics requirements.

                                                                            -
                                                                            update: (workerNodeKey: number) => boolean

                                                                            Updates the worker node key strategy internals. -This is called after a task has been executed on a worker node.

                                                                            -

                                                                            Type Declaration

                                                                              • (workerNodeKey: number): boolean

                                                                              • Parameters

                                                                                • workerNodeKey: number

                                                                                Returns boolean

                                                                                true if the update is successful, false otherwise.

                                                                                -

                                                                            Settings

                                                                            Member Visibility

                                                                            On This Page

                                                                            Properties
                                                                            diff --git a/docs/interfaces/src.IWorkerNode.html b/docs/interfaces/src.IWorkerNode.html deleted file mode 100644 index 0783a1d19..000000000 --- a/docs/interfaces/src.IWorkerNode.html +++ /dev/null @@ -1,206 +0,0 @@ -IWorkerNode | poolifier - v5.3.2
                                                                            poolifier - v5.3.2
                                                                              Preparing search index...

                                                                              Interface IWorkerNode<Worker, Data>Internal

                                                                              Worker node interface.

                                                                              -
                                                                              interface IWorkerNode<Worker extends IWorker, Data = unknown> {
                                                                                  clearTasksQueue: () => void;
                                                                                  deleteTask: (task: Task<Data>) => boolean;
                                                                                  deleteTaskFunctionWorkerUsage: (name: string) => boolean;
                                                                                  dequeueLastPrioritizedTask: () => Task<Data> | undefined;
                                                                                  dequeueTask: (bucket?: number) => Task<Data> | undefined;
                                                                                  enqueueTask: (task: Task<Data>) => number;
                                                                                  getTaskFunctionWorkerUsage: (name: string) => WorkerUsage | undefined;
                                                                                  info: WorkerInfo;
                                                                                  messageChannel?: MessageChannel;
                                                                                  registerOnceWorkerEventHandler: (
                                                                                      event: string,
                                                                                      handler: EventHandler<Worker>,
                                                                                  ) => void;
                                                                                  registerWorkerEventHandler: (
                                                                                      event: string,
                                                                                      handler: EventHandler<Worker>,
                                                                                  ) => void;
                                                                                  setTasksQueuePriority: (enablePriority: boolean) => void;
                                                                                  strategyData?: StrategyData;
                                                                                  tasksQueue: PriorityQueue<Task<Data>>;
                                                                                  tasksQueueBackPressureSize: number;
                                                                                  tasksQueueSize: () => number;
                                                                                  terminate: () => Promise<void>;
                                                                                  usage: WorkerUsage;
                                                                                  worker: Worker;
                                                                                  "[captureRejectionSymbol]"?<K>(
                                                                                      error: Error,
                                                                                      event: string | symbol,
                                                                                      ...args: AnyRest,
                                                                                  ): void;
                                                                                  addListener<K>(
                                                                                      eventName: string | symbol,
                                                                                      listener: (...args: any[]) => void,
                                                                                  ): this;
                                                                                  emit<K>(eventName: string | symbol, ...args: AnyRest): boolean;
                                                                                  eventNames(): (string | symbol)[];
                                                                                  getMaxListeners(): number;
                                                                                  listenerCount<K>(eventName: string | symbol, listener?: Function): number;
                                                                                  listeners<K>(eventName: string | symbol): Function[];
                                                                                  off<K>(
                                                                                      eventName: string | symbol,
                                                                                      listener: (...args: any[]) => void,
                                                                                  ): this;
                                                                                  on<K>(eventName: string | symbol, listener: (...args: any[]) => void): this;
                                                                                  once<K>(
                                                                                      eventName: string | symbol,
                                                                                      listener: (...args: any[]) => void,
                                                                                  ): this;
                                                                                  prependListener<K>(
                                                                                      eventName: string | symbol,
                                                                                      listener: (...args: any[]) => void,
                                                                                  ): this;
                                                                                  prependOnceListener<K>(
                                                                                      eventName: string | symbol,
                                                                                      listener: (...args: any[]) => void,
                                                                                  ): this;
                                                                                  rawListeners<K>(eventName: string | symbol): Function[];
                                                                                  removeAllListeners(eventName?: string | symbol): this;
                                                                                  removeListener<K>(
                                                                                      eventName: string | symbol,
                                                                                      listener: (...args: any[]) => void,
                                                                                  ): this;
                                                                                  setMaxListeners(n: number): this;
                                                                              }

                                                                              Type Parameters

                                                                              • Worker extends IWorker

                                                                                Type of worker.

                                                                                -
                                                                              • Data = unknown

                                                                                Type of data sent to the worker. This can only be structured-cloneable data.

                                                                                -

                                                                              Hierarchy

                                                                              • EventEmitter
                                                                                • IWorkerNode
                                                                              Index

                                                                              Properties

                                                                              clearTasksQueue -deleteTask -deleteTaskFunctionWorkerUsage -dequeueLastPrioritizedTask -dequeueTask -enqueueTask -getTaskFunctionWorkerUsage -info -messageChannel? -registerOnceWorkerEventHandler -registerWorkerEventHandler -setTasksQueuePriority -strategyData? -tasksQueue -tasksQueueBackPressureSize -tasksQueueSize -terminate -usage -worker -

                                                                              Methods

                                                                              [captureRejectionSymbol]? -addListener -emit -eventNames -getMaxListeners -listenerCount -listeners -off -on -once -prependListener -prependOnceListener -rawListeners -removeAllListeners -removeListener -setMaxListeners -

                                                                              Properties

                                                                              clearTasksQueue: () => void

                                                                              Clears tasks queue.

                                                                              -
                                                                              deleteTask: (task: Task<Data>) => boolean

                                                                              Deletes a task from the tasks queue.

                                                                              -

                                                                              Type Declaration

                                                                                • (task: Task<Data>): boolean

                                                                                • Parameters

                                                                                  Returns boolean

                                                                                  true if the task was deleted, false otherwise.

                                                                                  -
                                                                              deleteTaskFunctionWorkerUsage: (name: string) => boolean

                                                                              Deletes task function worker usage statistics.

                                                                              -

                                                                              Type Declaration

                                                                                • (name: string): boolean

                                                                                • Parameters

                                                                                  • name: string

                                                                                    The task function name.

                                                                                    -

                                                                                  Returns boolean

                                                                                  true if the task function worker usage statistics were deleted, false otherwise.

                                                                                  -
                                                                              dequeueLastPrioritizedTask: () => Task<Data> | undefined

                                                                              Dequeue last prioritized task.

                                                                              -

                                                                              Type Declaration

                                                                              dequeueTask: (bucket?: number) => Task<Data> | undefined

                                                                              Dequeue task.

                                                                              -

                                                                              Type Declaration

                                                                                • (bucket?: number): Task<Data> | undefined

                                                                                • Parameters

                                                                                  • Optionalbucket: number

                                                                                    The prioritized bucket to dequeue from.

                                                                                    -

                                                                                  Returns Task<Data> | undefined

                                                                                  The dequeued task.

                                                                                  -
                                                                              0
-
                                                                              - -
                                                                              enqueueTask: (task: Task<Data>) => number

                                                                              Enqueue task.

                                                                              -

                                                                              Type Declaration

                                                                                • (task: Task<Data>): number

                                                                                • Parameters

                                                                                  Returns number

                                                                                  The tasks queue size.

                                                                                  -
                                                                              getTaskFunctionWorkerUsage: (name: string) => WorkerUsage | undefined

                                                                              Gets task function worker usage statistics.

                                                                              -

                                                                              Type Declaration

                                                                                • (name: string): WorkerUsage | undefined

                                                                                • Parameters

                                                                                  • name: string

                                                                                    The task function name.

                                                                                    -

                                                                                  Returns WorkerUsage | undefined

                                                                                  The task function worker usage statistics if the task function worker usage statistics are initialized, undefined otherwise.

                                                                                  -
                                                                              info: WorkerInfo

                                                                              Worker info.

                                                                              -
                                                                              messageChannel?: MessageChannel

                                                                              Message channel (worker thread only).

                                                                              -
                                                                              registerOnceWorkerEventHandler: (
                                                                                  event: string,
                                                                                  handler: EventHandler<Worker>,
                                                                              ) => void

                                                                              Registers once a worker event handler.

                                                                              -

                                                                              Type Declaration

                                                                              registerWorkerEventHandler: (
                                                                                  event: string,
                                                                                  handler: EventHandler<Worker>,
                                                                              ) => void

                                                                              Registers a worker event handler.

                                                                              -

                                                                              Type Declaration

                                                                              setTasksQueuePriority: (enablePriority: boolean) => void

                                                                              Sets tasks queue priority.

                                                                              -

                                                                              Type Declaration

                                                                                • (enablePriority: boolean): void

                                                                                • Parameters

                                                                                  • enablePriority: boolean

                                                                                    Whether to enable tasks queue priority.

                                                                                    -

                                                                                  Returns void

                                                                              strategyData?: StrategyData

                                                                              Worker choice strategy data. -This is used to store data that are specific to the worker choice strategy.

                                                                              -
                                                                              tasksQueue: PriorityQueue<Task<Data>>

                                                                              Tasks queue.

                                                                              -
                                                                              tasksQueueBackPressureSize: number

                                                                              Tasks queue back pressure size. -This is the number of tasks that can be enqueued before the worker node has back pressure.

                                                                              -
                                                                              tasksQueueSize: () => number

                                                                              Tasks queue size.

                                                                              -

                                                                              Type Declaration

                                                                                • (): number

                                                                                • Returns number

                                                                                  The tasks queue size.

                                                                                  -
                                                                              terminate: () => Promise<void>

                                                                              Terminates the worker node.

                                                                              -
                                                                              usage: WorkerUsage

                                                                              Worker usage statistics.

                                                                              -
                                                                              worker: Worker

                                                                              Worker.

                                                                              -

                                                                              Methods

                                                                              • Type Parameters

                                                                                • K

                                                                                Parameters

                                                                                • error: Error
                                                                                • event: string | symbol
                                                                                • ...args: AnyRest

                                                                                Returns void

                                                                              • Alias for emitter.on(eventName, listener).

                                                                                -

                                                                                Type Parameters

                                                                                • K

                                                                                Parameters

                                                                                • eventName: string | symbol
                                                                                • listener: (...args: any[]) => void

                                                                                Returns this

                                                                                v0.1.26

                                                                                -

                                                                              • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments -to each.

                                                                                -

                                                                                Returns true if the event had listeners, false otherwise.

                                                                                -
                                                                                import { EventEmitter } from 'node:events';
                                                                                const myEmitter = new EventEmitter();

                                                                                // First listener
                                                                                myEmitter.on('event', function firstListener() {
                                                                                  console.log('Helloooo! first listener');
                                                                                });
                                                                                // Second listener
                                                                                myEmitter.on('event', function secondListener(arg1, arg2) {
                                                                                  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
                                                                                });
                                                                                // Third listener
                                                                                myEmitter.on('event', function thirdListener(...args) {
                                                                                  const parameters = args.join(', ');
                                                                                  console.log(`event with parameters ${parameters} in third listener`);
                                                                                });

                                                                                console.log(myEmitter.listeners('event'));

                                                                                myEmitter.emit('event', 1, 2, 3, 4, 5);

                                                                                // Prints:
                                                                                // [
                                                                                //   [Function: firstListener],
                                                                                //   [Function: secondListener],
                                                                                //   [Function: thirdListener]
                                                                                // ]
                                                                                // Helloooo! first listener
                                                                                // event with parameters 1, 2 in second listener
                                                                                // event with parameters 1, 2, 3, 4, 5 in third listener
-
                                                                                - -

                                                                                Type Parameters

                                                                                • K

                                                                                Parameters

                                                                                • eventName: string | symbol
                                                                                • ...args: AnyRest

                                                                                Returns boolean

                                                                                v0.1.26

                                                                                -

                                                                              • Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or Symbols.

                                                                                -
                                                                                import { EventEmitter } from 'node:events';

                                                                                const myEE = new EventEmitter();
                                                                                myEE.on('foo', () => {});
                                                                                myEE.on('bar', () => {});

                                                                                const sym = Symbol('symbol');
                                                                                myEE.on(sym, () => {});

                                                                                console.log(myEE.eventNames());
                                                                                // Prints: [ 'foo', 'bar', Symbol(symbol) ]
-
                                                                                - -

                                                                                Returns (string | symbol)[]

                                                                                v6.0.0

                                                                                -

                                                                              • Returns the current max listener value for the EventEmitter which is either -set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

                                                                                -

                                                                                Returns number

                                                                                v1.0.0

                                                                                -

                                                                              • Returns the number of listeners listening for the event named eventName. -If listener is provided, it will return how many times the listener is found -in the list of the listeners of the event.

                                                                                -

                                                                                Type Parameters

                                                                                • K

                                                                                Parameters

                                                                                • eventName: string | symbol

                                                                                  The name of the event being listened for

                                                                                  -
                                                                                • Optionallistener: Function

                                                                                  The event handler function

                                                                                  -

                                                                                Returns number

                                                                                v3.2.0

                                                                                -

                                                                              • Returns a copy of the array of listeners for the event named eventName.

                                                                                -
                                                                                server.on('connection', (stream) => {
                                                                                  console.log('someone connected!');
                                                                                });
                                                                                console.log(util.inspect(server.listeners('connection')));
                                                                                // Prints: [ [Function] ]
-
                                                                                - -

                                                                                Type Parameters

                                                                                • K

                                                                                Parameters

                                                                                • eventName: string | symbol

                                                                                Returns Function[]

                                                                                v0.1.26

                                                                                -

                                                                              • Alias for emitter.removeListener().

                                                                                -

                                                                                Type Parameters

                                                                                • K

                                                                                Parameters

                                                                                • eventName: string | symbol
                                                                                • listener: (...args: any[]) => void

                                                                                Returns this

                                                                                v10.0.0

                                                                                -

                                                                              • Adds the listener function to the end of the listeners array for the event -named eventName. No checks are made to see if the listener has already -been added. Multiple calls passing the same combination of eventName and -listener will result in the listener being added, and called, multiple times.

                                                                                -
                                                                                server.on('connection', (stream) => {
                                                                                  console.log('someone connected!');
                                                                                });
-
                                                                                - -

                                                                                Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                -

                                                                                By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

                                                                                -
                                                                                import { EventEmitter } from 'node:events';
                                                                                const myEE = new EventEmitter();
                                                                                myEE.on('foo', () => console.log('a'));
                                                                                myEE.prependListener('foo', () => console.log('b'));
                                                                                myEE.emit('foo');
                                                                                // Prints:
                                                                                //   b
                                                                                //   a
-
                                                                                - -

                                                                                Type Parameters

                                                                                • K

                                                                                Parameters

                                                                                • eventName: string | symbol

                                                                                  The name of the event.

                                                                                  -
                                                                                • listener: (...args: any[]) => void

                                                                                  The callback function

                                                                                  -

                                                                                Returns this

                                                                                v0.1.101

                                                                                -

                                                                              • Adds a one-time listener function for the event named eventName. The -next time eventName is triggered, this listener is removed and then invoked.

                                                                                -
                                                                                server.once('connection', (stream) => {
                                                                                  console.log('Ah, we have our first user!');
                                                                                });
-
                                                                                - -

                                                                                Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                -

                                                                                By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

                                                                                -
                                                                                import { EventEmitter } from 'node:events';
                                                                                const myEE = new EventEmitter();
                                                                                myEE.once('foo', () => console.log('a'));
                                                                                myEE.prependOnceListener('foo', () => console.log('b'));
                                                                                myEE.emit('foo');
                                                                                // Prints:
                                                                                //   b
                                                                                //   a
-
                                                                                - -

                                                                                Type Parameters

                                                                                • K

                                                                                Parameters

                                                                                • eventName: string | symbol

                                                                                  The name of the event.

                                                                                  -
                                                                                • listener: (...args: any[]) => void

                                                                                  The callback function

                                                                                  -

                                                                                Returns this

                                                                                v0.3.0

                                                                                -

                                                                              • Adds the listener function to the beginning of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventName -and listener will result in the listener being added, and called, multiple times.

                                                                                -
                                                                                server.prependListener('connection', (stream) => {
                                                                                  console.log('someone connected!');
                                                                                });
-
                                                                                - -

                                                                                Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                -

                                                                                Type Parameters

                                                                                • K

                                                                                Parameters

                                                                                • eventName: string | symbol

                                                                                  The name of the event.

                                                                                  -
                                                                                • listener: (...args: any[]) => void

                                                                                  The callback function

                                                                                  -

                                                                                Returns this

                                                                                v6.0.0

                                                                                -

                                                                              • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this -listener is removed, and then invoked.

                                                                                -
                                                                                server.prependOnceListener('connection', (stream) => {
                                                                                  console.log('Ah, we have our first user!');
                                                                                });
-
                                                                                - -

                                                                                Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                -

                                                                                Type Parameters

                                                                                • K

                                                                                Parameters

                                                                                • eventName: string | symbol

                                                                                  The name of the event.

                                                                                  -
                                                                                • listener: (...args: any[]) => void

                                                                                  The callback function

                                                                                  -

                                                                                Returns this

                                                                                v6.0.0

                                                                                -

                                                                              • Returns a copy of the array of listeners for the event named eventName, -including any wrappers (such as those created by .once()).

                                                                                -
                                                                                import { EventEmitter } from 'node:events';
                                                                                const emitter = new EventEmitter();
                                                                                emitter.once('log', () => console.log('log once'));

                                                                                // Returns a new Array with a function `onceWrapper` which has a property
                                                                                // `listener` which contains the original listener bound above
                                                                                const listeners = emitter.rawListeners('log');
                                                                                const logFnWrapper = listeners[0];

                                                                                // Logs "log once" to the console and does not unbind the `once` event
                                                                                logFnWrapper.listener();

                                                                                // Logs "log once" to the console and removes the listener
                                                                                logFnWrapper();

                                                                                emitter.on('log', () => console.log('log persistently'));
                                                                                // Will return a new Array with a single function bound by `.on()` above
                                                                                const newListeners = emitter.rawListeners('log');

                                                                                // Logs "log persistently" twice
                                                                                newListeners[0]();
                                                                                emitter.emit('log');
-
                                                                                - -

                                                                                Type Parameters

                                                                                • K

                                                                                Parameters

                                                                                • eventName: string | symbol

                                                                                Returns Function[]

                                                                                v9.4.0

                                                                                -

                                                                              • Removes all listeners, or those of the specified eventName.

                                                                                -

                                                                                It is bad practice to remove listeners added elsewhere in the code, -particularly when the EventEmitter instance was created by some other -component or module (e.g. sockets or file streams).

                                                                                -

                                                                                Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                -

                                                                                Parameters

                                                                                • OptionaleventName: string | symbol

                                                                                Returns this

                                                                                v0.1.26

                                                                                -

                                                                              • Removes the specified listener from the listener array for the event named eventName.

                                                                                -
                                                                                const callback = (stream) => {
                                                                                  console.log('someone connected!');
                                                                                };
                                                                                server.on('connection', callback);
                                                                                // ...
                                                                                server.removeListener('connection', callback);
-
                                                                                - -

                                                                                removeListener() will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified eventName, then removeListener() must be -called multiple times to remove each instance.

                                                                                -

                                                                                Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution -will not remove them fromemit() in progress. Subsequent events behave as expected.

                                                                                -
                                                                                import { EventEmitter } from 'node:events';
                                                                                class MyEmitter extends EventEmitter {}
                                                                                const myEmitter = new MyEmitter();

                                                                                const callbackA = () => {
                                                                                  console.log('A');
                                                                                  myEmitter.removeListener('event', callbackB);
                                                                                };

                                                                                const callbackB = () => {
                                                                                  console.log('B');
                                                                                };

                                                                                myEmitter.on('event', callbackA);

                                                                                myEmitter.on('event', callbackB);

                                                                                // callbackA removes listener callbackB but it will still be called.
                                                                                // Internal listener array at time of emit [callbackA, callbackB]
                                                                                myEmitter.emit('event');
                                                                                // Prints:
                                                                                //   A
                                                                                //   B

                                                                                // callbackB is now removed.
                                                                                // Internal listener array [callbackA]
                                                                                myEmitter.emit('event');
                                                                                // Prints:
                                                                                //   A
-
                                                                                - -

                                                                                Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered after the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the emitter.listeners() method will need to be recreated.

                                                                                -

                                                                                When a single function has been added as a handler multiple times for a single -event (as in the example below), removeListener() will remove the most -recently added instance. In the example the once('ping') listener is removed:

                                                                                -
                                                                                import { EventEmitter } from 'node:events';
                                                                                const ee = new EventEmitter();

                                                                                function pong() {
                                                                                  console.log('pong');
                                                                                }

                                                                                ee.on('ping', pong);
                                                                                ee.once('ping', pong);
                                                                                ee.removeListener('ping', pong);

                                                                                ee.emit('ping');
                                                                                ee.emit('ping');
-
                                                                                - -

                                                                                Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                -

                                                                                Type Parameters

                                                                                • K

                                                                                Parameters

                                                                                • eventName: string | symbol
                                                                                • listener: (...args: any[]) => void

                                                                                Returns this

                                                                                v0.1.26

                                                                                -

                                                                              • By default EventEmitters will print a warning if more than 10 listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The emitter.setMaxListeners() method allows the limit to be -modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

                                                                                -

                                                                                Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                -

                                                                                Parameters

                                                                                • n: number

                                                                                Returns this

                                                                                v0.3.5

                                                                                -

                                                                              Settings

                                                                              Member Visibility

                                                                              On This Page

                                                                              Properties
                                                                              Methods
                                                                              diff --git a/docs/interfaces/src.MeasurementOptions.html b/docs/interfaces/src.MeasurementOptions.html index 4d2178306..03715051e 100644 --- a/docs/interfaces/src.MeasurementOptions.html +++ b/docs/interfaces/src.MeasurementOptions.html @@ -1,4 +1,61 @@ -MeasurementOptions | poolifier - v5.3.2
                                                                              poolifier - v5.3.2
                                                                                Preparing search index...

                                                                                Interface MeasurementOptions

                                                                                Measurement options.

                                                                                -
                                                                                interface MeasurementOptions {
                                                                                    median: boolean;
                                                                                }
                                                                                Index

                                                                                Properties

                                                                                median -

                                                                                Properties

                                                                                median: boolean

                                                                                Set measurement median.

                                                                                -

                                                                                Settings

                                                                                Member Visibility

                                                                                On This Page

                                                                                Properties
                                                                                +MeasurementOptions | poolifier - v5.4.0
                                                                                +
                                                                                poolifier - v5.4.0 + +
                                                                                  +
                                                                                  +
                                                                                  Preparing search index...
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  + +

                                                                                  Interface MeasurementOptions

                                                                                  +
                                                                                  +

                                                                                  Measurement options.

                                                                                  +
                                                                                  +
                                                                                  interface MeasurementOptions {
                                                                                      median: boolean;
                                                                                  }
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  Index
                                                                                   +
                                                                                  +
                                                                                  + +
                                                                                  median +
                                                                                  +
                                                                                  + +
                                                                                  +
                                                                                  + +
                                                                                  median: boolean
                                                                                  +

                                                                                  Set measurement median.

                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +

                                                                                  Settings

                                                                                   +
                                                                                  +
                                                                                  Member Visibility +
                                                                                    +
                                                                                    • +
                                                                                    • +
                                                                                  +
                                                                                  +
                                                                                  +

                                                                                  On This Page

                                                                                   +
                                                                                  +
                                                                                  Properties +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  diff --git a/docs/interfaces/src.MeasurementStatistics.html b/docs/interfaces/src.MeasurementStatistics.html deleted file mode 100644 index 048ba643e..000000000 --- a/docs/interfaces/src.MeasurementStatistics.html +++ /dev/null @@ -1,14 +0,0 @@ -MeasurementStatistics | poolifier - v5.3.2
                                                                                  poolifier - v5.3.2
                                                                                    Preparing search index...

                                                                                    Interface MeasurementStatisticsInternal

                                                                                    Measurement statistics.

                                                                                    -
                                                                                    interface MeasurementStatistics {
                                                                                        aggregate?: number;
                                                                                        average?: number;
                                                                                        history: CircularBuffer;
                                                                                        maximum?: number;
                                                                                        median?: number;
                                                                                        minimum?: number;
                                                                                    }
                                                                                    Index

                                                                                    Properties

                                                                                    aggregate? -average? -history -maximum? -median? -minimum? -

                                                                                    Properties

                                                                                    aggregate?: number

                                                                                    Measurement aggregate.

                                                                                    -
                                                                                    average?: number

                                                                                    Measurement average.

                                                                                    -
                                                                                    history: CircularBuffer

                                                                                    Measurement history.

                                                                                    -
                                                                                    maximum?: number

                                                                                    Measurement maximum.

                                                                                    -
                                                                                    median?: number

                                                                                    Measurement median.

                                                                                    -
                                                                                    minimum?: number

                                                                                    Measurement minimum.

                                                                                    -

                                                                                    Settings

                                                                                    Member Visibility

                                                                                    On This Page

                                                                                    Properties
                                                                                    diff --git a/docs/interfaces/src.MeasurementStatisticsRequirements.html b/docs/interfaces/src.MeasurementStatisticsRequirements.html deleted file mode 100644 index f9a5980a1..000000000 --- a/docs/interfaces/src.MeasurementStatisticsRequirements.html +++ /dev/null @@ -1,8 +0,0 @@ -MeasurementStatisticsRequirements | poolifier - v5.3.2
                                                                                    poolifier - v5.3.2
                                                                                      Preparing search index...

                                                                                      Interface MeasurementStatisticsRequirementsInternal

                                                                                      Measurement statistics requirements.

                                                                                      -
                                                                                      interface MeasurementStatisticsRequirements {
                                                                                          aggregate: boolean;
                                                                                          average: boolean;
                                                                                          median: boolean;
                                                                                      }
                                                                                      Index

                                                                                      Properties

                                                                                      aggregate -average -median -

                                                                                      Properties

                                                                                      aggregate: boolean

                                                                                      Requires measurement aggregate.

                                                                                      -
                                                                                      average: boolean

                                                                                      Requires measurement average.

                                                                                      -
                                                                                      median: boolean

                                                                                      Requires measurement median.

                                                                                      -

                                                                                      Settings

                                                                                      Member Visibility

                                                                                      On This Page

                                                                                      Properties
                                                                                      diff --git a/docs/interfaces/src.MessageValue.html b/docs/interfaces/src.MessageValue.html deleted file mode 100644 index 97bd0dd43..000000000 --- a/docs/interfaces/src.MessageValue.html +++ /dev/null @@ -1,59 +0,0 @@ -MessageValue | poolifier - v5.3.2
                                                                                      poolifier - v5.3.2
                                                                                        Preparing search index...

                                                                                        Interface MessageValue<Data, ErrorData>Internal

                                                                                        Message object that is passed between main worker and worker.

                                                                                        -
                                                                                        interface MessageValue<Data = unknown, ErrorData = unknown> {
                                                                                            abortable?: boolean;
                                                                                            checkActive?: boolean;
                                                                                            data?: Data;
                                                                                            kill?: true | "success" | "HARD" | "SOFT" | "failure";
                                                                                            name?: string;
                                                                                            port?: MessagePort;
                                                                                            priority?: number;
                                                                                            ready?: boolean;
                                                                                            statistics?: WorkerStatistics;
                                                                                            strategy?:
                                                                                                | "FAIR_SHARE"
                                                                                                | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                                | "LEAST_BUSY"
                                                                                                | "LEAST_ELU"
                                                                                                | "LEAST_USED"
                                                                                                | "ROUND_ROBIN"
                                                                                                | "WEIGHTED_ROUND_ROBIN";
                                                                                            taskFunction?: string;
                                                                                            taskFunctionOperation?: "add"
                                                                                            | "default"
                                                                                            | "remove";
                                                                                            taskFunctionOperationStatus?: boolean;
                                                                                            taskFunctionProperties?: TaskFunctionProperties;
                                                                                            taskFunctionsProperties?: TaskFunctionProperties[];
                                                                                            taskId?: `${string}-${string}-${string}-${string}-${string}`;
                                                                                            taskOperation?: "abort";
                                                                                            taskPerformance?: TaskPerformance;
                                                                                            timestamp?: number;
                                                                                            transferList?: readonly Transferable[];
                                                                                            workerError?: WorkerError<ErrorData>;
                                                                                            workerId?: number;
                                                                                        }

                                                                                        Type Parameters

                                                                                        • Data = unknown

                                                                                          Type of data sent to the worker or execution response. This can only be structured-cloneable data.

                                                                                          -
                                                                                        • ErrorData = unknown

                                                                                          Type of data sent to the worker triggering an error. This can only be structured-cloneable data.

                                                                                          -

                                                                                        Hierarchy (View Summary)

                                                                                        Index

                                                                                        Properties

                                                                                        abortable? -checkActive? -data? -kill? -name? -port? -priority? -ready? -statistics? -strategy? -taskFunction? -taskFunctionOperation? -taskFunctionOperationStatus? -taskFunctionProperties? -taskFunctionsProperties? -taskId? -taskOperation? -taskPerformance? -timestamp? -transferList? -workerError? -workerId? -

                                                                                        Properties

                                                                                        abortable?: boolean

                                                                                        Whether the task is abortable or not.

                                                                                        -
                                                                                        checkActive?: boolean

                                                                                        Whether the worker starts or stops its activity check.

                                                                                        -
                                                                                        data?: Data

                                                                                        Task input data that will be passed to the worker.

                                                                                        -
                                                                                        kill?: true | "success" | "HARD" | "SOFT" | "failure"

                                                                                        Kill code.

                                                                                        -
                                                                                        name?: string

                                                                                        Task name.

                                                                                        -
                                                                                        port?: MessagePort

                                                                                        Message port.

                                                                                        -
                                                                                        priority?: number

                                                                                        Task priority. Lower values have higher priority.

                                                                                        -
                                                                                        0
-
                                                                                        - -
                                                                                        ready?: boolean

                                                                                        Whether the worker is ready or not.

                                                                                        -
                                                                                        statistics?: WorkerStatistics

                                                                                        Whether the worker computes the given statistics or not.

                                                                                        -
                                                                                        strategy?:
                                                                                            | "FAIR_SHARE"
                                                                                            | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                            | "LEAST_BUSY"
                                                                                            | "LEAST_ELU"
                                                                                            | "LEAST_USED"
                                                                                            | "ROUND_ROBIN"
                                                                                            | "WEIGHTED_ROUND_ROBIN"

                                                                                        Task worker choice strategy.

                                                                                        -
                                                                                        taskFunction?: string

                                                                                        Task function serialized to string.

                                                                                        -
                                                                                        taskFunctionOperation?: "add" | "default" | "remove"

                                                                                        Task function operation:

                                                                                        -
                                                                                          -
                                                                                        • 'add' - Add a task function.
                                                                                          • -
                                                                                        • 'remove' - Remove a task function.
                                                                                          • -
                                                                                        • 'default' - Set a task function as default.
                                                                                          • -
                                                                                        -
                                                                                        taskFunctionOperationStatus?: boolean

                                                                                        Whether the task function operation is successful or not.

                                                                                        -
                                                                                        taskFunctionProperties?: TaskFunctionProperties

                                                                                        Task function properties.

                                                                                        -
                                                                                        taskFunctionsProperties?: TaskFunctionProperties[]

                                                                                        Task functions properties.

                                                                                        -
                                                                                        taskId?: `${string}-${string}-${string}-${string}-${string}`

                                                                                        Task UUID.

                                                                                        -
                                                                                        taskOperation?: "abort"

                                                                                        Task operation:

                                                                                        -
                                                                                          -
                                                                                        • 'abort' - Abort a task.
                                                                                          • -
                                                                                        -
                                                                                        taskPerformance?: TaskPerformance

                                                                                        Task performance.

                                                                                        -
                                                                                        timestamp?: number

                                                                                        Timestamp.

                                                                                        -
                                                                                        transferList?: readonly Transferable[]

                                                                                        Array of transferable objects.

                                                                                        -
                                                                                        workerError?: WorkerError<ErrorData>

                                                                                        Worker error.

                                                                                        -
                                                                                        workerId?: number

                                                                                        Worker id.

                                                                                        -

                                                                                        Settings

                                                                                        Member Visibility

                                                                                        On This Page

                                                                                        Properties
                                                                                        diff --git a/docs/interfaces/src.PoolInfo.html b/docs/interfaces/src.PoolInfo.html index 5e6fb7012..455a180e4 100644 --- a/docs/interfaces/src.PoolInfo.html +++ b/docs/interfaces/src.PoolInfo.html @@ -1,5 +1,30 @@ -PoolInfo | poolifier - v5.3.2
                                                                                        poolifier - v5.3.2
                                                                                          Preparing search index...

                                                                                          Interface PoolInfo

                                                                                          Pool information.

                                                                                          -
                                                                                          interface PoolInfo {
                                                                                              backPressure?: boolean;
                                                                                              backPressureWorkerNodes?: number;
                                                                                              busyWorkerNodes: number;
                                                                                              defaultStrategy:
                                                                                                  | "FAIR_SHARE"
                                                                                                  | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                                  | "LEAST_BUSY"
                                                                                                  | "LEAST_ELU"
                                                                                                  | "LEAST_USED"
                                                                                                  | "ROUND_ROBIN"
                                                                                                  | "WEIGHTED_ROUND_ROBIN";
                                                                                              dynamicWorkerNodes?: number;
                                                                                              elu?: {
                                                                                                  active: {
                                                                                                      average?: number;
                                                                                                      maximum: number;
                                                                                                      median?: number;
                                                                                                      minimum: number;
                                                                                                  };
                                                                                                  idle: {
                                                                                                      average?: number;
                                                                                                      maximum: number;
                                                                                                      median?: number;
                                                                                                      minimum: number;
                                                                                                  };
                                                                                                  utilization: { average?: number; median?: number };
                                                                                              };
                                                                                              executedTasks: number;
                                                                                              executingTasks: number;
                                                                                              failedTasks: number;
                                                                                              idleWorkerNodes: number;
                                                                                              maxQueuedTasks?: number;
                                                                                              maxSize: number;
                                                                                              minSize: number;
                                                                                              queuedTasks?: number;
                                                                                              ready: boolean;
                                                                                              runTime?: {
                                                                                                  average?: number;
                                                                                                  maximum: number;
                                                                                                  median?: number;
                                                                                                  minimum: number;
                                                                                              };
                                                                                              started: boolean;
                                                                                              stealingWorkerNodes?: number;
                                                                                              stolenTasks?: number;
                                                                                              strategyRetries: number;
                                                                                              type: "fixed"
                                                                                              | "dynamic";
                                                                                              utilization?: number;
                                                                                              version: string;
                                                                                              waitTime?: {
                                                                                                  average?: number;
                                                                                                  maximum: number;
                                                                                                  median?: number;
                                                                                                  minimum: number;
                                                                                              };
                                                                                              worker: "cluster"
                                                                                              | "thread";
                                                                                              workerNodes: number;
                                                                                          }
                                                                                          Index

                                                                                          Properties

                                                                                          backPressure? +PoolInfo | poolifier - v5.4.0
                                                                                          +
                                                                                          poolifier - v5.4.0 + +
                                                                                            +
                                                                                            +
                                                                                            Preparing search index...
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            + +

                                                                                            Interface PoolInfo

                                                                                            +
                                                                                            +

                                                                                            Pool information.

                                                                                            +
                                                                                            +
                                                                                            interface PoolInfo {
                                                                                                backPressure?: boolean;
                                                                                                backPressureWorkerNodes?: number;
                                                                                                busyWorkerNodes: number;
                                                                                                defaultStrategy:
                                                                                                    | "FAIR_SHARE"
                                                                                                    | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                                    | "LEAST_BUSY"
                                                                                                    | "LEAST_ELU"
                                                                                                    | "LEAST_USED"
                                                                                                    | "ROUND_ROBIN"
                                                                                                    | "WEIGHTED_ROUND_ROBIN";
                                                                                                dynamicWorkerNodes?: number;
                                                                                                elu?: {
                                                                                                    active: {
                                                                                                        average?: number;
                                                                                                        maximum: number;
                                                                                                        median?: number;
                                                                                                        minimum: number;
                                                                                                    };
                                                                                                    idle: {
                                                                                                        average?: number;
                                                                                                        maximum: number;
                                                                                                        median?: number;
                                                                                                        minimum: number;
                                                                                                    };
                                                                                                    utilization: { average?: number; median?: number };
                                                                                                };
                                                                                                executedTasks: number;
                                                                                                executingTasks: number;
                                                                                                failedTasks: number;
                                                                                                idleWorkerNodes: number;
                                                                                                maxQueuedTasks?: number;
                                                                                                maxSize: number;
                                                                                                minSize: number;
                                                                                                queuedTasks?: number;
                                                                                                ready: boolean;
                                                                                                runTime?: {
                                                                                                    average?: number;
                                                                                                    maximum: number;
                                                                                                    median?: number;
                                                                                                    minimum: number;
                                                                                                };
                                                                                                started: boolean;
                                                                                                stealingWorkerNodes?: number;
                                                                                                stolenTasks?: number;
                                                                                                strategyRetries: number;
                                                                                                type: "fixed"
                                                                                                | "dynamic";
                                                                                                utilization?: number;
                                                                                                version: string;
                                                                                                waitTime?: {
                                                                                                    average?: number;
                                                                                                    maximum: number;
                                                                                                    median?: number;
                                                                                                    minimum: number;
                                                                                                };
                                                                                                worker: "cluster"
                                                                                                | "thread";
                                                                                                workerNodes: number;
                                                                                            }
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            Index
                                                                                             +
                                                                                            +
                                                                                            + +
                                                                                            backPressure? backPressureWorkerNodes? busyWorkerNodes defaultStrategy @@ -25,11 +50,174 @@ waitTime? worker workerNodes -

                                                                                            Properties

                                                                                            backPressure?: boolean
                                                                                            backPressureWorkerNodes?: number

                                                                                            Pool tasks back pressure worker nodes.

                                                                                            -
                                                                                            busyWorkerNodes: number

                                                                                            Pool busy worker nodes.

                                                                                            -
                                                                                            defaultStrategy:
                                                                                                | "FAIR_SHARE"
                                                                                                | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                                | "LEAST_BUSY"
                                                                                                | "LEAST_ELU"
                                                                                                | "LEAST_USED"
                                                                                                | "ROUND_ROBIN"
                                                                                                | "WEIGHTED_ROUND_ROBIN"
                                                                                            dynamicWorkerNodes?: number

                                                                                            Pool dynamic worker nodes.

                                                                                            -
                                                                                            elu?: {
                                                                                                active: {
                                                                                                    average?: number;
                                                                                                    maximum: number;
                                                                                                    median?: number;
                                                                                                    minimum: number;
                                                                                                };
                                                                                                idle: {
                                                                                                    average?: number;
                                                                                                    maximum: number;
                                                                                                    median?: number;
                                                                                                    minimum: number;
                                                                                                };
                                                                                                utilization: { average?: number; median?: number };
                                                                                            }
                                                                                            executedTasks: number
                                                                                            executingTasks: number
                                                                                            failedTasks: number
                                                                                            idleWorkerNodes: number

                                                                                            Pool idle worker nodes.

                                                                                            -
                                                                                            maxQueuedTasks?: number
                                                                                            maxSize: number
                                                                                            minSize: number
                                                                                            queuedTasks?: number
                                                                                            ready: boolean
                                                                                            runTime?: {
                                                                                                average?: number;
                                                                                                maximum: number;
                                                                                                median?: number;
                                                                                                minimum: number;
                                                                                            }
                                                                                            started: boolean
                                                                                            stealingWorkerNodes?: number

                                                                                            Pool tasks stealing worker nodes.

                                                                                            -
                                                                                            stolenTasks?: number
                                                                                            strategyRetries: number
                                                                                            type: "fixed" | "dynamic"
                                                                                            utilization?: number

                                                                                            Pool utilization.

                                                                                            -
                                                                                            version: string
                                                                                            waitTime?: {
                                                                                                average?: number;
                                                                                                maximum: number;
                                                                                                median?: number;
                                                                                                minimum: number;
                                                                                            }
                                                                                            worker: "cluster" | "thread"
                                                                                            workerNodes: number

                                                                                            Pool total worker nodes.

                                                                                            -

                                                                                            Settings

                                                                                            Member Visibility

                                                                                            On This Page

                                                                                            Properties
                                                                                            +
                                                                                            +
                                                                                            + +
                                                                                            +
                                                                                            + +
                                                                                            backPressure?: boolean
                                                                                            +
                                                                                            + +
                                                                                            backPressureWorkerNodes?: number
                                                                                            +

                                                                                            Pool tasks back pressure worker nodes.

                                                                                            +
                                                                                            +
                                                                                            + +
                                                                                            busyWorkerNodes: number
                                                                                            +

                                                                                            Pool busy worker nodes.

                                                                                            +
                                                                                            +
                                                                                            + +
                                                                                            defaultStrategy:
                                                                                                | "FAIR_SHARE"
                                                                                                | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                                | "LEAST_BUSY"
                                                                                                | "LEAST_ELU"
                                                                                                | "LEAST_USED"
                                                                                                | "ROUND_ROBIN"
                                                                                                | "WEIGHTED_ROUND_ROBIN"
                                                                                            +
                                                                                            + +
                                                                                            dynamicWorkerNodes?: number
                                                                                            +

                                                                                            Pool dynamic worker nodes.

                                                                                            +
                                                                                            +
                                                                                            + +
                                                                                            elu?: {
                                                                                                active: {
                                                                                                    average?: number;
                                                                                                    maximum: number;
                                                                                                    median?: number;
                                                                                                    minimum: number;
                                                                                                };
                                                                                                idle: {
                                                                                                    average?: number;
                                                                                                    maximum: number;
                                                                                                    median?: number;
                                                                                                    minimum: number;
                                                                                                };
                                                                                                utilization: { average?: number; median?: number };
                                                                                            }
                                                                                            +
                                                                                            + +
                                                                                            executedTasks: number
                                                                                            +
                                                                                            + +
                                                                                            executingTasks: number
                                                                                            +
                                                                                            + +
                                                                                            failedTasks: number
                                                                                            +
                                                                                            + +
                                                                                            idleWorkerNodes: number
                                                                                            +

                                                                                            Pool idle worker nodes.

                                                                                            +
                                                                                            +
                                                                                            + +
                                                                                            maxQueuedTasks?: number
                                                                                            +
                                                                                            + +
                                                                                            maxSize: number
                                                                                            +
                                                                                            + +
                                                                                            minSize: number
                                                                                            +
                                                                                            + +
                                                                                            queuedTasks?: number
                                                                                            +
                                                                                            + +
                                                                                            ready: boolean
                                                                                            +
                                                                                            + +
                                                                                            runTime?: {
                                                                                                average?: number;
                                                                                                maximum: number;
                                                                                                median?: number;
                                                                                                minimum: number;
                                                                                            }
                                                                                            +
                                                                                            + +
                                                                                            started: boolean
                                                                                            +
                                                                                            + +
                                                                                            stealingWorkerNodes?: number
                                                                                            +

                                                                                            Pool tasks stealing worker nodes.

                                                                                            +
                                                                                            +
                                                                                            + +
                                                                                            stolenTasks?: number
                                                                                            +
                                                                                            + +
                                                                                            strategyRetries: number
                                                                                            +
                                                                                            + +
                                                                                            type: "fixed" | "dynamic"
                                                                                            +
                                                                                            + +
                                                                                            utilization?: number
                                                                                            +

                                                                                            Pool utilization.

                                                                                            +
                                                                                            +
                                                                                            + +
                                                                                            version: string
                                                                                            +
                                                                                            + +
                                                                                            waitTime?: {
                                                                                                average?: number;
                                                                                                maximum: number;
                                                                                                median?: number;
                                                                                                minimum: number;
                                                                                            }
                                                                                            +
                                                                                            + +
                                                                                            worker: "cluster" | "thread"
                                                                                            +
                                                                                            + +
                                                                                            workerNodes: number
                                                                                            +

                                                                                            Pool total worker nodes.

                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +

                                                                                            Settings

                                                                                             +
                                                                                            +
                                                                                            Member Visibility +
                                                                                              +
                                                                                              • +
                                                                                              • +
                                                                                            +
                                                                                            +
                                                                                            +

                                                                                            On This Page

                                                                                             +
                                                                                            +
                                                                                            Properties +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            diff --git a/docs/interfaces/src.PoolOptions.html b/docs/interfaces/src.PoolOptions.html index 906763328..53c4ddd70 100644 --- a/docs/interfaces/src.PoolOptions.html +++ b/docs/interfaces/src.PoolOptions.html @@ -1,6 +1,36 @@ -PoolOptions | poolifier - v5.3.2
                                                                                            poolifier - v5.3.2
                                                                                              Preparing search index...

                                                                                              Interface PoolOptions<Worker>

                                                                                              Options for a poolifier pool.

                                                                                              -
                                                                                              interface PoolOptions<Worker extends IWorker> {
                                                                                                  enableEvents?: boolean;
                                                                                                  enableTasksQueue?: boolean;
                                                                                                  env?: Record<string, unknown>;
                                                                                                  errorHandler?: ErrorHandler<Worker>;
                                                                                                  exitHandler?: ExitHandler<Worker>;
                                                                                                  messageHandler?: MessageHandler<Worker>;
                                                                                                  onlineHandler?: OnlineHandler<Worker>;
                                                                                                  restartWorkerOnError?: boolean;
                                                                                                  settings?: ClusterSettings;
                                                                                                  startWorkers?: boolean;
                                                                                                  tasksQueueOptions?: TasksQueueOptions;
                                                                                                  workerChoiceStrategy?:
                                                                                                      | "FAIR_SHARE"
                                                                                                      | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                                      | "LEAST_BUSY"
                                                                                                      | "LEAST_ELU"
                                                                                                      | "LEAST_USED"
                                                                                                      | "ROUND_ROBIN"
                                                                                                      | "WEIGHTED_ROUND_ROBIN";
                                                                                                  workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions;
                                                                                                  workerOptions?: WorkerOptions;
                                                                                              }

                                                                                              Type Parameters

                                                                                              • Worker extends IWorker

                                                                                                Type of worker.

                                                                                                -
                                                                                              Index

                                                                                              Properties

                                                                                              enableEvents? +PoolOptions | poolifier - v5.4.0
                                                                                              +
                                                                                              poolifier - v5.4.0 + +
                                                                                                +
                                                                                                +
                                                                                                Preparing search index...
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                + +

                                                                                                Interface PoolOptions<Worker>

                                                                                                +
                                                                                                +

                                                                                                Options for a poolifier pool.

                                                                                                +
                                                                                                +
                                                                                                interface PoolOptions<Worker extends IWorker> {
                                                                                                    enableEvents?: boolean;
                                                                                                    enableTasksQueue?: boolean;
                                                                                                    env?: Record<string, unknown>;
                                                                                                    errorHandler?: ErrorHandler<Worker>;
                                                                                                    exitHandler?: ExitHandler<Worker>;
                                                                                                    messageHandler?: MessageHandler<Worker>;
                                                                                                    onlineHandler?: OnlineHandler<Worker>;
                                                                                                    restartWorkerOnError?: boolean;
                                                                                                    settings?: ClusterSettings;
                                                                                                    startWorkers?: boolean;
                                                                                                    tasksQueueOptions?: TasksQueueOptions;
                                                                                                    workerChoiceStrategy?:
                                                                                                        | "FAIR_SHARE"
                                                                                                        | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                                        | "LEAST_BUSY"
                                                                                                        | "LEAST_ELU"
                                                                                                        | "LEAST_USED"
                                                                                                        | "ROUND_ROBIN"
                                                                                                        | "WEIGHTED_ROUND_ROBIN";
                                                                                                    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions;
                                                                                                    workerOptions?: WorkerOptions;
                                                                                                }
                                                                                                +
                                                                                                +

                                                                                                Type Parameters

                                                                                                +
                                                                                                  +
                                                                                                • Worker extends IWorker +

                                                                                                  Type of worker.

                                                                                                  +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                Index
                                                                                                 +
                                                                                                +
                                                                                                + +
                                                                                                enableEvents? enableTasksQueue? env? errorHandler? @@ -14,37 +44,180 @@ workerChoiceStrategy? workerChoiceStrategyOptions? workerOptions? -

                                                                                                Properties

                                                                                                enableEvents?: boolean

                                                                                                Pool events integrated with async resource emission.

                                                                                                -
                                                                                                true
+
                                                                                                +
                                                                                                + +
                                                                                                +
                                                                                                + +
                                                                                                enableEvents?: boolean
                                                                                                +

                                                                                                Pool events integrated with async resource emission.

                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                true
                                                                                                -
                                                                                                enableTasksQueue?: boolean

                                                                                                Pool worker node tasks queue.

                                                                                                -
                                                                                                false
+
                                                                                                +
                                                                                                + +
                                                                                                enableTasksQueue?: boolean
                                                                                                +

                                                                                                Pool worker node tasks queue.

                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                false
                                                                                                -
                                                                                                env?: Record<string, unknown>

                                                                                                Key/value pairs to add to worker process environment.

                                                                                                -

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

                                                                                                -
                                                                                                errorHandler?: ErrorHandler<Worker>

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

                                                                                                -

                                                                                                () => {}

                                                                                                -
                                                                                                exitHandler?: ExitHandler<Worker>

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

                                                                                                -

                                                                                                () => {}

                                                                                                -
                                                                                                messageHandler?: MessageHandler<Worker>

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

                                                                                                -

                                                                                                () => {}

                                                                                                -
                                                                                                onlineHandler?: OnlineHandler<Worker>

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

                                                                                                -

                                                                                                () => {}

                                                                                                -
                                                                                                restartWorkerOnError?: boolean

                                                                                                Restart worker on error.

                                                                                                -
                                                                                                settings?: ClusterSettings

                                                                                                Cluster settings.

                                                                                                -

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

                                                                                                -
                                                                                                startWorkers?: boolean

                                                                                                Whether to start the minimum number of workers at pool initialization.

                                                                                                -
                                                                                                true
+
                                                                                                +
                                                                                                + +
                                                                                                env?: Record<string, unknown>
                                                                                                +

                                                                                                Key/value pairs to add to worker process environment.

                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +

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

                                                                                                +
                                                                                                +
                                                                                                + +
                                                                                                errorHandler?: ErrorHandler<Worker>
                                                                                                +

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

                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +

                                                                                                () => {}

                                                                                                +
                                                                                                +
                                                                                                + +
                                                                                                exitHandler?: ExitHandler<Worker>
                                                                                                +

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

                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +

                                                                                                () => {}

                                                                                                +
                                                                                                +
                                                                                                + +
                                                                                                messageHandler?: MessageHandler<Worker>
                                                                                                +

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

                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +

                                                                                                () => {}

                                                                                                +
                                                                                                +
                                                                                                + +
                                                                                                onlineHandler?: OnlineHandler<Worker>
                                                                                                +

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

                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +

                                                                                                () => {}

                                                                                                +
                                                                                                +
                                                                                                + +
                                                                                                restartWorkerOnError?: boolean
                                                                                                +

                                                                                                Restart worker on error.

                                                                                                +
                                                                                                +
                                                                                                + +
                                                                                                settings?: ClusterSettings
                                                                                                +

                                                                                                Cluster settings.

                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +

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

                                                                                                +
                                                                                                +
                                                                                                + +
                                                                                                startWorkers?: boolean
                                                                                                +

                                                                                                Whether to start the minimum number of workers at pool initialization.

                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                true
                                                                                                -
                                                                                                tasksQueueOptions?: TasksQueueOptions

                                                                                                Pool worker node tasks queue options.

                                                                                                -
                                                                                                workerChoiceStrategy?:
                                                                                                    | "FAIR_SHARE"
                                                                                                    | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                                    | "LEAST_BUSY"
                                                                                                    | "LEAST_ELU"
                                                                                                    | "LEAST_USED"
                                                                                                    | "ROUND_ROBIN"
                                                                                                    | "WEIGHTED_ROUND_ROBIN"

                                                                                                The default worker choice strategy to use in this pool.

                                                                                                -
                                                                                                WorkerChoiceStrategies.LEAST_USED
+
                                                                                                +
                                                                                                + +
                                                                                                tasksQueueOptions?: TasksQueueOptions
                                                                                                +

                                                                                                Pool worker node tasks queue options.

                                                                                                +
                                                                                                +
                                                                                                + +
                                                                                                workerChoiceStrategy?:
                                                                                                    | "FAIR_SHARE"
                                                                                                    | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                                    | "LEAST_BUSY"
                                                                                                    | "LEAST_ELU"
                                                                                                    | "LEAST_USED"
                                                                                                    | "ROUND_ROBIN"
                                                                                                    | "WEIGHTED_ROUND_ROBIN"
                                                                                                +

                                                                                                The default worker choice strategy to use in this pool.

                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                WorkerChoiceStrategies.LEAST_USED
                                                                                                -
                                                                                                workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

                                                                                                The worker choice strategy options.

                                                                                                -
                                                                                                workerOptions?: WorkerOptions

                                                                                                Worker options.

                                                                                                -

                                                                                                https://nodejs.org/api/worker_threads.html#new-workerfilename-options

                                                                                                -

                                                                                                Settings

                                                                                                Member Visibility

                                                                                                On This Page

                                                                                                Properties
                                                                                                + +
                                                                                                + +
                                                                                                workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
                                                                                                +

                                                                                                The worker choice strategy options.

                                                                                                +
                                                                                                +
                                                                                                + +
                                                                                                workerOptions?: WorkerOptions
                                                                                                +

                                                                                                Worker options.

                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +

                                                                                                https://nodejs.org/api/worker_threads.html#new-workerfilename-options

                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +

                                                                                                Settings

                                                                                                 +
                                                                                                +
                                                                                                Member Visibility +
                                                                                                  +
                                                                                                  • +
                                                                                                  • +
                                                                                                +
                                                                                                +
                                                                                                +

                                                                                                On This Page

                                                                                                 +
                                                                                                +
                                                                                                Properties +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                diff --git a/docs/interfaces/src.PriorityQueue.html b/docs/interfaces/src.PriorityQueue.html deleted file mode 100644 index 2f3256ecb..000000000 --- a/docs/interfaces/src.PriorityQueue.html +++ /dev/null @@ -1,34 +0,0 @@ -PriorityQueue | poolifier - v5.3.2
                                                                                                poolifier - v5.3.2
                                                                                                  Preparing search index...

                                                                                                  Interface PriorityQueue<T>Internal

                                                                                                  Priority queue.

                                                                                                  -
                                                                                                  interface PriorityQueue<T> {
                                                                                                      maxSize: number;
                                                                                                      size: number;
                                                                                                      get buckets(): number;
                                                                                                      get enablePriority(): boolean;
                                                                                                      set enablePriority(enablePriority: boolean): void;
                                                                                                      "[iterator]"(): Iterator<T>;
                                                                                                      clear(): void;
                                                                                                      delete(data: T): boolean;
                                                                                                      dequeue(bucket?: number): T | undefined;
                                                                                                      enqueue(data: T, priority?: number): number;
                                                                                                  }

                                                                                                  Type Parameters

                                                                                                  • T

                                                                                                    Type of priority queue data.

                                                                                                    -
                                                                                                  Index

                                                                                                  Properties

                                                                                                  maxSize -size -

                                                                                                  Accessors

                                                                                                  buckets -enablePriority -

                                                                                                  Methods

                                                                                                  [iterator] -clear -delete -dequeue -enqueue -

                                                                                                  Properties

                                                                                                  maxSize: number

                                                                                                  The priority queue maximum size.

                                                                                                  -
                                                                                                  size: number

                                                                                                  The priority queue size.

                                                                                                  -

                                                                                                  Accessors

                                                                                                  • get buckets(): number

                                                                                                    The number of filled prioritized buckets.

                                                                                                    -

                                                                                                    Returns number

                                                                                                    The number of filled prioritized buckets.

                                                                                                    -
                                                                                                  • get enablePriority(): boolean

                                                                                                    Whether priority is enabled.

                                                                                                    -

                                                                                                    Returns boolean

                                                                                                    Whether priority is enabled.

                                                                                                    -
                                                                                                  • set enablePriority(enablePriority: boolean): void

                                                                                                    Enables/disables priority.

                                                                                                    -

                                                                                                    Parameters

                                                                                                    • enablePriority: boolean

                                                                                                      Whether to enable priority.

                                                                                                      -

                                                                                                    Returns void

                                                                                                  Methods

                                                                                                  • Deletes the given data from the priority queue.

                                                                                                    -

                                                                                                    Parameters

                                                                                                    • data: T

                                                                                                      Data to delete.

                                                                                                      -

                                                                                                    Returns boolean

                                                                                                    true if the data was deleted, false otherwise.

                                                                                                    -

                                                                                                  • Dequeue data from the priority queue.

                                                                                                    -

                                                                                                    Parameters

                                                                                                    • Optionalbucket: number

                                                                                                      The prioritized bucket to dequeue from.

                                                                                                      -

                                                                                                    Returns T | undefined

                                                                                                    The dequeued data or undefined if the priority queue is empty.

                                                                                                    -

                                                                                                  • Enqueue data into the priority queue.

                                                                                                    -

                                                                                                    Parameters

                                                                                                    • data: T

                                                                                                      Data to enqueue.

                                                                                                      -
                                                                                                    • Optionalpriority: number

                                                                                                      Priority of the data. Lower values have higher priority.

                                                                                                      -

                                                                                                    Returns number

                                                                                                    The new size of the priority queue.

                                                                                                    -

                                                                                                  Settings

                                                                                                  Member Visibility

                                                                                                  On This Page

                                                                                                  Properties
                                                                                                  Accessors
                                                                                                  Methods
                                                                                                  diff --git a/docs/interfaces/src.PromiseResponseWrapper.html b/docs/interfaces/src.PromiseResponseWrapper.html deleted file mode 100644 index 278833529..000000000 --- a/docs/interfaces/src.PromiseResponseWrapper.html +++ /dev/null @@ -1,13 +0,0 @@ -PromiseResponseWrapper | poolifier - v5.3.2
                                                                                                  poolifier - v5.3.2
                                                                                                    Preparing search index...

                                                                                                    Interface PromiseResponseWrapper<Response>Internal

                                                                                                    An object holding the task execution response promise resolve/reject callbacks.

                                                                                                    -
                                                                                                    interface PromiseResponseWrapper<Response = unknown> {
                                                                                                        abortSignal?: AbortSignal;
                                                                                                        asyncResource?: AsyncResource;
                                                                                                        reject: (reason?: unknown) => void;
                                                                                                        resolve: (value: Response | PromiseLike<Response>) => void;
                                                                                                        workerNodeKey: number;
                                                                                                    }

                                                                                                    Type Parameters

                                                                                                    • Response = unknown

                                                                                                      Type of execution response. This can only be structured-cloneable data.

                                                                                                      -
                                                                                                    Index

                                                                                                    Properties

                                                                                                    abortSignal? -asyncResource? -reject -resolve -workerNodeKey -

                                                                                                    Properties

                                                                                                    abortSignal?: AbortSignal

                                                                                                    The task abort signal.

                                                                                                    -
                                                                                                    asyncResource?: AsyncResource

                                                                                                    The asynchronous resource used to track the task execution.

                                                                                                    -
                                                                                                    reject: (reason?: unknown) => void

                                                                                                    Reject callback to reject the promise.

                                                                                                    -
                                                                                                    resolve: (value: Response | PromiseLike<Response>) => void

                                                                                                    Resolve callback to fulfill the promise.

                                                                                                    -
                                                                                                    workerNodeKey: number

                                                                                                    The worker node key executing the task.

                                                                                                    -

                                                                                                    Settings

                                                                                                    Member Visibility

                                                                                                    On This Page

                                                                                                    Properties
                                                                                                    diff --git a/docs/interfaces/src.StrategyData.html b/docs/interfaces/src.StrategyData.html deleted file mode 100644 index a97db6db2..000000000 --- a/docs/interfaces/src.StrategyData.html +++ /dev/null @@ -1,3 +0,0 @@ -StrategyData | poolifier - v5.3.2
                                                                                                    poolifier - v5.3.2
                                                                                                      Preparing search index...

                                                                                                      Interface StrategyDataInternal

                                                                                                      Worker choice strategy data.

                                                                                                      -
                                                                                                      interface StrategyData {
                                                                                                          virtualTaskEndTimestamp?: number;
                                                                                                      }
                                                                                                      Index

                                                                                                      Properties

                                                                                                      virtualTaskEndTimestamp? -

                                                                                                      Properties

                                                                                                      virtualTaskEndTimestamp?: number

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      On This Page

                                                                                                      Properties
                                                                                                      diff --git a/docs/interfaces/src.StrategyPolicy.html b/docs/interfaces/src.StrategyPolicy.html deleted file mode 100644 index 57e5b0baf..000000000 --- a/docs/interfaces/src.StrategyPolicy.html +++ /dev/null @@ -1,6 +0,0 @@ -StrategyPolicy | poolifier - v5.3.2
                                                                                                      poolifier - v5.3.2
                                                                                                        Preparing search index...

                                                                                                        Interface StrategyPolicyInternal

                                                                                                        Strategy policy.

                                                                                                        -
                                                                                                        interface StrategyPolicy {
                                                                                                            dynamicWorkerReady: boolean;
                                                                                                            dynamicWorkerUsage: boolean;
                                                                                                        }
                                                                                                        Index

                                                                                                        Properties

                                                                                                        dynamicWorkerReady -dynamicWorkerUsage -

                                                                                                        Properties

                                                                                                        dynamicWorkerReady: boolean

                                                                                                        Expects the newly created dynamic worker to be flagged as ready.

                                                                                                        -
                                                                                                        dynamicWorkerUsage: boolean

                                                                                                        Expects tasks execution on the newly created dynamic worker.

                                                                                                        -

                                                                                                        Settings

                                                                                                        Member Visibility

                                                                                                        On This Page

                                                                                                        Properties
                                                                                                        diff --git a/docs/interfaces/src.Task.html b/docs/interfaces/src.Task.html deleted file mode 100644 index 4f391bfed..000000000 --- a/docs/interfaces/src.Task.html +++ /dev/null @@ -1,22 +0,0 @@ -Task | poolifier - v5.3.2
                                                                                                        poolifier - v5.3.2
                                                                                                          Preparing search index...

                                                                                                          Interface Task<Data>Internal

                                                                                                          Message object that is passed as a task between main worker and worker.

                                                                                                          -
                                                                                                          interface Task<Data = unknown> {
                                                                                                              abortable?: boolean;
                                                                                                              data?: Data;
                                                                                                              name?: string;
                                                                                                              priority?: number;
                                                                                                              strategy?:
                                                                                                                  | "FAIR_SHARE"
                                                                                                                  | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                                                  | "LEAST_BUSY"
                                                                                                                  | "LEAST_ELU"
                                                                                                                  | "LEAST_USED"
                                                                                                                  | "ROUND_ROBIN"
                                                                                                                  | "WEIGHTED_ROUND_ROBIN";
                                                                                                              taskId?: `${string}-${string}-${string}-${string}-${string}`;
                                                                                                              timestamp?: number;
                                                                                                              transferList?: readonly Transferable[];
                                                                                                          }

                                                                                                          Type Parameters

                                                                                                          • Data = unknown

                                                                                                            Type of data sent to the worker. This can only be structured-cloneable data.

                                                                                                            -

                                                                                                          Hierarchy (View Summary)

                                                                                                          Index

                                                                                                          Properties

                                                                                                          abortable? -data? -name? -priority? -strategy? -taskId? -timestamp? -transferList? -

                                                                                                          Properties

                                                                                                          abortable?: boolean

                                                                                                          Whether the task is abortable or not.

                                                                                                          -
                                                                                                          data?: Data

                                                                                                          Task input data that will be passed to the worker.

                                                                                                          -
                                                                                                          name?: string

                                                                                                          Task name.

                                                                                                          -
                                                                                                          priority?: number

                                                                                                          Task priority. Lower values have higher priority.

                                                                                                          -
                                                                                                          0
-
                                                                                                          - -
                                                                                                          strategy?:
                                                                                                              | "FAIR_SHARE"
                                                                                                              | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                                              | "LEAST_BUSY"
                                                                                                              | "LEAST_ELU"
                                                                                                              | "LEAST_USED"
                                                                                                              | "ROUND_ROBIN"
                                                                                                              | "WEIGHTED_ROUND_ROBIN"

                                                                                                          Task worker choice strategy.

                                                                                                          -
                                                                                                          taskId?: `${string}-${string}-${string}-${string}-${string}`

                                                                                                          Task UUID.

                                                                                                          -
                                                                                                          timestamp?: number

                                                                                                          Timestamp.

                                                                                                          -
                                                                                                          transferList?: readonly Transferable[]

                                                                                                          Array of transferable objects.

                                                                                                          -

                                                                                                          Settings

                                                                                                          Member Visibility

                                                                                                          On This Page

                                                                                                          Properties
                                                                                                          diff --git a/docs/interfaces/src.TaskFunctionObject.html b/docs/interfaces/src.TaskFunctionObject.html index ffedef22a..dca39f304 100644 --- a/docs/interfaces/src.TaskFunctionObject.html +++ b/docs/interfaces/src.TaskFunctionObject.html @@ -1,15 +1,97 @@ -TaskFunctionObject | poolifier - v5.3.2
                                                                                                          poolifier - v5.3.2
                                                                                                            Preparing search index...

                                                                                                            Interface TaskFunctionObject<Data, Response>

                                                                                                            Task function object.

                                                                                                            -
                                                                                                            interface TaskFunctionObject<Data = unknown, Response = unknown> {
                                                                                                                priority?: number;
                                                                                                                strategy?:
                                                                                                                    | "FAIR_SHARE"
                                                                                                                    | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                                                    | "LEAST_BUSY"
                                                                                                                    | "LEAST_ELU"
                                                                                                                    | "LEAST_USED"
                                                                                                                    | "ROUND_ROBIN"
                                                                                                                    | "WEIGHTED_ROUND_ROBIN";
                                                                                                                taskFunction: TaskFunction<Data, Response>;
                                                                                                                workerNodeKeys?: number[];
                                                                                                            }

                                                                                                            Type Parameters

                                                                                                            • Data = unknown

                                                                                                              Type of data sent to the worker. This can only be structured-cloneable data.

                                                                                                              -
                                                                                                            • Response = unknown

                                                                                                              Type of execution response. This can only be structured-cloneable data.

                                                                                                              -
                                                                                                            Index

                                                                                                            Properties

                                                                                                            priority? +TaskFunctionObject | poolifier - v5.4.0
                                                                                                            +
                                                                                                            poolifier - v5.4.0 + +
                                                                                                              +
                                                                                                              +
                                                                                                              Preparing search index...
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              + +

                                                                                                              Interface TaskFunctionObject<Data, Response>

                                                                                                              +
                                                                                                              +

                                                                                                              Task function object.

                                                                                                              +
                                                                                                              +
                                                                                                              interface TaskFunctionObject<Data = unknown, Response = unknown> {
                                                                                                                  priority?: number;
                                                                                                                  strategy?:
                                                                                                                      | "FAIR_SHARE"
                                                                                                                      | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                                                      | "LEAST_BUSY"
                                                                                                                      | "LEAST_ELU"
                                                                                                                      | "LEAST_USED"
                                                                                                                      | "ROUND_ROBIN"
                                                                                                                      | "WEIGHTED_ROUND_ROBIN";
                                                                                                                  taskFunction: TaskFunction<Data, Response>;
                                                                                                                  workerNodeKeys?: number[];
                                                                                                              }
                                                                                                              +
                                                                                                              +

                                                                                                              Type Parameters

                                                                                                              +
                                                                                                                +
                                                                                                              • Data = unknown +

                                                                                                                Type of data sent to the worker. This can only be structured-cloneable data.

                                                                                                                +
                                                                                                                • +
                                                                                                              • Response = unknown +

                                                                                                                Type of execution response. This can only be structured-cloneable data.

                                                                                                                +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              Index
                                                                                                               +
                                                                                                              +
                                                                                                              + +
                                                                                                              priority? strategy? taskFunction workerNodeKeys? -

                                                                                                              Properties

                                                                                                              priority?: number

                                                                                                              Task function priority. Lower values have higher priority.

                                                                                                              -
                                                                                                              strategy?:
                                                                                                                  | "FAIR_SHARE"
                                                                                                                  | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                                                  | "LEAST_BUSY"
                                                                                                                  | "LEAST_ELU"
                                                                                                                  | "LEAST_USED"
                                                                                                                  | "ROUND_ROBIN"
                                                                                                                  | "WEIGHTED_ROUND_ROBIN"

                                                                                                              Task function worker choice strategy.

                                                                                                              -
                                                                                                              taskFunction: TaskFunction<Data, Response>

                                                                                                              Task function.

                                                                                                              -
                                                                                                              workerNodeKeys?: number[]

                                                                                                              Task function worker node keys affinity. +

                                                                                                              +
                                                                                                              + +
                                                                                                              +
                                                                                                              + +
                                                                                                              priority?: number
                                                                                                              +

                                                                                                              Task function priority. Lower values have higher priority.

                                                                                                              +
                                                                                                              +
                                                                                                              + +
                                                                                                              strategy?:
                                                                                                                  | "FAIR_SHARE"
                                                                                                                  | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                                                  | "LEAST_BUSY"
                                                                                                                  | "LEAST_ELU"
                                                                                                                  | "LEAST_USED"
                                                                                                                  | "ROUND_ROBIN"
                                                                                                                  | "WEIGHTED_ROUND_ROBIN"
                                                                                                              +

                                                                                                              Task function worker choice strategy.

                                                                                                              +
                                                                                                              +
                                                                                                              + +
                                                                                                              taskFunction: TaskFunction<Data, Response>
                                                                                                              +

                                                                                                              Task function.

                                                                                                              +
                                                                                                              +
                                                                                                              + +
                                                                                                              workerNodeKeys?: number[]
                                                                                                              +

                                                                                                              Task function worker node keys affinity. Restricts task execution to specified worker nodes by their indices. Must contain valid indices within [0, pool max size - 1]. If undefined, task can execute on any worker node.

                                                                                                              -

                                                                                                              Settings

                                                                                                              Member Visibility

                                                                                                              On This Page

                                                                                                              Properties
                                                                                                              + +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              +

                                                                                                              Settings

                                                                                                               +
                                                                                                              +
                                                                                                              Member Visibility +
                                                                                                                +
                                                                                                                • +
                                                                                                                • +
                                                                                                              +
                                                                                                              +
                                                                                                              +

                                                                                                              On This Page

                                                                                                               +
                                                                                                              +
                                                                                                              Properties +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              diff --git a/docs/interfaces/src.TaskFunctionOperationResult.html b/docs/interfaces/src.TaskFunctionOperationResult.html index 10ec09f3e..b6eac01b8 100644 --- a/docs/interfaces/src.TaskFunctionOperationResult.html +++ b/docs/interfaces/src.TaskFunctionOperationResult.html @@ -1,4 +1,65 @@ -TaskFunctionOperationResult | poolifier - v5.3.2
                                                                                                              poolifier - v5.3.2
                                                                                                                Preparing search index...

                                                                                                                Interface TaskFunctionOperationResult

                                                                                                                Task function operation result.

                                                                                                                -
                                                                                                                interface TaskFunctionOperationResult {
                                                                                                                    error?: Error;
                                                                                                                    status: boolean;
                                                                                                                }
                                                                                                                Index

                                                                                                                Properties

                                                                                                                error? +TaskFunctionOperationResult | poolifier - v5.4.0
                                                                                                                +
                                                                                                                poolifier - v5.4.0 + +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  Preparing search index...
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  + +

                                                                                                                  Interface TaskFunctionOperationResult

                                                                                                                  +
                                                                                                                  +

                                                                                                                  Task function operation result.

                                                                                                                  +
                                                                                                                  +
                                                                                                                  interface TaskFunctionOperationResult {
                                                                                                                      error?: Error;
                                                                                                                      status: boolean;
                                                                                                                  }
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  Index
                                                                                                                   +
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  error? status -

                                                                                                                  Properties

                                                                                                                  error?: Error
                                                                                                                  status: boolean

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  On This Page

                                                                                                                  Properties
                                                                                                                  +
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  error?: Error
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  status: boolean
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +

                                                                                                                  Settings

                                                                                                                   +
                                                                                                                  +
                                                                                                                  Member Visibility +
                                                                                                                    +
                                                                                                                    • +
                                                                                                                    • +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +

                                                                                                                  On This Page

                                                                                                                   +
                                                                                                                  +
                                                                                                                  Properties +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  diff --git a/docs/interfaces/src.TaskFunctionProperties.html b/docs/interfaces/src.TaskFunctionProperties.html index 529c35351..e1d663be3 100644 --- a/docs/interfaces/src.TaskFunctionProperties.html +++ b/docs/interfaces/src.TaskFunctionProperties.html @@ -1,13 +1,88 @@ -TaskFunctionProperties | poolifier - v5.3.2
                                                                                                                  poolifier - v5.3.2
                                                                                                                    Preparing search index...

                                                                                                                    Interface TaskFunctionProperties

                                                                                                                    Task function properties.

                                                                                                                    -
                                                                                                                    interface TaskFunctionProperties {
                                                                                                                        name: string;
                                                                                                                        priority?: number;
                                                                                                                        strategy?:
                                                                                                                            | "FAIR_SHARE"
                                                                                                                            | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                                                            | "LEAST_BUSY"
                                                                                                                            | "LEAST_ELU"
                                                                                                                            | "LEAST_USED"
                                                                                                                            | "ROUND_ROBIN"
                                                                                                                            | "WEIGHTED_ROUND_ROBIN";
                                                                                                                        workerNodeKeys?: number[];
                                                                                                                    }
                                                                                                                    Index

                                                                                                                    Properties

                                                                                                                    name +TaskFunctionProperties | poolifier - v5.4.0
                                                                                                                    +
                                                                                                                    poolifier - v5.4.0 + +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      Preparing search index...
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      + +

                                                                                                                      Interface TaskFunctionProperties

                                                                                                                      +
                                                                                                                      +

                                                                                                                      Task function properties.

                                                                                                                      +
                                                                                                                      +
                                                                                                                      interface TaskFunctionProperties {
                                                                                                                          name: string;
                                                                                                                          priority?: number;
                                                                                                                          strategy?:
                                                                                                                              | "FAIR_SHARE"
                                                                                                                              | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                                                              | "LEAST_BUSY"
                                                                                                                              | "LEAST_ELU"
                                                                                                                              | "LEAST_USED"
                                                                                                                              | "ROUND_ROBIN"
                                                                                                                              | "WEIGHTED_ROUND_ROBIN";
                                                                                                                          workerNodeKeys?: number[];
                                                                                                                      }
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      Index
                                                                                                                       +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      name priority? strategy? workerNodeKeys? -

                                                                                                                      Properties

                                                                                                                      name: string

                                                                                                                      Task function name.

                                                                                                                      -
                                                                                                                      priority?: number

                                                                                                                      Task function priority. Lower values have higher priority.

                                                                                                                      -
                                                                                                                      strategy?:
                                                                                                                          | "FAIR_SHARE"
                                                                                                                          | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                                                          | "LEAST_BUSY"
                                                                                                                          | "LEAST_ELU"
                                                                                                                          | "LEAST_USED"
                                                                                                                          | "ROUND_ROBIN"
                                                                                                                          | "WEIGHTED_ROUND_ROBIN"

                                                                                                                      Task function worker choice strategy.

                                                                                                                      -
                                                                                                                      workerNodeKeys?: number[]

                                                                                                                      Task function worker node keys affinity. +

                                                                                                                      +
                                                                                                                      + +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      name: string
                                                                                                                      +

                                                                                                                      Task function name.

                                                                                                                      +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      priority?: number
                                                                                                                      +

                                                                                                                      Task function priority. Lower values have higher priority.

                                                                                                                      +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      strategy?:
                                                                                                                          | "FAIR_SHARE"
                                                                                                                          | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                                                          | "LEAST_BUSY"
                                                                                                                          | "LEAST_ELU"
                                                                                                                          | "LEAST_USED"
                                                                                                                          | "ROUND_ROBIN"
                                                                                                                          | "WEIGHTED_ROUND_ROBIN"
                                                                                                                      +

                                                                                                                      Task function worker choice strategy.

                                                                                                                      +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      workerNodeKeys?: number[]
                                                                                                                      +

                                                                                                                      Task function worker node keys affinity. Restricts task execution to specified worker nodes by their indices. Must contain valid indices within [0, pool max size - 1]. If undefined, task can execute on any worker node.

                                                                                                                      -

                                                                                                                      Settings

                                                                                                                      Member Visibility

                                                                                                                      On This Page

                                                                                                                      Properties
                                                                                                                      + +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +

                                                                                                                      Settings

                                                                                                                       +
                                                                                                                      +
                                                                                                                      Member Visibility +
                                                                                                                        +
                                                                                                                        • +
                                                                                                                        • +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +

                                                                                                                      On This Page

                                                                                                                       +
                                                                                                                      +
                                                                                                                      Properties +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      diff --git a/docs/interfaces/src.TaskPerformance.html b/docs/interfaces/src.TaskPerformance.html deleted file mode 100644 index 071c4f79f..000000000 --- a/docs/interfaces/src.TaskPerformance.html +++ /dev/null @@ -1,10 +0,0 @@ -TaskPerformance | poolifier - v5.3.2
                                                                                                                      poolifier - v5.3.2
                                                                                                                        Preparing search index...

                                                                                                                        Interface TaskPerformanceInternal

                                                                                                                        Task performance.

                                                                                                                        -
                                                                                                                        interface TaskPerformance {
                                                                                                                            elu?: EventLoopUtilization;
                                                                                                                            name: string;
                                                                                                                            runTime?: number;
                                                                                                                            timestamp: number;
                                                                                                                        }
                                                                                                                        Index

                                                                                                                        Properties

                                                                                                                        elu? -name -runTime? -timestamp -

                                                                                                                        Properties

                                                                                                                        elu?: EventLoopUtilization

                                                                                                                        Task event loop utilization.

                                                                                                                        -
                                                                                                                        name: string

                                                                                                                        Task name.

                                                                                                                        -
                                                                                                                        runTime?: number

                                                                                                                        Task runtime.

                                                                                                                        -
                                                                                                                        timestamp: number

                                                                                                                        Task performance timestamp.

                                                                                                                        -

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        On This Page

                                                                                                                        Properties
                                                                                                                        diff --git a/docs/interfaces/src.TaskStatistics.html b/docs/interfaces/src.TaskStatistics.html deleted file mode 100644 index b895eb29d..000000000 --- a/docs/interfaces/src.TaskStatistics.html +++ /dev/null @@ -1,16 +0,0 @@ -TaskStatistics | poolifier - v5.3.2
                                                                                                                        poolifier - v5.3.2
                                                                                                                          Preparing search index...

                                                                                                                          Interface TaskStatisticsInternal

                                                                                                                          Task statistics.

                                                                                                                          -
                                                                                                                          interface TaskStatistics {
                                                                                                                              executed: number;
                                                                                                                              executing: number;
                                                                                                                              failed: number;
                                                                                                                              maxQueued?: number;
                                                                                                                              queued: number;
                                                                                                                              sequentiallyStolen: number;
                                                                                                                              stolen: number;
                                                                                                                          }
                                                                                                                          Index

                                                                                                                          Properties

                                                                                                                          executed -executing -failed -maxQueued? -queued -sequentiallyStolen -stolen -

                                                                                                                          Properties

                                                                                                                          executed: number

                                                                                                                          Number of executed tasks.

                                                                                                                          -
                                                                                                                          executing: number

                                                                                                                          Number of executing tasks.

                                                                                                                          -
                                                                                                                          failed: number

                                                                                                                          Number of failed tasks.

                                                                                                                          -
                                                                                                                          maxQueued?: number

                                                                                                                          Maximum number of queued tasks.

                                                                                                                          -
                                                                                                                          queued: number

                                                                                                                          Number of queued tasks.

                                                                                                                          -
                                                                                                                          sequentiallyStolen: number

                                                                                                                          Number of sequentially stolen tasks.

                                                                                                                          -
                                                                                                                          stolen: number

                                                                                                                          Number of stolen tasks.

                                                                                                                          -

                                                                                                                          Settings

                                                                                                                          Member Visibility

                                                                                                                          On This Page

                                                                                                                          Properties
                                                                                                                          diff --git a/docs/interfaces/src.TaskStatisticsRequirements.html b/docs/interfaces/src.TaskStatisticsRequirements.html deleted file mode 100644 index cb1e64492..000000000 --- a/docs/interfaces/src.TaskStatisticsRequirements.html +++ /dev/null @@ -1,8 +0,0 @@ -TaskStatisticsRequirements | poolifier - v5.3.2
                                                                                                                          poolifier - v5.3.2
                                                                                                                            Preparing search index...

                                                                                                                            Interface TaskStatisticsRequirementsInternal

                                                                                                                            Pool worker node worker usage statistics requirements.

                                                                                                                            -
                                                                                                                            interface TaskStatisticsRequirements {
                                                                                                                                elu: MeasurementStatisticsRequirements;
                                                                                                                                runTime: MeasurementStatisticsRequirements;
                                                                                                                                waitTime: MeasurementStatisticsRequirements;
                                                                                                                            }
                                                                                                                            Index

                                                                                                                            Properties

                                                                                                                            elu -runTime -waitTime -

                                                                                                                            Properties

                                                                                                                            elu: MeasurementStatisticsRequirements

                                                                                                                            Tasks event loop utilization requirements.

                                                                                                                            -
                                                                                                                            runTime: MeasurementStatisticsRequirements

                                                                                                                            Tasks runtime requirements.

                                                                                                                            -
                                                                                                                            waitTime: MeasurementStatisticsRequirements

                                                                                                                            Tasks wait time requirements.

                                                                                                                            -

                                                                                                                            Settings

                                                                                                                            Member Visibility

                                                                                                                            On This Page

                                                                                                                            Properties
                                                                                                                            diff --git a/docs/interfaces/src.TasksQueueOptions.html b/docs/interfaces/src.TasksQueueOptions.html index 764baec67..d5ecd0f67 100644 --- a/docs/interfaces/src.TasksQueueOptions.html +++ b/docs/interfaces/src.TasksQueueOptions.html @@ -1,5 +1,30 @@ -TasksQueueOptions | poolifier - v5.3.2
                                                                                                                            poolifier - v5.3.2
                                                                                                                              Preparing search index...

                                                                                                                              Interface TasksQueueOptions

                                                                                                                              Worker node tasks queue options.

                                                                                                                              -
                                                                                                                              interface TasksQueueOptions {
                                                                                                                                  agingFactor?: number;
                                                                                                                                  concurrency?: number;
                                                                                                                                  loadExponent?: number;
                                                                                                                                  size?: number;
                                                                                                                                  tasksFinishedTimeout?: number;
                                                                                                                                  tasksStealingOnBackPressure?: boolean;
                                                                                                                                  tasksStealingRatio?: number;
                                                                                                                                  taskStealing?: boolean;
                                                                                                                              }
                                                                                                                              Index

                                                                                                                              Properties

                                                                                                                              agingFactor? +TasksQueueOptions | poolifier - v5.4.0
                                                                                                                              +
                                                                                                                              poolifier - v5.4.0 + +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Preparing search index...
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                + +

                                                                                                                                Interface TasksQueueOptions

                                                                                                                                +
                                                                                                                                +

                                                                                                                                Worker node tasks queue options.

                                                                                                                                +
                                                                                                                                +
                                                                                                                                interface TasksQueueOptions {
                                                                                                                                    agingFactor?: number;
                                                                                                                                    concurrency?: number;
                                                                                                                                    loadExponent?: number;
                                                                                                                                    size?: number;
                                                                                                                                    tasksFinishedTimeout?: number;
                                                                                                                                    tasksStealingOnBackPressure?: boolean;
                                                                                                                                    tasksStealingRatio?: number;
                                                                                                                                    taskStealing?: boolean;
                                                                                                                                }
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Index
                                                                                                                                 +
                                                                                                                                +
                                                                                                                                + +
                                                                                                                                agingFactor? concurrency? loadExponent? size? @@ -7,36 +32,134 @@ tasksStealingOnBackPressure? tasksStealingRatio? taskStealing? -

                                                                                                                                Properties

                                                                                                                                agingFactor?: number

                                                                                                                                Controls the priority queue anti-starvation aging rate.

                                                                                                                                -
                                                                                                                                0.001
+
                                                                                                                                +
                                                                                                                                + +
                                                                                                                                +
                                                                                                                                + +
                                                                                                                                agingFactor?: number
                                                                                                                                +

                                                                                                                                Controls the priority queue anti-starvation aging rate.

                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                0.001
                                                                                                                                -
                                                                                                                                concurrency?: number

                                                                                                                                Maximum number of tasks that can be executed concurrently on a worker node.

                                                                                                                                -
                                                                                                                                1
+
                                                                                                                                +
                                                                                                                                + +
                                                                                                                                concurrency?: number
                                                                                                                                +

                                                                                                                                Maximum number of tasks that can be executed concurrently on a worker node.

                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                1
                                                                                                                                -
                                                                                                                                loadExponent?: number

                                                                                                                                Controls load-based aging adjustment exponent.

                                                                                                                                -
                                                                                                                                0.667
+
                                                                                                                                +
                                                                                                                                + +
                                                                                                                                loadExponent?: number
                                                                                                                                +

                                                                                                                                Controls load-based aging adjustment exponent.

                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                0.667
                                                                                                                                -
                                                                                                                                size?: number

                                                                                                                                Maximum tasks queue size per worker node flagging it as back pressured.

                                                                                                                                -
                                                                                                                                (pool maximum size)^2
+
                                                                                                                                +
                                                                                                                                + +
                                                                                                                                size?: number
                                                                                                                                +

                                                                                                                                Maximum tasks queue size per worker node flagging it as back pressured.

                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                (pool maximum size)^2
                                                                                                                                -
                                                                                                                                tasksFinishedTimeout?: number

                                                                                                                                Queued tasks finished timeout in milliseconds at worker node termination.

                                                                                                                                -
                                                                                                                                2000
+
                                                                                                                                +
                                                                                                                                + +
                                                                                                                                tasksFinishedTimeout?: number
                                                                                                                                +

                                                                                                                                Queued tasks finished timeout in milliseconds at worker node termination.

                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                2000
                                                                                                                                -
                                                                                                                                tasksStealingOnBackPressure?: boolean

                                                                                                                                Whether to enable tasks stealing under back pressure.

                                                                                                                                -
                                                                                                                                true
+
                                                                                                                                +
                                                                                                                                + +
                                                                                                                                tasksStealingOnBackPressure?: boolean
                                                                                                                                +

                                                                                                                                Whether to enable tasks stealing under back pressure.

                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                true
                                                                                                                                -
                                                                                                                                tasksStealingRatio?: number

                                                                                                                                Ratio of worker nodes that can steal tasks from another worker node.

                                                                                                                                -
                                                                                                                                0.6
+
                                                                                                                                +
                                                                                                                                + +
                                                                                                                                tasksStealingRatio?: number
                                                                                                                                +

                                                                                                                                Ratio of worker nodes that can steal tasks from another worker node.

                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                0.6
                                                                                                                                -
                                                                                                                                taskStealing?: boolean

                                                                                                                                Whether to enable task stealing on idle.

                                                                                                                                -
                                                                                                                                true
+
                                                                                                                                +
                                                                                                                                + +
                                                                                                                                taskStealing?: boolean
                                                                                                                                +

                                                                                                                                Whether to enable task stealing on idle.

                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                true
                                                                                                                                -

                                                                                                                                Settings

                                                                                                                                Member Visibility

                                                                                                                                On This Page

                                                                                                                                Properties
                                                                                                                                + +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +

                                                                                                                                Settings

                                                                                                                                 +
                                                                                                                                +
                                                                                                                                Member Visibility +
                                                                                                                                  +
                                                                                                                                  • +
                                                                                                                                  • +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +

                                                                                                                                On This Page

                                                                                                                                 +
                                                                                                                                +
                                                                                                                                Properties +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                diff --git a/docs/interfaces/src.WorkerChoiceStrategiesContext.html b/docs/interfaces/src.WorkerChoiceStrategiesContext.html deleted file mode 100644 index 22908afe4..000000000 --- a/docs/interfaces/src.WorkerChoiceStrategiesContext.html +++ /dev/null @@ -1,39 +0,0 @@ -WorkerChoiceStrategiesContext | poolifier - v5.3.2
                                                                                                                                poolifier - v5.3.2
                                                                                                                                  Preparing search index...

                                                                                                                                  Interface WorkerChoiceStrategiesContext<Worker, Data, Response>Internal

                                                                                                                                  The worker choice strategies context.

                                                                                                                                  -
                                                                                                                                  interface WorkerChoiceStrategiesContext<
                                                                                                                                      Worker extends IWorker,
                                                                                                                                      Data = unknown,
                                                                                                                                      Response = unknown,
                                                                                                                                  > {
                                                                                                                                      execute(
                                                                                                                                          workerChoiceStrategy?:
                                                                                                                                              | "FAIR_SHARE"
                                                                                                                                              | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                                                                              | "LEAST_BUSY"
                                                                                                                                              | "LEAST_ELU"
                                                                                                                                              | "LEAST_USED"
                                                                                                                                              | "ROUND_ROBIN"
                                                                                                                                              | "WEIGHTED_ROUND_ROBIN",
                                                                                                                                          workerNodeKeysSet?: ReadonlySet<number>,
                                                                                                                                      ): number;
                                                                                                                                      getPolicy(): StrategyPolicy;
                                                                                                                                      getStrategyRetries(): number;
                                                                                                                                      getTaskStatisticsRequirements(): TaskStatisticsRequirements;
                                                                                                                                      remove(workerNodeKey: number): boolean;
                                                                                                                                      setDefaultWorkerChoiceStrategy(
                                                                                                                                          workerChoiceStrategy:
                                                                                                                                              | "FAIR_SHARE"
                                                                                                                                              | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                                                                              | "LEAST_BUSY"
                                                                                                                                              | "LEAST_ELU"
                                                                                                                                              | "LEAST_USED"
                                                                                                                                              | "ROUND_ROBIN"
                                                                                                                                              | "WEIGHTED_ROUND_ROBIN",
                                                                                                                                          opts?: WorkerChoiceStrategyOptions,
                                                                                                                                      ): void;
                                                                                                                                      setOptions(opts: WorkerChoiceStrategyOptions | undefined): void;
                                                                                                                                      syncWorkerChoiceStrategies(
                                                                                                                                          workerChoiceStrategies: Set<
                                                                                                                                              | "FAIR_SHARE"
                                                                                                                                              | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                                                                              | "LEAST_BUSY"
                                                                                                                                              | "LEAST_ELU"
                                                                                                                                              | "LEAST_USED"
                                                                                                                                              | "ROUND_ROBIN"
                                                                                                                                              | "WEIGHTED_ROUND_ROBIN",
                                                                                                                                          >,
                                                                                                                                          opts?: WorkerChoiceStrategyOptions,
                                                                                                                                      ): void;
                                                                                                                                      update(workerNodeKey: number): boolean;
                                                                                                                                  }

                                                                                                                                  Type Parameters

                                                                                                                                  • Worker extends IWorker

                                                                                                                                    Type of worker.

                                                                                                                                    -
                                                                                                                                  • Data = unknown

                                                                                                                                    Type of data sent to the worker. This can only be structured-cloneable data.

                                                                                                                                    -
                                                                                                                                  • Response = unknown

                                                                                                                                    Type of execution response. This can only be structured-cloneable data.

                                                                                                                                    -
                                                                                                                                  Index

                                                                                                                                  Methods

                                                                                                                                  execute -getPolicy -getStrategyRetries -getTaskStatisticsRequirements -remove -setDefaultWorkerChoiceStrategy -setOptions -syncWorkerChoiceStrategies -update -

                                                                                                                                  Methods

                                                                                                                                  • Executes the given worker choice strategy.

                                                                                                                                    -

                                                                                                                                    Parameters

                                                                                                                                    • workerChoiceStrategy:
                                                                                                                                          | "FAIR_SHARE"
                                                                                                                                          | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                                                                          | "LEAST_BUSY"
                                                                                                                                          | "LEAST_ELU"
                                                                                                                                          | "LEAST_USED"
                                                                                                                                          | "ROUND_ROBIN"
                                                                                                                                          | "WEIGHTED_ROUND_ROBIN" = ...

                                                                                                                                      The worker choice strategy.

                                                                                                                                      -
                                                                                                                                    • OptionalworkerNodeKeysSet: ReadonlySet<number>

                                                                                                                                      The worker node keys affinity set. If undefined, all workers are eligible.

                                                                                                                                      -

                                                                                                                                    Returns number

                                                                                                                                    The key of the worker node.

                                                                                                                                    -

                                                                                                                                    If after computed retries the worker node key is null or undefined.

                                                                                                                                    -

                                                                                                                                  • Sets the default worker choice strategy to use in the context.

                                                                                                                                    -

                                                                                                                                    Parameters

                                                                                                                                    • workerChoiceStrategy:
                                                                                                                                          | "FAIR_SHARE"
                                                                                                                                          | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                                                                          | "LEAST_BUSY"
                                                                                                                                          | "LEAST_ELU"
                                                                                                                                          | "LEAST_USED"
                                                                                                                                          | "ROUND_ROBIN"
                                                                                                                                          | "WEIGHTED_ROUND_ROBIN"

                                                                                                                                      The default worker choice strategy to set.

                                                                                                                                      -
                                                                                                                                    • Optionalopts: WorkerChoiceStrategyOptions

                                                                                                                                      The worker choice strategy options.

                                                                                                                                      -

                                                                                                                                    Returns void

                                                                                                                                  • Synchronizes the active worker choice strategies in the context with the given worker choice strategies.

                                                                                                                                    -

                                                                                                                                    Parameters

                                                                                                                                    • workerChoiceStrategies: Set<
                                                                                                                                          | "FAIR_SHARE"
                                                                                                                                          | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                                                                                                          | "LEAST_BUSY"
                                                                                                                                          | "LEAST_ELU"
                                                                                                                                          | "LEAST_USED"
                                                                                                                                          | "ROUND_ROBIN"
                                                                                                                                          | "WEIGHTED_ROUND_ROBIN",
                                                                                                                                      >

                                                                                                                                      The worker choice strategies to synchronize.

                                                                                                                                      -
                                                                                                                                    • Optionalopts: WorkerChoiceStrategyOptions

                                                                                                                                      The worker choice strategy options.

                                                                                                                                      -

                                                                                                                                    Returns void

                                                                                                                                  Settings

                                                                                                                                  Member Visibility

                                                                                                                                  On This Page

                                                                                                                                  Methods
                                                                                                                                  diff --git a/docs/interfaces/src.WorkerChoiceStrategyOptions.html b/docs/interfaces/src.WorkerChoiceStrategyOptions.html index d1b2fbfea..48960edf8 100644 --- a/docs/interfaces/src.WorkerChoiceStrategyOptions.html +++ b/docs/interfaces/src.WorkerChoiceStrategyOptions.html @@ -1,25 +1,118 @@ -WorkerChoiceStrategyOptions | poolifier - v5.3.2
                                                                                                                                  poolifier - v5.3.2
                                                                                                                                    Preparing search index...

                                                                                                                                    Interface WorkerChoiceStrategyOptions

                                                                                                                                    Worker choice strategy options.

                                                                                                                                    -
                                                                                                                                    interface WorkerChoiceStrategyOptions {
                                                                                                                                        elu?: MeasurementOptions;
                                                                                                                                        measurement?: "elu" | "runTime" | "waitTime";
                                                                                                                                        runTime?: MeasurementOptions;
                                                                                                                                        waitTime?: MeasurementOptions;
                                                                                                                                        weights?: Record<number, number>;
                                                                                                                                    }
                                                                                                                                    Index

                                                                                                                                    Properties

                                                                                                                                    elu? +WorkerChoiceStrategyOptions | poolifier - v5.4.0
                                                                                                                                    +
                                                                                                                                    poolifier - v5.4.0 + +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Preparing search index...
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      + +

                                                                                                                                      Interface WorkerChoiceStrategyOptions

                                                                                                                                      +
                                                                                                                                      +

                                                                                                                                      Worker choice strategy options.

                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      interface WorkerChoiceStrategyOptions {
                                                                                                                                          elu?: MeasurementOptions;
                                                                                                                                          measurement?: "elu" | "runTime" | "waitTime";
                                                                                                                                          runTime?: MeasurementOptions;
                                                                                                                                          waitTime?: MeasurementOptions;
                                                                                                                                          weights?: Record<number, number>;
                                                                                                                                      }
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Index
                                                                                                                                       +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      elu? measurement? runTime? waitTime? weights? -

                                                                                                                                      Properties

                                                                                                                                      elu?: MeasurementOptions

                                                                                                                                      Event loop utilization options.

                                                                                                                                      -
                                                                                                                                      { median: false }
+
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      elu?: MeasurementOptions
                                                                                                                                      +

                                                                                                                                      Event loop utilization options.

                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      { median: false }
                                                                                                                                      -
                                                                                                                                      measurement?: "elu" | "runTime" | "waitTime"

                                                                                                                                      Measurement to use in worker choice strategy supporting it.

                                                                                                                                      -
                                                                                                                                      runTime?: MeasurementOptions

                                                                                                                                      Runtime options.

                                                                                                                                      -
                                                                                                                                      { median: false }
+
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      measurement?: "elu" | "runTime" | "waitTime"
                                                                                                                                      +

                                                                                                                                      Measurement to use in worker choice strategy supporting it.

                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      runTime?: MeasurementOptions
                                                                                                                                      +

                                                                                                                                      Runtime options.

                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      { median: false }
                                                                                                                                      -
                                                                                                                                      waitTime?: MeasurementOptions

                                                                                                                                      Wait time options.

                                                                                                                                      -
                                                                                                                                      { median: false }
+
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      waitTime?: MeasurementOptions
                                                                                                                                      +

                                                                                                                                      Wait time options.

                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      { median: false }
                                                                                                                                      -
                                                                                                                                      weights?: Record<number, number>

                                                                                                                                      Worker weights to use for weighted round robin worker selection strategies. +

                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      weights?: Record<number, number>
                                                                                                                                      +

                                                                                                                                      Worker weights to use for weighted round robin worker selection strategies. A weight is tasks maximum execution time in milliseconds for a worker node.

                                                                                                                                      -
                                                                                                                                      Weights computed automatically given the CPU performance.
+
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Weights computed automatically given the CPU performance.
                                                                                                                                      -

                                                                                                                                      Settings

                                                                                                                                      Member Visibility

                                                                                                                                      On This Page

                                                                                                                                      Properties
                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +

                                                                                                                                      Settings

                                                                                                                                       +
                                                                                                                                      +
                                                                                                                                      Member Visibility +
                                                                                                                                        +
                                                                                                                                        • +
                                                                                                                                        • +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +

                                                                                                                                      On This Page

                                                                                                                                       +
                                                                                                                                      +
                                                                                                                                      Properties +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      diff --git a/docs/interfaces/src.WorkerError.html b/docs/interfaces/src.WorkerError.html index 6b2218094..5a0752ec7 100644 --- a/docs/interfaces/src.WorkerError.html +++ b/docs/interfaces/src.WorkerError.html @@ -1,15 +1,107 @@ -WorkerError | poolifier - v5.3.2
                                                                                                                                      poolifier - v5.3.2
                                                                                                                                        Preparing search index...

                                                                                                                                        Interface WorkerError<Data>

                                                                                                                                        Worker error.

                                                                                                                                        -
                                                                                                                                        interface WorkerError<Data = unknown> {
                                                                                                                                            aborted: boolean;
                                                                                                                                            data?: Data;
                                                                                                                                            error?: Error;
                                                                                                                                            message: string;
                                                                                                                                            name?: string;
                                                                                                                                            stack?: string;
                                                                                                                                        }

                                                                                                                                        Type Parameters

                                                                                                                                        • Data = unknown

                                                                                                                                          Type of data sent to the worker triggering an error. This can only be structured-cloneable data.

                                                                                                                                          -
                                                                                                                                        Index

                                                                                                                                        Properties

                                                                                                                                        aborted +WorkerError | poolifier - v5.4.0
                                                                                                                                        +
                                                                                                                                        poolifier - v5.4.0 + +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          Preparing search index...
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          + +

                                                                                                                                          Interface WorkerError<Data>

                                                                                                                                          +
                                                                                                                                          +

                                                                                                                                          Worker error.

                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          interface WorkerError<Data = unknown> {
                                                                                                                                              aborted: boolean;
                                                                                                                                              data?: Data;
                                                                                                                                              error?: Error;
                                                                                                                                              message: string;
                                                                                                                                              name?: string;
                                                                                                                                              stack?: string;
                                                                                                                                          }
                                                                                                                                          +
                                                                                                                                          +

                                                                                                                                          Type Parameters

                                                                                                                                          +
                                                                                                                                            +
                                                                                                                                          • Data = unknown +

                                                                                                                                            Type of data sent to the worker triggering an error. This can only be structured-cloneable data.

                                                                                                                                            +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          Index
                                                                                                                                           +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          aborted data? error? message name? stack? -

                                                                                                                                          Properties

                                                                                                                                          aborted: boolean

                                                                                                                                          Whether the error is an abort error or not.

                                                                                                                                          -
                                                                                                                                          data?: Data

                                                                                                                                          Data triggering the error.

                                                                                                                                          -
                                                                                                                                          error?: Error

                                                                                                                                          Error object.

                                                                                                                                          -
                                                                                                                                          message: string

                                                                                                                                          Error message.

                                                                                                                                          -
                                                                                                                                          name?: string

                                                                                                                                          Task function name triggering the error.

                                                                                                                                          -
                                                                                                                                          stack?: string

                                                                                                                                          Error stack trace.

                                                                                                                                          -

                                                                                                                                          Settings

                                                                                                                                          Member Visibility

                                                                                                                                          On This Page

                                                                                                                                          Properties
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          aborted: boolean
                                                                                                                                          +

                                                                                                                                          Whether the error is an abort error or not.

                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          data?: Data
                                                                                                                                          +

                                                                                                                                          Data triggering the error.

                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          error?: Error
                                                                                                                                          +

                                                                                                                                          Error object.

                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          message: string
                                                                                                                                          +

                                                                                                                                          Error message.

                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          name?: string
                                                                                                                                          +

                                                                                                                                          Task function name triggering the error.

                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          stack?: string
                                                                                                                                          +

                                                                                                                                          Error stack trace.

                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +

                                                                                                                                          Settings

                                                                                                                                           +
                                                                                                                                          +
                                                                                                                                          Member Visibility +
                                                                                                                                            +
                                                                                                                                            • +
                                                                                                                                            • +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +

                                                                                                                                          On This Page

                                                                                                                                           +
                                                                                                                                          +
                                                                                                                                          Properties +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          diff --git a/docs/interfaces/src.WorkerInfo.html b/docs/interfaces/src.WorkerInfo.html deleted file mode 100644 index 95d2a6638..000000000 --- a/docs/interfaces/src.WorkerInfo.html +++ /dev/null @@ -1,30 +0,0 @@ -WorkerInfo | poolifier - v5.3.2
                                                                                                                                          poolifier - v5.3.2
                                                                                                                                            Preparing search index...

                                                                                                                                            Interface WorkerInfoInternal

                                                                                                                                            Worker information.

                                                                                                                                            -
                                                                                                                                            interface WorkerInfo {
                                                                                                                                                backPressure: boolean;
                                                                                                                                                backPressureStealing: boolean;
                                                                                                                                                continuousStealing: boolean;
                                                                                                                                                dynamic: boolean;
                                                                                                                                                id: number | undefined;
                                                                                                                                                queuedTaskAbortion: boolean;
                                                                                                                                                ready: boolean;
                                                                                                                                                stealing: boolean;
                                                                                                                                                stolen: boolean;
                                                                                                                                                taskFunctionsProperties?: TaskFunctionProperties[];
                                                                                                                                                type: "cluster" | "thread";
                                                                                                                                            }
                                                                                                                                            Index

                                                                                                                                            Properties

                                                                                                                                            backPressure -backPressureStealing -continuousStealing -dynamic -id -queuedTaskAbortion -ready -stealing -stolen -taskFunctionsProperties? -type -

                                                                                                                                            Properties

                                                                                                                                            backPressure: boolean

                                                                                                                                            Back pressure flag. -This flag is set to true when worker node tasks queue is back pressured.

                                                                                                                                            -
                                                                                                                                            backPressureStealing: boolean

                                                                                                                                            Back pressure stealing flag. -This flag is set to true when worker node is stealing one task from another back pressured worker node.

                                                                                                                                            -
                                                                                                                                            continuousStealing: boolean

                                                                                                                                            Continuous stealing flag. -This flag is set to true when worker node is continuously stealing tasks from other worker nodes.

                                                                                                                                            -
                                                                                                                                            dynamic: boolean

                                                                                                                                            Dynamic flag.

                                                                                                                                            -
                                                                                                                                            id: number | undefined

                                                                                                                                            Worker id.

                                                                                                                                            -
                                                                                                                                            queuedTaskAbortion: boolean

                                                                                                                                            Queued task abortion flag. -This flag is set to true when worker node is aborting a queued task.

                                                                                                                                            -
                                                                                                                                            ready: boolean

                                                                                                                                            Ready flag.

                                                                                                                                            -
                                                                                                                                            stealing: boolean

                                                                                                                                            Stealing flag. -This flag is set to true when worker node is stealing one task from another worker node.

                                                                                                                                            -
                                                                                                                                            stolen: boolean

                                                                                                                                            Stolen flag. -This flag is set to true when worker node has one task stolen from another worker node.

                                                                                                                                            -
                                                                                                                                            taskFunctionsProperties?: TaskFunctionProperties[]

                                                                                                                                            Task functions properties.

                                                                                                                                            -
                                                                                                                                            type: "cluster" | "thread"

                                                                                                                                            Worker type.

                                                                                                                                            -

                                                                                                                                            Settings

                                                                                                                                            Member Visibility

                                                                                                                                            On This Page

                                                                                                                                            Properties
                                                                                                                                            diff --git a/docs/interfaces/src.WorkerNodeEventDetail.html b/docs/interfaces/src.WorkerNodeEventDetail.html deleted file mode 100644 index 34a3a94e3..000000000 --- a/docs/interfaces/src.WorkerNodeEventDetail.html +++ /dev/null @@ -1,5 +0,0 @@ -WorkerNodeEventDetail | poolifier - v5.3.2
                                                                                                                                            poolifier - v5.3.2
                                                                                                                                              Preparing search index...

                                                                                                                                              Interface WorkerNodeEventDetailInternal

                                                                                                                                              Worker node event detail.

                                                                                                                                              -
                                                                                                                                              interface WorkerNodeEventDetail {
                                                                                                                                                  taskId?: `${string}-${string}-${string}-${string}-${string}`;
                                                                                                                                                  workerId?: number;
                                                                                                                                                  workerNodeKey?: number;
                                                                                                                                              }
                                                                                                                                              Index

                                                                                                                                              Properties

                                                                                                                                              taskId? -workerId? -workerNodeKey? -

                                                                                                                                              Properties

                                                                                                                                              taskId?: `${string}-${string}-${string}-${string}-${string}`
                                                                                                                                              workerId?: number
                                                                                                                                              workerNodeKey?: number

                                                                                                                                              Settings

                                                                                                                                              Member Visibility

                                                                                                                                              On This Page

                                                                                                                                              Properties
                                                                                                                                              diff --git a/docs/interfaces/src.WorkerNodeOptions.html b/docs/interfaces/src.WorkerNodeOptions.html deleted file mode 100644 index ce535f4f6..000000000 --- a/docs/interfaces/src.WorkerNodeOptions.html +++ /dev/null @@ -1,9 +0,0 @@ -WorkerNodeOptions | poolifier - v5.3.2
                                                                                                                                              poolifier - v5.3.2
                                                                                                                                                Preparing search index...

                                                                                                                                                Interface WorkerNodeOptionsInternal

                                                                                                                                                Worker node options.

                                                                                                                                                -
                                                                                                                                                interface WorkerNodeOptions {
                                                                                                                                                    env?: Record<string, unknown>;
                                                                                                                                                    tasksQueueAgingFactor: number | undefined;
                                                                                                                                                    tasksQueueBackPressureSize: number | undefined;
                                                                                                                                                    tasksQueueBucketSize: number | undefined;
                                                                                                                                                    tasksQueueLoadExponent: number | undefined;
                                                                                                                                                    tasksQueuePriority: boolean | undefined;
                                                                                                                                                    workerOptions?: WorkerOptions;
                                                                                                                                                }
                                                                                                                                                Index

                                                                                                                                                Properties

                                                                                                                                                env? -tasksQueueAgingFactor -tasksQueueBackPressureSize -tasksQueueBucketSize -tasksQueueLoadExponent -tasksQueuePriority -workerOptions? -

                                                                                                                                                Properties

                                                                                                                                                env?: Record<string, unknown>
                                                                                                                                                tasksQueueAgingFactor: number | undefined
                                                                                                                                                tasksQueueBackPressureSize: number | undefined
                                                                                                                                                tasksQueueBucketSize: number | undefined
                                                                                                                                                tasksQueueLoadExponent: number | undefined
                                                                                                                                                tasksQueuePriority: boolean | undefined
                                                                                                                                                workerOptions?: WorkerOptions

                                                                                                                                                Settings

                                                                                                                                                Member Visibility

                                                                                                                                                On This Page

                                                                                                                                                Properties
                                                                                                                                                diff --git a/docs/interfaces/src.WorkerOptions.html b/docs/interfaces/src.WorkerOptions.html index 193895357..f223d46dd 100644 --- a/docs/interfaces/src.WorkerOptions.html +++ b/docs/interfaces/src.WorkerOptions.html @@ -1,19 +1,69 @@ -WorkerOptions | poolifier - v5.3.2
                                                                                                                                                poolifier - v5.3.2
                                                                                                                                                  Preparing search index...

                                                                                                                                                  Interface WorkerOptions

                                                                                                                                                  Options for workers.

                                                                                                                                                  -
                                                                                                                                                  interface WorkerOptions {
                                                                                                                                                      killBehavior?: "HARD" | "SOFT";
                                                                                                                                                      killHandler?: KillHandler;
                                                                                                                                                      maxInactiveTime?: number;
                                                                                                                                                  }
                                                                                                                                                  Index

                                                                                                                                                  Properties

                                                                                                                                                  killBehavior? +WorkerOptions | poolifier - v5.4.0
                                                                                                                                                  +
                                                                                                                                                  poolifier - v5.4.0 + +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Preparing search index...
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    + +

                                                                                                                                                    Interface WorkerOptions

                                                                                                                                                    +
                                                                                                                                                    +

                                                                                                                                                    Options for workers.

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    interface WorkerOptions {
                                                                                                                                                        killBehavior?: "HARD" | "SOFT";
                                                                                                                                                        killHandler?: KillHandler;
                                                                                                                                                        maxInactiveTime?: number;
                                                                                                                                                    }
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Index
                                                                                                                                                     +
                                                                                                                                                    +
                                                                                                                                                    + +
                                                                                                                                                    killBehavior? killHandler? maxInactiveTime? -

                                                                                                                                                    Properties

                                                                                                                                                    killBehavior?: "HARD" | "SOFT"

                                                                                                                                                    killBehavior dictates if your worker will be deleted in case a task is active on it.

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    + +
                                                                                                                                                    +
                                                                                                                                                    + +
                                                                                                                                                    killBehavior?: "HARD" | "SOFT"
                                                                                                                                                    +

                                                                                                                                                    killBehavior dictates if your worker will be deleted in case a task is active on it.

                                                                                                                                                    • SOFT: If currentTime - lastActiveTime is greater than maxInactiveTime but the worker is stealing tasks or a task is executing or queued, then the worker won't be deleted.
                                                                                                                                                    • HARD: If currentTime - lastActiveTime is greater than maxInactiveTime but the worker is stealing tasks or a task is executing or queued, then the worker will be deleted.

                                                                                                                                                    This option only apply to the newly created workers.

                                                                                                                                                    -
                                                                                                                                                    KillBehaviors.SOFT
+
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    KillBehaviors.SOFT
                                                                                                                                                    -
                                                                                                                                                    killHandler?: KillHandler

                                                                                                                                                    The function to call when a worker is killed.

                                                                                                                                                    -

                                                                                                                                                    () => {}

                                                                                                                                                    -
                                                                                                                                                    maxInactiveTime?: number

                                                                                                                                                    Maximum waiting time in milliseconds for tasks on newly created workers. It must be greater or equal than 5.

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    + +
                                                                                                                                                    killHandler?: KillHandler
                                                                                                                                                    +

                                                                                                                                                    The function to call when a worker is killed.

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +

                                                                                                                                                    () => {}

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    + +
                                                                                                                                                    maxInactiveTime?: number
                                                                                                                                                    +

                                                                                                                                                    Maximum waiting time in milliseconds for tasks on newly created workers. It must be greater or equal than 5.

                                                                                                                                                    After this time, newly created workers will be terminated. The last active time of your worker will be updated when it terminates a task.

                                                                                                                                                      @@ -21,7 +71,35 @@ The last active time of your worker will be updated when it terminates a task.
                                                                                                                                                    • If killBehavior is set to KillBehaviors.SOFT your tasks have no timeout and your workers will not be terminated until your task is completed.
                                                                                                                                                    -
                                                                                                                                                    60000
+
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    60000
                                                                                                                                                    -

                                                                                                                                                    Settings

                                                                                                                                                    Member Visibility

                                                                                                                                                    On This Page

                                                                                                                                                    Properties
                                                                                                                                                    + +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +

                                                                                                                                                    Settings

                                                                                                                                                     +
                                                                                                                                                    +
                                                                                                                                                    Member Visibility +
                                                                                                                                                      +
                                                                                                                                                      • +
                                                                                                                                                      • +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +

                                                                                                                                                    On This Page

                                                                                                                                                     +
                                                                                                                                                    +
                                                                                                                                                    Properties +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    diff --git a/docs/interfaces/src.WorkerStatistics.html b/docs/interfaces/src.WorkerStatistics.html deleted file mode 100644 index a49e9eb93..000000000 --- a/docs/interfaces/src.WorkerStatistics.html +++ /dev/null @@ -1,6 +0,0 @@ -WorkerStatistics | poolifier - v5.3.2
                                                                                                                                                    poolifier - v5.3.2
                                                                                                                                                      Preparing search index...

                                                                                                                                                      Interface WorkerStatisticsInternal

                                                                                                                                                      Worker task performance statistics computation settings.

                                                                                                                                                      -
                                                                                                                                                      interface WorkerStatistics {
                                                                                                                                                          elu: boolean;
                                                                                                                                                          runTime: boolean;
                                                                                                                                                      }
                                                                                                                                                      Index

                                                                                                                                                      Properties

                                                                                                                                                      elu -runTime -

                                                                                                                                                      Properties

                                                                                                                                                      elu: boolean

                                                                                                                                                      Whether the worker computes the task event loop utilization (ELU) or not.

                                                                                                                                                      -
                                                                                                                                                      runTime: boolean

                                                                                                                                                      Whether the worker computes the task runtime or not.

                                                                                                                                                      -

                                                                                                                                                      Settings

                                                                                                                                                      Member Visibility

                                                                                                                                                      On This Page

                                                                                                                                                      Properties
                                                                                                                                                      diff --git a/docs/interfaces/src.WorkerUsage.html b/docs/interfaces/src.WorkerUsage.html deleted file mode 100644 index 6850a0cb2..000000000 --- a/docs/interfaces/src.WorkerUsage.html +++ /dev/null @@ -1,10 +0,0 @@ -WorkerUsage | poolifier - v5.3.2
                                                                                                                                                      poolifier - v5.3.2
                                                                                                                                                        Preparing search index...

                                                                                                                                                        Interface WorkerUsageInternal

                                                                                                                                                        Worker usage statistics.

                                                                                                                                                        -
                                                                                                                                                        interface WorkerUsage {
                                                                                                                                                            elu: EventLoopUtilizationMeasurementStatistics;
                                                                                                                                                            runTime: MeasurementStatistics;
                                                                                                                                                            tasks: TaskStatistics;
                                                                                                                                                            waitTime: MeasurementStatistics;
                                                                                                                                                        }
                                                                                                                                                        Index

                                                                                                                                                        Properties

                                                                                                                                                        elu -runTime -tasks -waitTime -

                                                                                                                                                        Properties

                                                                                                                                                        elu: EventLoopUtilizationMeasurementStatistics

                                                                                                                                                        Tasks event loop utilization statistics.

                                                                                                                                                        -
                                                                                                                                                        runTime: MeasurementStatistics

                                                                                                                                                        Tasks runtime statistics.

                                                                                                                                                        -
                                                                                                                                                        tasks: TaskStatistics

                                                                                                                                                        Tasks statistics.

                                                                                                                                                        -
                                                                                                                                                        waitTime: MeasurementStatistics

                                                                                                                                                        Tasks wait time statistics.

                                                                                                                                                        -

                                                                                                                                                        Settings

                                                                                                                                                        Member Visibility

                                                                                                                                                        On This Page

                                                                                                                                                        Properties
                                                                                                                                                        diff --git a/docs/modules/src.html b/docs/modules/src.html index a9d2c82af..7d2dd7092 100644 --- a/docs/modules/src.html +++ b/docs/modules/src.html @@ -1 +1,53 @@ -src | poolifier - v5.3.2
                                                                                                                                                        poolifier - v5.3.2
                                                                                                                                                          Preparing search index...

                                                                                                                                                          Module src

                                                                                                                                                          Classes

                                                                                                                                                          ClusterWorker
                                                                                                                                                          DynamicClusterPool
                                                                                                                                                          DynamicThreadPool
                                                                                                                                                          FixedClusterPool
                                                                                                                                                          FixedThreadPool
                                                                                                                                                          ThreadWorker

                                                                                                                                                          Interfaces

                                                                                                                                                          AbstractPool
                                                                                                                                                          AbstractWorker
                                                                                                                                                          CircularBuffer
                                                                                                                                                          EventLoopUtilizationMeasurementStatistics
                                                                                                                                                          FixedQueueNode
                                                                                                                                                          IFixedQueue
                                                                                                                                                          IPool
                                                                                                                                                          IWorker
                                                                                                                                                          IWorkerChoiceStrategy
                                                                                                                                                          IWorkerNode
                                                                                                                                                          MeasurementOptions
                                                                                                                                                          MeasurementStatistics
                                                                                                                                                          MeasurementStatisticsRequirements
                                                                                                                                                          MessageValue
                                                                                                                                                          PoolInfo
                                                                                                                                                          PoolOptions
                                                                                                                                                          PriorityQueue
                                                                                                                                                          PromiseResponseWrapper
                                                                                                                                                          StrategyData
                                                                                                                                                          StrategyPolicy
                                                                                                                                                          Task
                                                                                                                                                          TaskFunctionObject
                                                                                                                                                          TaskFunctionOperationResult
                                                                                                                                                          TaskFunctionProperties
                                                                                                                                                          TaskPerformance
                                                                                                                                                          TasksQueueOptions
                                                                                                                                                          TaskStatistics
                                                                                                                                                          TaskStatisticsRequirements
                                                                                                                                                          WorkerChoiceStrategiesContext
                                                                                                                                                          WorkerChoiceStrategyOptions
                                                                                                                                                          WorkerError
                                                                                                                                                          WorkerInfo
                                                                                                                                                          WorkerNodeEventDetail
                                                                                                                                                          WorkerNodeOptions
                                                                                                                                                          WorkerOptions
                                                                                                                                                          WorkerStatistics
                                                                                                                                                          WorkerUsage

                                                                                                                                                          Type Aliases

                                                                                                                                                          ClusterPoolOptions
                                                                                                                                                          ErrorHandler
                                                                                                                                                          EventHandler
                                                                                                                                                          ExitHandler
                                                                                                                                                          KillBehavior
                                                                                                                                                          KillHandler
                                                                                                                                                          Measurement
                                                                                                                                                          MessageHandler
                                                                                                                                                          OnlineHandler
                                                                                                                                                          PoolEvent
                                                                                                                                                          PoolType
                                                                                                                                                          TaskAsyncFunction
                                                                                                                                                          TaskFunction
                                                                                                                                                          TaskFunctions
                                                                                                                                                          TaskSyncFunction
                                                                                                                                                          ThreadPoolOptions
                                                                                                                                                          WorkerChoiceStrategy
                                                                                                                                                          WorkerType
                                                                                                                                                          Writable

                                                                                                                                                          Variables

                                                                                                                                                          KillBehaviors
                                                                                                                                                          Measurements
                                                                                                                                                          PoolEvents
                                                                                                                                                          PoolTypes
                                                                                                                                                          WorkerChoiceStrategies
                                                                                                                                                          WorkerTypes

                                                                                                                                                          Functions

                                                                                                                                                          availableParallelism

                                                                                                                                                          Settings

                                                                                                                                                          Member Visibility

                                                                                                                                                          On This Page

                                                                                                                                                          Classes
                                                                                                                                                          Interfaces
                                                                                                                                                          Type Aliases
                                                                                                                                                          Variables
                                                                                                                                                          Functions
                                                                                                                                                          +src | poolifier - v5.4.0
                                                                                                                                                          +
                                                                                                                                                          poolifier - v5.4.0 + +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            Preparing search index...
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Module src

                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            ClusterWorker
                                                                                                                                                            DynamicClusterPool
                                                                                                                                                            DynamicThreadPool
                                                                                                                                                            FixedClusterPool
                                                                                                                                                            FixedThreadPool
                                                                                                                                                            ThreadWorker
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            AbstractPool
                                                                                                                                                            AbstractWorker
                                                                                                                                                            IPool
                                                                                                                                                            IWorker
                                                                                                                                                            MeasurementOptions
                                                                                                                                                            PoolInfo
                                                                                                                                                            PoolOptions
                                                                                                                                                            TaskFunctionObject
                                                                                                                                                            TaskFunctionOperationResult
                                                                                                                                                            TaskFunctionProperties
                                                                                                                                                            TasksQueueOptions
                                                                                                                                                            WorkerChoiceStrategyOptions
                                                                                                                                                            WorkerError
                                                                                                                                                            WorkerOptions
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            ClusterPoolOptions
                                                                                                                                                            ErrorHandler
                                                                                                                                                            EventHandler
                                                                                                                                                            ExitHandler
                                                                                                                                                            KillBehavior
                                                                                                                                                            KillHandler
                                                                                                                                                            Measurement
                                                                                                                                                            MessageHandler
                                                                                                                                                            OnlineHandler
                                                                                                                                                            PoolEvent
                                                                                                                                                            PoolType
                                                                                                                                                            TaskAsyncFunction
                                                                                                                                                            TaskFunction
                                                                                                                                                            TaskFunctions
                                                                                                                                                            TaskSyncFunction
                                                                                                                                                            ThreadPoolOptions
                                                                                                                                                            WorkerChoiceStrategy
                                                                                                                                                            WorkerType
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            KillBehaviors
                                                                                                                                                            Measurements
                                                                                                                                                            PoolEvents
                                                                                                                                                            PoolTypes
                                                                                                                                                            WorkerChoiceStrategies
                                                                                                                                                            WorkerTypes
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            availableParallelism
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +

                                                                                                                                                            Settings

                                                                                                                                                             +
                                                                                                                                                            +
                                                                                                                                                            Member Visibility +
                                                                                                                                                              +
                                                                                                                                                              • +
                                                                                                                                                              • +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +

                                                                                                                                                            On This Page

                                                                                                                                                             +
                                                                                                                                                            +
                                                                                                                                                            Classes +
                                                                                                                                                            +
                                                                                                                                                            Interfaces +
                                                                                                                                                            +
                                                                                                                                                            Type Aliases +
                                                                                                                                                            +
                                                                                                                                                            Variables +
                                                                                                                                                            +
                                                                                                                                                            Functions +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            diff --git a/docs/types/src.ClusterPoolOptions.html b/docs/types/src.ClusterPoolOptions.html index fb0699a6c..49eab7eaf 100644 --- a/docs/types/src.ClusterPoolOptions.html +++ b/docs/types/src.ClusterPoolOptions.html @@ -1,2 +1,36 @@ -ClusterPoolOptions | poolifier - v5.3.2
                                                                                                                                                            poolifier - v5.3.2
                                                                                                                                                              Preparing search index...

                                                                                                                                                              Type Alias ClusterPoolOptions

                                                                                                                                                              ClusterPoolOptions: PoolOptions<Worker>

                                                                                                                                                              Options for a poolifier cluster pool.

                                                                                                                                                              -

                                                                                                                                                              Settings

                                                                                                                                                              Member Visibility
                                                                                                                                                              +ClusterPoolOptions | poolifier - v5.4.0
                                                                                                                                                              +
                                                                                                                                                              poolifier - v5.4.0 + +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                Preparing search index...
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                + +

                                                                                                                                                                Type Alias ClusterPoolOptions

                                                                                                                                                                +
                                                                                                                                                                ClusterPoolOptions: PoolOptions<Worker>
                                                                                                                                                                +

                                                                                                                                                                Options for a poolifier cluster pool.

                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                +

                                                                                                                                                                Settings

                                                                                                                                                                 +
                                                                                                                                                                +
                                                                                                                                                                Member Visibility +
                                                                                                                                                                  +
                                                                                                                                                                  • +
                                                                                                                                                                  • +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                diff --git a/docs/types/src.ErrorHandler.html b/docs/types/src.ErrorHandler.html index 1fdf7ceb9..9822860e2 100644 --- a/docs/types/src.ErrorHandler.html +++ b/docs/types/src.ErrorHandler.html @@ -1,3 +1,55 @@ -ErrorHandler | poolifier - v5.3.2
                                                                                                                                                                poolifier - v5.3.2
                                                                                                                                                                  Preparing search index...

                                                                                                                                                                  Type Alias ErrorHandler<Worker>

                                                                                                                                                                  ErrorHandler: (this: Worker, error: Error) => void

                                                                                                                                                                  Callback invoked if the worker raised an error.

                                                                                                                                                                  -

                                                                                                                                                                  Type Parameters

                                                                                                                                                                  • Worker extends IWorker

                                                                                                                                                                    Type of worker.

                                                                                                                                                                    -

                                                                                                                                                                  Type Declaration

                                                                                                                                                                    • (this: Worker, error: Error): void

                                                                                                                                                                    • Parameters

                                                                                                                                                                      Returns void

                                                                                                                                                                  Settings

                                                                                                                                                                  Member Visibility
                                                                                                                                                                  +ErrorHandler | poolifier - v5.4.0
                                                                                                                                                                  +
                                                                                                                                                                  poolifier - v5.4.0 + +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    Preparing search index...
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    + +

                                                                                                                                                                    Type Alias ErrorHandler<Worker>

                                                                                                                                                                    +
                                                                                                                                                                    ErrorHandler: (this: Worker, error: Error) => void
                                                                                                                                                                    +

                                                                                                                                                                    Callback invoked if the worker raised an error.

                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    +

                                                                                                                                                                    Type Parameters

                                                                                                                                                                    +
                                                                                                                                                                      +
                                                                                                                                                                    • Worker extends IWorker +

                                                                                                                                                                      Type of worker.

                                                                                                                                                                      +
                                                                                                                                                                    +
                                                                                                                                                                    +

                                                                                                                                                                    Type Declaration

                                                                                                                                                                    +
                                                                                                                                                                      +
                                                                                                                                                                    • +
                                                                                                                                                                        +
                                                                                                                                                                      • (this: Worker, error: Error): void
                                                                                                                                                                        • +
                                                                                                                                                                      • +
                                                                                                                                                                        +

                                                                                                                                                                        Parameters

                                                                                                                                                                        +
                                                                                                                                                                        +

                                                                                                                                                                        Returns void

                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    +

                                                                                                                                                                    Settings

                                                                                                                                                                     +
                                                                                                                                                                    +
                                                                                                                                                                    Member Visibility +
                                                                                                                                                                      +
                                                                                                                                                                      • +
                                                                                                                                                                      • +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    diff --git a/docs/types/src.EventHandler.html b/docs/types/src.EventHandler.html index 6687ac38f..33f692a7b 100644 --- a/docs/types/src.EventHandler.html +++ b/docs/types/src.EventHandler.html @@ -1,3 +1,42 @@ -EventHandler | poolifier - v5.3.2
                                                                                                                                                                    poolifier - v5.3.2
                                                                                                                                                                      Preparing search index...

                                                                                                                                                                      Type Alias EventHandler<Worker>

                                                                                                                                                                      EventHandler:
                                                                                                                                                                          | ErrorHandler<Worker>
                                                                                                                                                                          | ExitHandler<Worker>
                                                                                                                                                                          | MessageHandler<Worker>
                                                                                                                                                                          | OnlineHandler<Worker>

                                                                                                                                                                      Worker event handler.

                                                                                                                                                                      -

                                                                                                                                                                      Type Parameters

                                                                                                                                                                      • Worker extends IWorker

                                                                                                                                                                        Type of worker.

                                                                                                                                                                        -

                                                                                                                                                                      Settings

                                                                                                                                                                      Member Visibility
                                                                                                                                                                      +EventHandler | poolifier - v5.4.0
                                                                                                                                                                      +
                                                                                                                                                                      poolifier - v5.4.0 + +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        Preparing search index...
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        + +

                                                                                                                                                                        Type Alias EventHandler<Worker>

                                                                                                                                                                        +
                                                                                                                                                                        EventHandler:
                                                                                                                                                                            | ErrorHandler<Worker>
                                                                                                                                                                            | ExitHandler<Worker>
                                                                                                                                                                            | MessageHandler<Worker>
                                                                                                                                                                            | OnlineHandler<Worker>
                                                                                                                                                                        +

                                                                                                                                                                        Worker event handler.

                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        +

                                                                                                                                                                        Type Parameters

                                                                                                                                                                        +
                                                                                                                                                                          +
                                                                                                                                                                        • Worker extends IWorker +

                                                                                                                                                                          Type of worker.

                                                                                                                                                                          +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        +

                                                                                                                                                                        Settings

                                                                                                                                                                         +
                                                                                                                                                                        +
                                                                                                                                                                        Member Visibility +
                                                                                                                                                                          +
                                                                                                                                                                          • +
                                                                                                                                                                          • +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        diff --git a/docs/types/src.ExitHandler.html b/docs/types/src.ExitHandler.html index b5effb805..46f60166f 100644 --- a/docs/types/src.ExitHandler.html +++ b/docs/types/src.ExitHandler.html @@ -1,3 +1,55 @@ -ExitHandler | poolifier - v5.3.2
                                                                                                                                                                        poolifier - v5.3.2
                                                                                                                                                                          Preparing search index...

                                                                                                                                                                          Type Alias ExitHandler<Worker>

                                                                                                                                                                          ExitHandler: (this: Worker, exitCode: number) => void

                                                                                                                                                                          Callback invoked when the worker exits successfully.

                                                                                                                                                                          -

                                                                                                                                                                          Type Parameters

                                                                                                                                                                          • Worker extends IWorker

                                                                                                                                                                            Type of worker.

                                                                                                                                                                            -

                                                                                                                                                                          Type Declaration

                                                                                                                                                                            • (this: Worker, exitCode: number): void

                                                                                                                                                                            • Parameters

                                                                                                                                                                              Returns void

                                                                                                                                                                          Settings

                                                                                                                                                                          Member Visibility
                                                                                                                                                                          +ExitHandler | poolifier - v5.4.0
                                                                                                                                                                          +
                                                                                                                                                                          poolifier - v5.4.0 + +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Preparing search index...
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            + +

                                                                                                                                                                            Type Alias ExitHandler<Worker>

                                                                                                                                                                            +
                                                                                                                                                                            ExitHandler: (this: Worker, exitCode: number) => void
                                                                                                                                                                            +

                                                                                                                                                                            Callback invoked when the worker exits successfully.

                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            +

                                                                                                                                                                            Type Parameters

                                                                                                                                                                            +
                                                                                                                                                                              +
                                                                                                                                                                            • Worker extends IWorker +

                                                                                                                                                                              Type of worker.

                                                                                                                                                                              +
                                                                                                                                                                            +
                                                                                                                                                                            +

                                                                                                                                                                            Type Declaration

                                                                                                                                                                            +
                                                                                                                                                                              +
                                                                                                                                                                            • +
                                                                                                                                                                                +
                                                                                                                                                                              • (this: Worker, exitCode: number): void
                                                                                                                                                                                • +
                                                                                                                                                                              • +
                                                                                                                                                                                +

                                                                                                                                                                                Parameters

                                                                                                                                                                                +
                                                                                                                                                                                  +
                                                                                                                                                                                • this: Worker
                                                                                                                                                                                  • +
                                                                                                                                                                                • exitCode: number
                                                                                                                                                                                +

                                                                                                                                                                                Returns void

                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            +

                                                                                                                                                                            Settings

                                                                                                                                                                             +
                                                                                                                                                                            +
                                                                                                                                                                            Member Visibility +
                                                                                                                                                                              +
                                                                                                                                                                              • +
                                                                                                                                                                              • +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            diff --git a/docs/types/src.KillBehavior.html b/docs/types/src.KillBehavior.html index 507cd77dd..ee29d239d 100644 --- a/docs/types/src.KillBehavior.html +++ b/docs/types/src.KillBehavior.html @@ -1,2 +1,36 @@ -KillBehavior | poolifier - v5.3.2
                                                                                                                                                                            poolifier - v5.3.2
                                                                                                                                                                              Preparing search index...

                                                                                                                                                                              Type Alias KillBehavior

                                                                                                                                                                              KillBehavior: keyof typeof KillBehaviors

                                                                                                                                                                              Kill behavior.

                                                                                                                                                                              -

                                                                                                                                                                              Settings

                                                                                                                                                                              Member Visibility
                                                                                                                                                                              +KillBehavior | poolifier - v5.4.0
                                                                                                                                                                              +
                                                                                                                                                                              poolifier - v5.4.0 + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + +

                                                                                                                                                                                Type Alias KillBehavior

                                                                                                                                                                                +
                                                                                                                                                                                KillBehavior: keyof typeof KillBehaviors
                                                                                                                                                                                +

                                                                                                                                                                                Kill behavior.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Settings

                                                                                                                                                                                 +
                                                                                                                                                                                +
                                                                                                                                                                                Member Visibility +
                                                                                                                                                                                  +
                                                                                                                                                                                  • +
                                                                                                                                                                                  • +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                diff --git a/docs/types/src.KillHandler.html b/docs/types/src.KillHandler.html index e1e47ab2d..fe6b2c061 100644 --- a/docs/types/src.KillHandler.html +++ b/docs/types/src.KillHandler.html @@ -1,2 +1,44 @@ -KillHandler | poolifier - v5.3.2
                                                                                                                                                                                poolifier - v5.3.2
                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                  Type Alias KillHandler

                                                                                                                                                                                  KillHandler: () => Promise<void> | void

                                                                                                                                                                                  Handler called when a worker is killed.

                                                                                                                                                                                  -

                                                                                                                                                                                  Type Declaration

                                                                                                                                                                                    • (): Promise<void> | void

                                                                                                                                                                                    • Returns Promise<void> | void

                                                                                                                                                                                  Settings

                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                  +KillHandler | poolifier - v5.4.0
                                                                                                                                                                                  +
                                                                                                                                                                                  poolifier - v5.4.0 + +
                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    + +

                                                                                                                                                                                    Type Alias KillHandler

                                                                                                                                                                                    +
                                                                                                                                                                                    KillHandler: () => Promise<void> | void
                                                                                                                                                                                    +

                                                                                                                                                                                    Handler called when a worker is killed.

                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    +

                                                                                                                                                                                    Type Declaration

                                                                                                                                                                                    +
                                                                                                                                                                                      +
                                                                                                                                                                                    • +
                                                                                                                                                                                        +
                                                                                                                                                                                      • (): Promise<void> | void
                                                                                                                                                                                        • +
                                                                                                                                                                                      • +

                                                                                                                                                                                        Returns Promise<void> | void

                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    +

                                                                                                                                                                                    Settings

                                                                                                                                                                                     +
                                                                                                                                                                                    +
                                                                                                                                                                                    Member Visibility +
                                                                                                                                                                                      +
                                                                                                                                                                                      • +
                                                                                                                                                                                      • +
                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    diff --git a/docs/types/src.Measurement.html b/docs/types/src.Measurement.html index 438812512..330fbb48d 100644 --- a/docs/types/src.Measurement.html +++ b/docs/types/src.Measurement.html @@ -1,2 +1,36 @@ -Measurement | poolifier - v5.3.2
                                                                                                                                                                                    poolifier - v5.3.2
                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                      Type Alias Measurement

                                                                                                                                                                                      Measurement: keyof typeof Measurements

                                                                                                                                                                                      Measurement.

                                                                                                                                                                                      -

                                                                                                                                                                                      Settings

                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                      +Measurement | poolifier - v5.4.0
                                                                                                                                                                                      +
                                                                                                                                                                                      poolifier - v5.4.0 + +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        + +

                                                                                                                                                                                        Type Alias Measurement

                                                                                                                                                                                        +
                                                                                                                                                                                        Measurement: keyof typeof Measurements
                                                                                                                                                                                        +

                                                                                                                                                                                        Measurement.

                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        +

                                                                                                                                                                                        Settings

                                                                                                                                                                                         +
                                                                                                                                                                                        +
                                                                                                                                                                                        Member Visibility +
                                                                                                                                                                                          +
                                                                                                                                                                                          • +
                                                                                                                                                                                          • +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        diff --git a/docs/types/src.MessageHandler.html b/docs/types/src.MessageHandler.html index 677187a6c..354d320a5 100644 --- a/docs/types/src.MessageHandler.html +++ b/docs/types/src.MessageHandler.html @@ -1,3 +1,55 @@ -MessageHandler | poolifier - v5.3.2
                                                                                                                                                                                        poolifier - v5.3.2
                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                          Type Alias MessageHandler<Worker>

                                                                                                                                                                                          MessageHandler: (this: Worker, message: unknown) => void

                                                                                                                                                                                          Callback invoked if the worker has received a message.

                                                                                                                                                                                          -

                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                          • Worker extends IWorker

                                                                                                                                                                                            Type of worker.

                                                                                                                                                                                            -

                                                                                                                                                                                          Type Declaration

                                                                                                                                                                                            • (this: Worker, message: unknown): void

                                                                                                                                                                                            • Parameters

                                                                                                                                                                                              Returns void

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                          +MessageHandler | poolifier - v5.4.0
                                                                                                                                                                                          +
                                                                                                                                                                                          poolifier - v5.4.0 + +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            + +

                                                                                                                                                                                            Type Alias MessageHandler<Worker>

                                                                                                                                                                                            +
                                                                                                                                                                                            MessageHandler: (this: Worker, message: unknown) => void
                                                                                                                                                                                            +

                                                                                                                                                                                            Callback invoked if the worker has received a message.

                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            +

                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                            +
                                                                                                                                                                                              +
                                                                                                                                                                                            • Worker extends IWorker +

                                                                                                                                                                                              Type of worker.

                                                                                                                                                                                              +
                                                                                                                                                                                            +
                                                                                                                                                                                            +

                                                                                                                                                                                            Type Declaration

                                                                                                                                                                                            +
                                                                                                                                                                                              +
                                                                                                                                                                                            • +
                                                                                                                                                                                                +
                                                                                                                                                                                              • (this: Worker, message: unknown): void
                                                                                                                                                                                                • +
                                                                                                                                                                                              • +
                                                                                                                                                                                                +

                                                                                                                                                                                                Parameters

                                                                                                                                                                                                +
                                                                                                                                                                                                  +
                                                                                                                                                                                                • this: Worker
                                                                                                                                                                                                  • +
                                                                                                                                                                                                • message: unknown
                                                                                                                                                                                                +

                                                                                                                                                                                                Returns void

                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            +

                                                                                                                                                                                            Settings

                                                                                                                                                                                             +
                                                                                                                                                                                            +
                                                                                                                                                                                            Member Visibility +
                                                                                                                                                                                              +
                                                                                                                                                                                              • +
                                                                                                                                                                                              • +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            diff --git a/docs/types/src.OnlineHandler.html b/docs/types/src.OnlineHandler.html index c95e2ad5b..eb1007886 100644 --- a/docs/types/src.OnlineHandler.html +++ b/docs/types/src.OnlineHandler.html @@ -1,3 +1,54 @@ -OnlineHandler | poolifier - v5.3.2
                                                                                                                                                                                            poolifier - v5.3.2
                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                              Type Alias OnlineHandler<Worker>

                                                                                                                                                                                              OnlineHandler: (this: Worker) => void

                                                                                                                                                                                              Callback invoked when the worker has started successfully.

                                                                                                                                                                                              -

                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                              • Worker extends IWorker

                                                                                                                                                                                                Type of worker.

                                                                                                                                                                                                -

                                                                                                                                                                                              Type Declaration

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                              +OnlineHandler | poolifier - v5.4.0
                                                                                                                                                                                              +
                                                                                                                                                                                              poolifier - v5.4.0 + +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                + +

                                                                                                                                                                                                Type Alias OnlineHandler<Worker>

                                                                                                                                                                                                +
                                                                                                                                                                                                OnlineHandler: (this: Worker) => void
                                                                                                                                                                                                +

                                                                                                                                                                                                Callback invoked when the worker has started successfully.

                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                +

                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                +
                                                                                                                                                                                                  +
                                                                                                                                                                                                • Worker extends IWorker +

                                                                                                                                                                                                  Type of worker.

                                                                                                                                                                                                  +
                                                                                                                                                                                                +
                                                                                                                                                                                                +

                                                                                                                                                                                                Type Declaration

                                                                                                                                                                                                +
                                                                                                                                                                                                  +
                                                                                                                                                                                                • +
                                                                                                                                                                                                    +
                                                                                                                                                                                                  • (this: Worker): void
                                                                                                                                                                                                    • +
                                                                                                                                                                                                  • +
                                                                                                                                                                                                    +

                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                    +
                                                                                                                                                                                                    +

                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                +

                                                                                                                                                                                                Settings

                                                                                                                                                                                                 +
                                                                                                                                                                                                +
                                                                                                                                                                                                Member Visibility +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  • +
                                                                                                                                                                                                  • +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                diff --git a/docs/types/src.PoolEvent.html b/docs/types/src.PoolEvent.html index 10af6d979..0e614fc71 100644 --- a/docs/types/src.PoolEvent.html +++ b/docs/types/src.PoolEvent.html @@ -1,2 +1,36 @@ -PoolEvent | poolifier - v5.3.2
                                                                                                                                                                                                poolifier - v5.3.2
                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                  Type Alias PoolEvent

                                                                                                                                                                                                  PoolEvent: keyof typeof PoolEvents

                                                                                                                                                                                                  Pool event.

                                                                                                                                                                                                  -

                                                                                                                                                                                                  Settings

                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                  +PoolEvent | poolifier - v5.4.0
                                                                                                                                                                                                  +
                                                                                                                                                                                                  poolifier - v5.4.0 + +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    + +

                                                                                                                                                                                                    Type Alias PoolEvent

                                                                                                                                                                                                    +
                                                                                                                                                                                                    PoolEvent: keyof typeof PoolEvents
                                                                                                                                                                                                    +

                                                                                                                                                                                                    Pool event.

                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +

                                                                                                                                                                                                    Settings

                                                                                                                                                                                                     +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    Member Visibility +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      • +
                                                                                                                                                                                                      • +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    diff --git a/docs/types/src.PoolType.html b/docs/types/src.PoolType.html index 2054a97c4..0cbdc6e98 100644 --- a/docs/types/src.PoolType.html +++ b/docs/types/src.PoolType.html @@ -1,2 +1,36 @@ -PoolType | poolifier - v5.3.2
                                                                                                                                                                                                    poolifier - v5.3.2
                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                      Type Alias PoolType

                                                                                                                                                                                                      PoolType: keyof typeof PoolTypes

                                                                                                                                                                                                      Pool type.

                                                                                                                                                                                                      -

                                                                                                                                                                                                      Settings

                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                      +PoolType | poolifier - v5.4.0
                                                                                                                                                                                                      +
                                                                                                                                                                                                      poolifier - v5.4.0 + +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + +

                                                                                                                                                                                                        Type Alias PoolType

                                                                                                                                                                                                        +
                                                                                                                                                                                                        PoolType: keyof typeof PoolTypes
                                                                                                                                                                                                        +

                                                                                                                                                                                                        Pool type.

                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +

                                                                                                                                                                                                        Settings

                                                                                                                                                                                                         +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Member Visibility +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          • +
                                                                                                                                                                                                          • +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        diff --git a/docs/types/src.TaskAsyncFunction.html b/docs/types/src.TaskAsyncFunction.html index 89edadd8d..30ba87bd9 100644 --- a/docs/types/src.TaskAsyncFunction.html +++ b/docs/types/src.TaskAsyncFunction.html @@ -1,7 +1,61 @@ -TaskAsyncFunction | poolifier - v5.3.2
                                                                                                                                                                                                        poolifier - v5.3.2
                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                          Type Alias TaskAsyncFunction<Data, Response>

                                                                                                                                                                                                          TaskAsyncFunction: (data?: Data) => Promise<Response>

                                                                                                                                                                                                          Task asynchronous function that can be executed. +TaskAsyncFunction | poolifier - v5.4.0

                                                                                                                                                                                                          +
                                                                                                                                                                                                          poolifier - v5.4.0 + +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            + +

                                                                                                                                                                                                            Type Alias TaskAsyncFunction<Data, Response>

                                                                                                                                                                                                            +
                                                                                                                                                                                                            TaskAsyncFunction: (data?: Data) => Promise<Response>
                                                                                                                                                                                                            +

                                                                                                                                                                                                            Task asynchronous function that can be executed. This function must return a promise.

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                            • Data = unknown

                                                                                                                                                                                                              Type of data sent to the worker. This can only be structured-cloneable data.

                                                                                                                                                                                                              -
                                                                                                                                                                                                            • Response = unknown

                                                                                                                                                                                                              Type of execution response. This can only be structured-cloneable data.

                                                                                                                                                                                                              -

                                                                                                                                                                                                            Type Declaration

                                                                                                                                                                                                              • (data?: Data): Promise<Response>

                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                • Optionaldata: Data

                                                                                                                                                                                                                  Data sent to the worker.

                                                                                                                                                                                                                  -

                                                                                                                                                                                                                Returns Promise<Response>

                                                                                                                                                                                                                Execution response promise.

                                                                                                                                                                                                                -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +

                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                            +
                                                                                                                                                                                                              +
                                                                                                                                                                                                            • Data = unknown +

                                                                                                                                                                                                              Type of data sent to the worker. This can only be structured-cloneable data.

                                                                                                                                                                                                              +
                                                                                                                                                                                                              • +
                                                                                                                                                                                                            • Response = unknown +

                                                                                                                                                                                                              Type of execution response. This can only be structured-cloneable data.

                                                                                                                                                                                                              +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +

                                                                                                                                                                                                            Type Declaration

                                                                                                                                                                                                            +
                                                                                                                                                                                                              +
                                                                                                                                                                                                            • +
                                                                                                                                                                                                                +
                                                                                                                                                                                                              • (data?: Data): Promise<Response>
                                                                                                                                                                                                                • +
                                                                                                                                                                                                              • +
                                                                                                                                                                                                                +

                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                • Optionaldata: Data +

                                                                                                                                                                                                                  Data sent to the worker.

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                +

                                                                                                                                                                                                                Returns Promise<Response>

                                                                                                                                                                                                                Execution response promise.

                                                                                                                                                                                                                +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                             +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Member Visibility +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              • +
                                                                                                                                                                                                              • +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            diff --git a/docs/types/src.TaskFunction.html b/docs/types/src.TaskFunction.html index 1c0b87ffd..74541edfb 100644 --- a/docs/types/src.TaskFunction.html +++ b/docs/types/src.TaskFunction.html @@ -1,5 +1,46 @@ -TaskFunction | poolifier - v5.3.2
                                                                                                                                                                                                            poolifier - v5.3.2
                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                              Type Alias TaskFunction<Data, Response>

                                                                                                                                                                                                              TaskFunction:
                                                                                                                                                                                                                  | TaskAsyncFunction<Data, Response>
                                                                                                                                                                                                                  | TaskSyncFunction<Data, Response>

                                                                                                                                                                                                              Task function that can be executed. +TaskFunction | poolifier - v5.4.0

                                                                                                                                                                                                              +
                                                                                                                                                                                                              poolifier - v5.4.0 + +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                + +

                                                                                                                                                                                                                Type Alias TaskFunction<Data, Response>

                                                                                                                                                                                                                +
                                                                                                                                                                                                                TaskFunction:
                                                                                                                                                                                                                    | TaskAsyncFunction<Data, Response>
                                                                                                                                                                                                                    | TaskSyncFunction<Data, Response>
                                                                                                                                                                                                                +

                                                                                                                                                                                                                Task function that can be executed. This function can be synchronous or asynchronous.

                                                                                                                                                                                                                -

                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                • Data = unknown

                                                                                                                                                                                                                  Type of data sent to the worker. This can only be structured-cloneable data.

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                • Response = unknown

                                                                                                                                                                                                                  Type of execution response. This can only be structured-cloneable data.

                                                                                                                                                                                                                  -

                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +

                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                • Data = unknown +

                                                                                                                                                                                                                  Type of data sent to the worker. This can only be structured-cloneable data.

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                • Response = unknown +

                                                                                                                                                                                                                  Type of execution response. This can only be structured-cloneable data.

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +

                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                 +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                Member Visibility +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                diff --git a/docs/types/src.TaskFunctions.html b/docs/types/src.TaskFunctions.html index 01fa7798b..24463926d 100644 --- a/docs/types/src.TaskFunctions.html +++ b/docs/types/src.TaskFunctions.html @@ -1,6 +1,47 @@ -TaskFunctions | poolifier - v5.3.2
                                                                                                                                                                                                                poolifier - v5.3.2
                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                  Type Alias TaskFunctions<Data, Response>

                                                                                                                                                                                                                  TaskFunctions: Record<
                                                                                                                                                                                                                      string,
                                                                                                                                                                                                                      TaskFunction<Data, Response>
                                                                                                                                                                                                                      | TaskFunctionObject<Data, Response>,
                                                                                                                                                                                                                  >

                                                                                                                                                                                                                  Tasks functions that can be executed. +TaskFunctions | poolifier - v5.4.0

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  poolifier - v5.4.0 + +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                    Type Alias TaskFunctions<Data, Response>

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    TaskFunctions: Record<
                                                                                                                                                                                                                        string,
                                                                                                                                                                                                                        TaskFunction<Data, Response>
                                                                                                                                                                                                                        | TaskFunctionObject<Data, Response>,
                                                                                                                                                                                                                    >
                                                                                                                                                                                                                    +

                                                                                                                                                                                                                    Tasks functions that can be executed. The key is the name of the task function or task function object. The value is the task function or task function object.

                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                    • Data = unknown

                                                                                                                                                                                                                      Type of data sent to the worker. This can only be structured-cloneable data.

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Response = unknown

                                                                                                                                                                                                                      Type of execution response. This can only be structured-cloneable data.

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +

                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                    • Data = unknown +

                                                                                                                                                                                                                      Type of data sent to the worker. This can only be structured-cloneable data.

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                    • Response = unknown +

                                                                                                                                                                                                                      Type of execution response. This can only be structured-cloneable data.

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +

                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                     +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    Member Visibility +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    diff --git a/docs/types/src.TaskSyncFunction.html b/docs/types/src.TaskSyncFunction.html index ab29f80c8..0f8208b60 100644 --- a/docs/types/src.TaskSyncFunction.html +++ b/docs/types/src.TaskSyncFunction.html @@ -1,6 +1,60 @@ -TaskSyncFunction | poolifier - v5.3.2
                                                                                                                                                                                                                    poolifier - v5.3.2
                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                      Type Alias TaskSyncFunction<Data, Response>

                                                                                                                                                                                                                      TaskSyncFunction: (data?: Data) => Response

                                                                                                                                                                                                                      Task synchronous function that can be executed.

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                      • Data = unknown

                                                                                                                                                                                                                        Type of data sent to the worker. This can only be structured-cloneable data.

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • Response = unknown

                                                                                                                                                                                                                        Type of execution response. This can only be structured-cloneable data.

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                      Type Declaration

                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                      +TaskSyncFunction | poolifier - v5.4.0
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      poolifier - v5.4.0 + +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                        Type Alias TaskSyncFunction<Data, Response>

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        TaskSyncFunction: (data?: Data) => Response
                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        Task synchronous function that can be executed.

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                        • Data = unknown +

                                                                                                                                                                                                                          Type of data sent to the worker. This can only be structured-cloneable data.

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                        • Response = unknown +

                                                                                                                                                                                                                          Type of execution response. This can only be structured-cloneable data.

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        Type Declaration

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                          • (data?: Data): Response
                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                            +

                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                            • Optionaldata: Data +

                                                                                                                                                                                                                              Data sent to the worker.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                            +

                                                                                                                                                                                                                            Returns Response

                                                                                                                                                                                                                            Execution response.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                         +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Member Visibility +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        diff --git a/docs/types/src.ThreadPoolOptions.html b/docs/types/src.ThreadPoolOptions.html index e73116772..90a160eb1 100644 --- a/docs/types/src.ThreadPoolOptions.html +++ b/docs/types/src.ThreadPoolOptions.html @@ -1,2 +1,36 @@ -ThreadPoolOptions | poolifier - v5.3.2
                                                                                                                                                                                                                        poolifier - v5.3.2
                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                          Type Alias ThreadPoolOptions

                                                                                                                                                                                                                          ThreadPoolOptions: PoolOptions<Worker>

                                                                                                                                                                                                                          Options for a poolifier thread pool.

                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                          +ThreadPoolOptions | poolifier - v5.4.0
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          poolifier - v5.4.0 + +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                            Type Alias ThreadPoolOptions

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            ThreadPoolOptions: PoolOptions<Worker>
                                                                                                                                                                                                                            +

                                                                                                                                                                                                                            Options for a poolifier thread pool.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +

                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                             +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            Member Visibility +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            diff --git a/docs/types/src.WorkerChoiceStrategy.html b/docs/types/src.WorkerChoiceStrategy.html index 7ff9a9782..dce2f7f70 100644 --- a/docs/types/src.WorkerChoiceStrategy.html +++ b/docs/types/src.WorkerChoiceStrategy.html @@ -1,2 +1,36 @@ -WorkerChoiceStrategy | poolifier - v5.3.2
                                                                                                                                                                                                                            poolifier - v5.3.2
                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                              Type Alias WorkerChoiceStrategy

                                                                                                                                                                                                                              WorkerChoiceStrategy: keyof typeof WorkerChoiceStrategies

                                                                                                                                                                                                                              Worker choice strategy.

                                                                                                                                                                                                                              -

                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                              +WorkerChoiceStrategy | poolifier - v5.4.0
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              poolifier - v5.4.0 + +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                Type Alias WorkerChoiceStrategy

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                WorkerChoiceStrategy: keyof typeof WorkerChoiceStrategies
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Worker choice strategy.

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Member Visibility +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                diff --git a/docs/types/src.WorkerType.html b/docs/types/src.WorkerType.html index 30a87593c..ad730037c 100644 --- a/docs/types/src.WorkerType.html +++ b/docs/types/src.WorkerType.html @@ -1,2 +1,36 @@ -WorkerType | poolifier - v5.3.2
                                                                                                                                                                                                                                poolifier - v5.3.2
                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                  Type Alias WorkerType

                                                                                                                                                                                                                                  WorkerType: keyof typeof WorkerTypes

                                                                                                                                                                                                                                  Worker type.

                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                  +WorkerType | poolifier - v5.4.0
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  poolifier - v5.4.0 + +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    Type Alias WorkerType

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    WorkerType: keyof typeof WorkerTypes
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Worker type.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    Member Visibility +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    diff --git a/docs/types/src.Writable.html b/docs/types/src.Writable.html deleted file mode 100644 index 4a3e9544d..000000000 --- a/docs/types/src.Writable.html +++ /dev/null @@ -1,3 +0,0 @@ -Writable | poolifier - v5.3.2
                                                                                                                                                                                                                                    poolifier - v5.3.2
                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                      Type Alias Writable<T>Internal

                                                                                                                                                                                                                                      Writable: { -readonly [P in keyof T]: T[P] }

                                                                                                                                                                                                                                      Remove readonly modifier from all properties of T.

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                        Type to remove readonly modifier.

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                      diff --git a/docs/variables/src.KillBehaviors.html b/docs/variables/src.KillBehaviors.html index 16dbfa57e..2c8aa5e12 100644 --- a/docs/variables/src.KillBehaviors.html +++ b/docs/variables/src.KillBehaviors.html @@ -1,2 +1,36 @@ -KillBehaviors | poolifier - v5.3.2
                                                                                                                                                                                                                                      poolifier - v5.3.2
                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                        Variable KillBehaviorsConst

                                                                                                                                                                                                                                        KillBehaviors: Readonly<{ HARD: "HARD"; SOFT: "SOFT" }> = ...

                                                                                                                                                                                                                                        Enumeration of kill behaviors.

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                        +KillBehaviors | poolifier - v5.4.0
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        poolifier - v5.4.0 + +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                          Variable KillBehaviorsConst

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          KillBehaviors: Readonly<{ HARD: "HARD"; SOFT: "SOFT" }> = ...
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          Enumeration of kill behaviors.

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          diff --git a/docs/variables/src.Measurements.html b/docs/variables/src.Measurements.html index ce02bdcc3..ef79428f7 100644 --- a/docs/variables/src.Measurements.html +++ b/docs/variables/src.Measurements.html @@ -1,2 +1,36 @@ -Measurements | poolifier - v5.3.2
                                                                                                                                                                                                                                          poolifier - v5.3.2
                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                            Variable MeasurementsConst

                                                                                                                                                                                                                                            Measurements: Readonly<{ elu: "elu"; runTime: "runTime"; waitTime: "waitTime" }> = ...

                                                                                                                                                                                                                                            Enumeration of measurements.

                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                            +Measurements | poolifier - v5.4.0
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            poolifier - v5.4.0 + +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                              Variable MeasurementsConst

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              Measurements: Readonly<{ elu: "elu"; runTime: "runTime"; waitTime: "waitTime" }> = ...
                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Enumeration of measurements.

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              diff --git a/docs/variables/src.PoolEvents.html b/docs/variables/src.PoolEvents.html index e86d1f27f..cba1c1f4c 100644 --- a/docs/variables/src.PoolEvents.html +++ b/docs/variables/src.PoolEvents.html @@ -1,2 +1,36 @@ -PoolEvents | poolifier - v5.3.2
                                                                                                                                                                                                                                              poolifier - v5.3.2
                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                Variable PoolEventsConst

                                                                                                                                                                                                                                                PoolEvents: Readonly<
                                                                                                                                                                                                                                                    {
                                                                                                                                                                                                                                                        backPressure: "backPressure";
                                                                                                                                                                                                                                                        backPressureEnd: "backPressureEnd";
                                                                                                                                                                                                                                                        busy: "busy";
                                                                                                                                                                                                                                                        busyEnd: "busyEnd";
                                                                                                                                                                                                                                                        destroy: "destroy";
                                                                                                                                                                                                                                                        empty: "empty";
                                                                                                                                                                                                                                                        error: "error";
                                                                                                                                                                                                                                                        full: "full";
                                                                                                                                                                                                                                                        fullEnd: "fullEnd";
                                                                                                                                                                                                                                                        ready: "ready";
                                                                                                                                                                                                                                                        taskError: "taskError";
                                                                                                                                                                                                                                                    },
                                                                                                                                                                                                                                                > = ...

                                                                                                                                                                                                                                                Enumeration of pool events.

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                +PoolEvents | poolifier - v5.4.0
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                poolifier - v5.4.0 + +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                  Variable PoolEventsConst

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  PoolEvents: Readonly<
                                                                                                                                                                                                                                                      {
                                                                                                                                                                                                                                                          backPressure: "backPressure";
                                                                                                                                                                                                                                                          backPressureEnd: "backPressureEnd";
                                                                                                                                                                                                                                                          busy: "busy";
                                                                                                                                                                                                                                                          busyEnd: "busyEnd";
                                                                                                                                                                                                                                                          destroy: "destroy";
                                                                                                                                                                                                                                                          empty: "empty";
                                                                                                                                                                                                                                                          error: "error";
                                                                                                                                                                                                                                                          full: "full";
                                                                                                                                                                                                                                                          fullEnd: "fullEnd";
                                                                                                                                                                                                                                                          ready: "ready";
                                                                                                                                                                                                                                                          taskError: "taskError";
                                                                                                                                                                                                                                                      },
                                                                                                                                                                                                                                                  > = ...
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  Enumeration of pool events.

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  diff --git a/docs/variables/src.PoolTypes.html b/docs/variables/src.PoolTypes.html index 2c783487c..aa9bb6fb9 100644 --- a/docs/variables/src.PoolTypes.html +++ b/docs/variables/src.PoolTypes.html @@ -1,2 +1,36 @@ -PoolTypes | poolifier - v5.3.2
                                                                                                                                                                                                                                                  poolifier - v5.3.2
                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                    Variable PoolTypesConst

                                                                                                                                                                                                                                                    PoolTypes: Readonly<{ dynamic: "dynamic"; fixed: "fixed" }> = ...

                                                                                                                                                                                                                                                    Enumeration of pool types.

                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                    +PoolTypes | poolifier - v5.4.0
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    poolifier - v5.4.0 + +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                      Variable PoolTypesConst

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      PoolTypes: Readonly<{ dynamic: "dynamic"; fixed: "fixed" }> = ...
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Enumeration of pool types.

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      diff --git a/docs/variables/src.WorkerChoiceStrategies.html b/docs/variables/src.WorkerChoiceStrategies.html index 4730b90c8..e1fb0dac6 100644 --- a/docs/variables/src.WorkerChoiceStrategies.html +++ b/docs/variables/src.WorkerChoiceStrategies.html @@ -1,2 +1,36 @@ -WorkerChoiceStrategies | poolifier - v5.3.2
                                                                                                                                                                                                                                                      poolifier - v5.3.2
                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                        Variable WorkerChoiceStrategiesConst

                                                                                                                                                                                                                                                        WorkerChoiceStrategies: Readonly<
                                                                                                                                                                                                                                                            {
                                                                                                                                                                                                                                                                FAIR_SHARE: "FAIR_SHARE";
                                                                                                                                                                                                                                                                INTERLEAVED_WEIGHTED_ROUND_ROBIN: "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
                                                                                                                                                                                                                                                                LEAST_BUSY: "LEAST_BUSY";
                                                                                                                                                                                                                                                                LEAST_ELU: "LEAST_ELU";
                                                                                                                                                                                                                                                                LEAST_USED: "LEAST_USED";
                                                                                                                                                                                                                                                                ROUND_ROBIN: "ROUND_ROBIN";
                                                                                                                                                                                                                                                                WEIGHTED_ROUND_ROBIN: "WEIGHTED_ROUND_ROBIN";
                                                                                                                                                                                                                                                            },
                                                                                                                                                                                                                                                        > = ...

                                                                                                                                                                                                                                                        Enumeration of worker choice strategies.

                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                        +WorkerChoiceStrategies | poolifier - v5.4.0
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        poolifier - v5.4.0 + +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                          Variable WorkerChoiceStrategiesConst

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          WorkerChoiceStrategies: Readonly<
                                                                                                                                                                                                                                                              {
                                                                                                                                                                                                                                                                  FAIR_SHARE: "FAIR_SHARE";
                                                                                                                                                                                                                                                                  INTERLEAVED_WEIGHTED_ROUND_ROBIN: "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
                                                                                                                                                                                                                                                                  LEAST_BUSY: "LEAST_BUSY";
                                                                                                                                                                                                                                                                  LEAST_ELU: "LEAST_ELU";
                                                                                                                                                                                                                                                                  LEAST_USED: "LEAST_USED";
                                                                                                                                                                                                                                                                  ROUND_ROBIN: "ROUND_ROBIN";
                                                                                                                                                                                                                                                                  WEIGHTED_ROUND_ROBIN: "WEIGHTED_ROUND_ROBIN";
                                                                                                                                                                                                                                                              },
                                                                                                                                                                                                                                                          > = ...
                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Enumeration of worker choice strategies.

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          diff --git a/docs/variables/src.WorkerTypes.html b/docs/variables/src.WorkerTypes.html index 9f50dfaf8..e4ea37f5a 100644 --- a/docs/variables/src.WorkerTypes.html +++ b/docs/variables/src.WorkerTypes.html @@ -1,2 +1,36 @@ -WorkerTypes | poolifier - v5.3.2
                                                                                                                                                                                                                                                          poolifier - v5.3.2
                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                            Variable WorkerTypesConst

                                                                                                                                                                                                                                                            WorkerTypes: Readonly<{ cluster: "cluster"; thread: "thread" }> = ...

                                                                                                                                                                                                                                                            Enumeration of worker types.

                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                            +WorkerTypes | poolifier - v5.4.0
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            poolifier - v5.4.0 + +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                              Variable WorkerTypesConst

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              WorkerTypes: Readonly<{ cluster: "cluster"; thread: "thread" }> = ...
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Enumeration of worker types.

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              -- 2.53.0