From cfc6e8df4c903b63514c46cb67b3f5e24079d3ce Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Sat, 18 Mar 2023 12:26:16 +0000
Subject: [PATCH] Generate documentation
---
docs/assets/main.js | 108 +++++------
docs/assets/search.js | 2 +-
docs/assets/style.css | 32 +++-
docs/classes/ClusterWorker.html | 54 +++---
docs/classes/DynamicClusterPool.html | 172 +++++++++---------
docs/classes/DynamicThreadPool.html | 166 +++++++++--------
docs/classes/FixedClusterPool.html | 166 +++++++++--------
docs/classes/FixedThreadPool.html | 160 ++++++++--------
docs/classes/PoolEmitter.html | 56 +++---
docs/classes/ThreadWorker.html | 50 ++---
docs/index.html | 2 +-
docs/interfaces/ClusterPoolOptions.html | 22 +--
docs/interfaces/IPool.html | 24 +--
docs/interfaces/PoolOptions.html | 18 +-
docs/interfaces/WorkerOptions.html | 16 +-
docs/types/ErrorHandler.html | 4 +-
docs/types/ExitHandler.html | 4 +-
docs/types/KillBehavior.html | 4 +-
docs/types/MessageHandler.html | 4 +-
docs/types/OnlineHandler.html | 4 +-
.../types/ThreadWorkerWithMessageChannel.html | 4 +-
docs/types/WorkerChoiceStrategy.html | 4 +-
docs/variables/KillBehaviors.html | 4 +-
docs/variables/WorkerChoiceStrategies.html | 4 +-
24 files changed, 571 insertions(+), 513 deletions(-)
diff --git a/docs/assets/main.js b/docs/assets/main.js
index abd0485a..f7c83669 100644
--- a/docs/assets/main.js
+++ b/docs/assets/main.js
@@ -1,54 +1,58 @@
"use strict";
"use strict";(()=>{var Qe=Object.create;var ae=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Ce=Object.getOwnPropertyNames;var Oe=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var _e=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Me=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ce(e))!Re.call(t,i)&&i!==n&&ae(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Qe(Oe(t)):{},Me(e||!t||!t.__esModule?ae(n,"default",{value:t,enumerable:!0}):n,t));var de=_e((ce,he)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u{let n=Date.now();return(...r)=>{n+e-Date.now()<0&&(t(...r),n=Date.now())}};var re=class extends J{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.navigation=document.querySelector(".col-menu"),window.addEventListener("scroll",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.searchInput=document.querySelector("#tsd-search input"),this.searchInput&&this.searchInput.addEventListener("focus",()=>{this.hideShowToolbar()}),this.onResize(),this.onScroll()}triggerResize(){let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onScroll(){this.scrollTop=window.scrollY||0;let n=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(n),this.hideShowToolbar()}hideShowToolbar(){let n=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0||!!this.searchInput&&this.searchInput===document.activeElement,n!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),this.navigation?.classList.toggle("col-menu--hide")),this.lastY=this.scrollTop}},R=re;R.instance=new re;var X=class extends k{constructor(n){super(n);this.anchors=[];this.index=-1;R.instance.addEventListener("resize",()=>this.onResize()),R.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substring(0,n.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let i=r.href;if(i.indexOf("#")==-1||i.substring(0,n.length)!=n)return;let s=i.substring(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=r.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let n;for(let i=0,s=this.anchors.length;ii.position-s.position);let r=new CustomEvent("scroll",{detail:{scrollTop:R.instance.scrollTop}});this.onScroll(r)}onScroll(n){let r=n.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>r;)o-=1;for(;o-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=o,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ue=(t,e=100)=>{let n;return(...r)=>{clearTimeout(n),n=setTimeout(()=>t(r),e)}};var me=De(de());function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let n=document.querySelector("#tsd-search input"),r=document.querySelector("#tsd-search .results");if(!n||!r)throw new Error("The input field or the result list wrapper was not found");let i=!1;r.addEventListener("mousedown",()=>i=!0),r.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),n.addEventListener("focus",()=>t.classList.add("has-focus")),n.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Fe(t,r,n,s)}function Fe(t,e,n,r){n.addEventListener("input",ue(()=>{Ae(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?fe(e,-1):s.key==="ArrowDown"?fe(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function He(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=me.Index.load(window.searchData.index))}function Ae(t,e,n,r){if(He(r,t),!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s=i?r.index.search(`*${i}*`):[];for(let o=0;o=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u{let n=Date.now();return(...r)=>{n+e-Date.now()<0&&(t(...r),n=Date.now())}};var re=class extends J{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.navigation=document.querySelector(".col-menu"),window.addEventListener("scroll",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.searchInput=document.querySelector("#tsd-search input"),this.searchInput&&this.searchInput.addEventListener("focus",()=>{this.hideShowToolbar()}),this.onResize(),this.onScroll()}triggerResize(){let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onScroll(){this.scrollTop=window.scrollY||0;let n=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(n),this.hideShowToolbar()}hideShowToolbar(){let n=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0||!!this.searchInput&&this.searchInput===document.activeElement,n!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),this.navigation?.classList.toggle("col-menu--hide")),this.lastY=this.scrollTop}},R=re;R.instance=new re;var X=class extends I{constructor(n){super(n);this.anchors=[];this.index=-1;R.instance.addEventListener("resize",()=>this.onResize()),R.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substring(0,n.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let i=r.href;if(i.indexOf("#")==-1||i.substring(0,n.length)!=n)return;let s=i.substring(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=r.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let n;for(let i=0,s=this.anchors.length;ii.position-s.position);let r=new CustomEvent("scroll",{detail:{scrollTop:R.instance.scrollTop}});this.onScroll(r)}onScroll(n){let r=n.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>r;)o-=1;for(;o-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=o,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ue=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var me=De(de());function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let n=document.querySelector("#tsd-search input"),r=document.querySelector("#tsd-search .results");if(!n||!r)throw new Error("The input field or the result list wrapper was not found");let i=!1;r.addEventListener("mousedown",()=>i=!0),r.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),n.addEventListener("focus",()=>t.classList.add("has-focus")),n.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Fe(t,r,n,s)}function Fe(t,e,n,r){n.addEventListener("input",ue(()=>{He(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?pe(e,-1):s.key==="ArrowDown"?pe(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ae(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=me.Index.load(window.searchData.index))}function He(t,e,n,r){if(Ae(r,t),!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s=i?r.index.search(`*${i}*`):[];for(let o=0;o
poolifier
+
+
@@ -112,13 +112,13 @@ but the minimum number of workers will be guaranteed.
data: Data
Returns Response
opts: WorkerOptions = {}
+opts: WorkerOptions = EMPTY_OBJECT_LITERAL
Returns ClusterWorker<Data, Response>
+Properties
Protected
lastProtected
mainReadonly
optsInherited from AbstractWorker.opts
Inherited from AbstractWorker.asyncId
AsyncResource
to which the function is bound.
Inherited from AbstractWorker.bind
Protected
checkAsyncResource
to which the function is bound.
Inherited from AbstractWorker.checkAlive
Inherited from AbstractWorker.emitDestroy
Protected
getInherited from AbstractWorker.getMainWorker
Protected
handle{@inheritDoc}
+Overrides AbstractWorker.handleError
Protected
messageInherited from AbstractWorker.messageListener
Protected
runInherited from AbstractWorker.run
Protected
runInherited from AbstractWorker.runAsync
Inherited from AbstractWorker.runInAsyncScope
Protected
send{@inheritDoc}
+Overrides AbstractWorker.sendToMainWorker
Inherited from AbstractWorker.triggerAsyncId
Static
bindAsyncResource
to which the function is bound.
Inherited from AbstractWorker.bind
Path to an implementation of a ClusterWorker
file, which can be relative or absolute.
Options for this dynamic cluster pool.
Overrides FixedClusterPool.constructor
Optional
Readonly
emitter{@inheritDoc}
+Inherited from FixedClusterPool.emitter
Readonly
filePath to the worker-file.
+Inherited from FixedClusterPool.filePath
Protected
Readonly
maxMaximum number of workers that can be created by this pool.
+Protected
nextInherited from FixedClusterPool.nextMessageId
Readonly
numberNumber of workers that this pool should manage.
+Inherited from FixedClusterPool.numberOfWorkers
Readonly
optsOptions for this fixed cluster pool.
+Inherited from FixedClusterPool.opts
Protected
promiseInherited from FixedClusterPool.promiseMap
Protected
workerInherited from FixedClusterPool.workerChoiceStrategyContext
Readonly
workers{@inheritDoc}
+Inherited from FixedClusterPool.workers
Readonly
workers{@inheritDoc}
+Inherited from FixedClusterPool.workersTasksUsage
{@inheritDoc}
+Overrides FixedClusterPool.busy
{@inheritDoc}
+Inherited from FixedClusterPool.numberOfRunningTasks
{@inheritDoc}
+Overrides FixedClusterPool.type
Inherited from FixedClusterPool.afterPromiseWorkerResponseHook
Protected
after{@inheritDoc}
+Inherited from FixedClusterPool.afterWorkerSetup
Protected
beforeInherited from FixedClusterPool.beforePromiseWorkerResponseHook
Protected
chooseInherited from FixedClusterPool.chooseWorker
Protected
createInherited from FixedClusterPool.createAndSetupWorker
Protected
create{@inheritDoc}
+Inherited from FixedClusterPool.createWorker
{@inheritDoc}
+Inherited from FixedClusterPool.destroy
{@inheritDoc}
+Inherited from FixedClusterPool.destroyWorker
{@inheritDoc}
+Inherited from FixedClusterPool.execute
{@inheritDoc}
+Inherited from FixedClusterPool.findFreeWorker
{@inheritDoc}
+Inherited from FixedClusterPool.getWorkerAverageTasksRunTime
{@inheritDoc}
+Inherited from FixedClusterPool.getWorkerIndex
{@inheritDoc}
+Inherited from FixedClusterPool.getWorkerRunningTasks
Protected
internalInherited from FixedClusterPool.internalGetBusyStatus
Protected
is{@inheritDoc}
+Inherited from FixedClusterPool.isMain
{@inheritDoc}
+Inherited from FixedClusterPool.registerWorkerMessageListener
Protected
removeInherited from FixedClusterPool.removeWorker
Protected
send{@inheritDoc}
+Inherited from FixedClusterPool.sendToWorker
{@inheritDoc}
+Inherited from FixedClusterPool.setWorkerChoiceStrategy
Protected
setup{@inheritDoc}
+Inherited from FixedClusterPool.setupHook
Protected
workerInherited from FixedClusterPool.workerListener
Overrides FixedThreadPool.constructor
Optional
Readonly
emitter{@inheritDoc}
+Inherited from FixedThreadPool.emitter
Readonly
filePath to the worker-file.
+Inherited from FixedThreadPool.filePath
Protected
Readonly
maxMaximum number of threads that can be created by this pool.
+Protected
nextInherited from FixedThreadPool.nextMessageId
Readonly
numberNumber of workers that this pool should manage.
+Inherited from FixedThreadPool.numberOfWorkers
Readonly
optsOptions for the pool.
+Inherited from FixedThreadPool.opts
Protected
promiseInherited from FixedThreadPool.promiseMap
Protected
workerInherited from FixedThreadPool.workerChoiceStrategyContext
Readonly
workers{@inheritDoc}
+Inherited from FixedThreadPool.workers
Readonly
workers{@inheritDoc}
+Inherited from FixedThreadPool.workersTasksUsage
{@inheritDoc}
+Overrides FixedThreadPool.busy
{@inheritDoc}
+Inherited from FixedThreadPool.numberOfRunningTasks
{@inheritDoc}
+Overrides FixedThreadPool.type
Inherited from FixedThreadPool.afterPromiseWorkerResponseHook
Protected
after{@inheritDoc}
+Inherited from FixedThreadPool.afterWorkerSetup
Protected
beforeInherited from FixedThreadPool.beforePromiseWorkerResponseHook
Protected
chooseInherited from FixedThreadPool.chooseWorker
Protected
createInherited from FixedThreadPool.createAndSetupWorker
Protected
create{@inheritDoc}
+Inherited from FixedThreadPool.createWorker
{@inheritDoc}
+Inherited from FixedThreadPool.destroy
{@inheritDoc}
+Inherited from FixedThreadPool.destroyWorker
{@inheritDoc}
+Inherited from FixedThreadPool.execute
{@inheritDoc}
+Inherited from FixedThreadPool.findFreeWorker
{@inheritDoc}
+Inherited from FixedThreadPool.getWorkerAverageTasksRunTime
{@inheritDoc}
+Inherited from FixedThreadPool.getWorkerIndex
{@inheritDoc}
+Inherited from FixedThreadPool.getWorkerRunningTasks
Protected
internalInherited from FixedThreadPool.internalGetBusyStatus
Protected
is{@inheritDoc}
+Inherited from FixedThreadPool.isMain
{@inheritDoc}
+Inherited from FixedThreadPool.registerWorkerMessageListener
Protected
removeInherited from FixedThreadPool.removeWorker
Protected
send{@inheritDoc}
+Inherited from FixedThreadPool.sendToWorker
{@inheritDoc}
+Inherited from FixedThreadPool.setWorkerChoiceStrategy
Protected
setupInherited from FixedThreadPool.setupHook
Protected
workerInherited from FixedThreadPool.workerListener
Path to an implementation of a ClusterWorker
file, which can be relative or absolute.
Options for this fixed cluster pool.
Overrides AbstractPool<Worker, Data, Response>.constructor
Optional
Readonly
emitter{@inheritDoc}
+Inherited from AbstractPool.emitter
Readonly
filePath to the worker-file.
+Inherited from AbstractPool.filePath
Protected
nextInherited from AbstractPool.nextMessageId
Readonly
numberNumber of workers that this pool should manage.
+Inherited from AbstractPool.numberOfWorkers
Readonly
optsOptions for this fixed cluster pool.
+Inherited from AbstractPool.opts
Protected
promiseInherited from AbstractPool.promiseMap
Protected
workerInherited from AbstractPool.workerChoiceStrategyContext
Readonly
workers{@inheritDoc}
+Inherited from AbstractPool.workers
Readonly
workers{@inheritDoc}
+Inherited from AbstractPool.workersTasksUsage
{@inheritDoc}
+Overrides AbstractPool.busy
{@inheritDoc}
+Inherited from AbstractPool.numberOfRunningTasks
{@inheritDoc}
+Overrides AbstractPool.type
Inherited from AbstractPool.afterPromiseWorkerResponseHook
Protected
after{@inheritDoc}
+Overrides AbstractPool.afterWorkerSetup
Protected
beforeInherited from AbstractPool.beforePromiseWorkerResponseHook
Protected
chooseInherited from AbstractPool.chooseWorker
Protected
createInherited from AbstractPool.createAndSetupWorker
Protected
create{@inheritDoc}
+Overrides AbstractPool.createWorker
{@inheritDoc}
+Inherited from AbstractPool.destroy
{@inheritDoc}
+Overrides AbstractPool.destroyWorker
{@inheritDoc}
+Inherited from AbstractPool.execute
{@inheritDoc}
+Inherited from AbstractPool.findFreeWorker
{@inheritDoc}
+Inherited from AbstractPool.getWorkerAverageTasksRunTime
{@inheritDoc}
+Inherited from AbstractPool.getWorkerIndex
{@inheritDoc}
+Inherited from AbstractPool.getWorkerRunningTasks
Protected
internalInherited from AbstractPool.internalGetBusyStatus
Protected
is{@inheritDoc}
+Overrides AbstractPool.isMain
{@inheritDoc}
+Overrides AbstractPool.registerWorkerMessageListener
Protected
removeInherited from AbstractPool.removeWorker
Protected
send{@inheritDoc}
+Overrides AbstractPool.sendToWorker
{@inheritDoc}
+Inherited from AbstractPool.setWorkerChoiceStrategy
Protected
setup{@inheritDoc}
+Overrides AbstractPool.setupHook
Protected
workerInherited from AbstractPool.workerListener
Overrides AbstractPool<ThreadWorkerWithMessageChannel, Data, Response>.constructor
Optional
Readonly
emitter{@inheritDoc}
+Inherited from AbstractPool.emitter
Readonly
filePath to the worker-file.
+Inherited from AbstractPool.filePath
Protected
nextInherited from AbstractPool.nextMessageId
Readonly
numberNumber of workers that this pool should manage.
+Inherited from AbstractPool.numberOfWorkers
Readonly
optsOptions for the pool.
+Inherited from AbstractPool.opts
Protected
promiseInherited from AbstractPool.promiseMap
Protected
workerInherited from AbstractPool.workerChoiceStrategyContext
Readonly
workers{@inheritDoc}
+Inherited from AbstractPool.workers
Readonly
workers{@inheritDoc}
+Inherited from AbstractPool.workersTasksUsage
{@inheritDoc}
+Overrides AbstractPool.busy
{@inheritDoc}
+Inherited from AbstractPool.numberOfRunningTasks
{@inheritDoc}
+Overrides AbstractPool.type
Inherited from AbstractPool.afterPromiseWorkerResponseHook
Protected
after{@inheritDoc}
+Overrides AbstractPool.afterWorkerSetup
Protected
beforeInherited from AbstractPool.beforePromiseWorkerResponseHook
Protected
chooseInherited from AbstractPool.chooseWorker
Protected
createInherited from AbstractPool.createAndSetupWorker
Protected
create{@inheritDoc}
+Overrides AbstractPool.createWorker
{@inheritDoc}
+Inherited from AbstractPool.destroy
{@inheritDoc}
+Overrides AbstractPool.destroyWorker
{@inheritDoc}
+Inherited from AbstractPool.execute
{@inheritDoc}
+Inherited from AbstractPool.findFreeWorker
{@inheritDoc}
+Inherited from AbstractPool.getWorkerAverageTasksRunTime
{@inheritDoc}
+Inherited from AbstractPool.getWorkerIndex
{@inheritDoc}
+Inherited from AbstractPool.getWorkerRunningTasks
Protected
internalInherited from AbstractPool.internalGetBusyStatus
Protected
is{@inheritDoc}
+Overrides AbstractPool.isMain
{@inheritDoc}
+Overrides AbstractPool.registerWorkerMessageListener
Protected
removeInherited from AbstractPool.removeWorker
Protected
send{@inheritDoc}
+Overrides AbstractPool.sendToWorker
{@inheritDoc}
+Inherited from AbstractPool.setWorkerChoiceStrategy
Protected
setupInherited from AbstractPool.setupHook
Protected
workerInherited from AbstractPool.workerListener
Inherited from EventEmitter.constructor
Inherited from EventEmitter.captureRejectionSymbol
Static
captureInherited from EventEmitter.captureRejections
Static
defaultInherited from EventEmitter.defaultMaxListeners
Static
Readonly
error'error'
listener is installed.
Inherited from EventEmitter.errorMonitor
'error'
listener is installed.
Inherited from EventEmitter.addListener
Inherited from EventEmitter.emit
Symbol
s.
Inherited from EventEmitter.eventNames
emitter.setMaxListeners(n)
or defaults to Returns numberInherited from EventEmitter.getMaxListeners
emitter.setMaxListeners(n)
or defaults to Returns numberInherited from EventEmitter.listenerCount
emitter.setMaxListeners(n)
or defaults to Returns Function[]Inherited from EventEmitter.listeners
emitter.setMaxListeners(n)
or defaults to Returns PoolEmitterInherited from EventEmitter.off
Inherited from EventEmitter.on
Inherited from EventEmitter.once
Inherited from EventEmitter.prependListener
Inherited from EventEmitter.prependOnceListener
.once()
).
Inherited from EventEmitter.rawListeners
Inherited from EventEmitter.removeAllListeners
once('ping')
lis
Inherited from EventEmitter.removeListener
EventEmitter
instance. The value can be
Inherited from EventEmitter.setMaxListeners
Static
getInherited from EventEmitter.getEventListeners
Static
listenerInherited from EventEmitter.listenerCount
Static
onInherited from EventEmitter.on
Static
onceInherited from EventEmitter.once
Inherited from EventEmitter.once
Static
setInherited from EventEmitter.setMaxListeners
Options for the worker.
Overrides AbstractWorker<MessagePort, Data, Response>.constructor
Inherited from AbstractWorker.aliveInterval
Protected
lastInherited from AbstractWorker.lastTaskTimestamp
Protected
mainReference to main worker.
+Inherited from AbstractWorker.mainWorker
Readonly
optsInherited from AbstractWorker.opts
Inherited from AbstractWorker.asyncId
AsyncResource
to which the function is bound.
Inherited from AbstractWorker.bind
Protected
checkAsyncResource
to which the function is bound.
Inherited from AbstractWorker.checkAlive
Inherited from AbstractWorker.emitDestroy
Protected
getInherited from AbstractWorker.getMainWorker
Protected
handleInherited from AbstractWorker.handleError
Protected
messageInherited from AbstractWorker.messageListener
Protected
runInherited from AbstractWorker.run
Protected
runInherited from AbstractWorker.runAsync
Inherited from AbstractWorker.runInAsyncScope
Protected
send{@inheritDoc}
+Overrides AbstractWorker.sendToMainWorker
Inherited from AbstractWorker.triggerAsyncId
Static
bindAsyncResource
to which the function is bound.
Inherited from AbstractWorker.bind
Pool events emission.
-true
+true
Inherited from PoolOptions.enableEvents
Optional
envhttps://nodejs.org/api/cluster.html#cluster_cluster_fork_env
Optional
errorInherited from PoolOptions.errorHandler
Optional
exitInherited from PoolOptions.exitHandler
Optional
messageInherited from PoolOptions.messageHandler
Optional
onlineInherited from PoolOptions.onlineHandler
Optional
settingshttps://nodejs.org/api/cluster.html#cluster_cluster_settings
Optional
workerInherited from PoolOptions.workerChoiceStrategy
Shutdowns every current worker in this pool.
Optional
Readonly
emitterPerforms the task specified in the constructor with the data parameter.
@@ -98,7 +98,7 @@Sets the worker choice strategy in this pool.
Pool events emission.
-true
+true
Optional
errorA function that will listen for error event on each worker.
Optional
exitA function that will listen for exit event on each worker.
Optional
messageA function that will listen for message event on each worker.
Optional
onlineA function that will listen for online event on each worker.
Optional
workerThe worker choice strategy to use in this pool.
Whether your worker will perform asynchronous or not.
-false
+false
Optional
killThis option only apply to the newly created workers.
-KillBehaviors.SOFT
+KillBehaviors.SOFT
Optional
maxkillBehavior
is set to KillBehaviors.SOFT
your tasks have no timeout and your workers will not be terminated until your task is completed.60000 ms
+60000 ms
Kill behavior.
A thread worker with message channels for communication between main thread and thread worker.
Worker choice strategy.
Enumeration of kill behaviors.
Enumeration of worker choice strategies.
Options for the worker.