`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let y=document.createElement("li");y.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,y.append(p),e.appendChild(y)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function 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(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",fe="mousemove",H="mouseup",J={x:0,y:0},pe=!1,ee=!1,Be=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",fe="touchmove",H="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(H,()=>{ee=!1});document.addEventListener("click",t=>{pe&&(t.preventDefault(),t.stopImmediatePropagation(),pe=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,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){D||(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(!D&&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 te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ye=document.head.appendChild(document.createElement("style"));ye.dataset.for="filters";var Y=class extends I{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()),ye.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.updateIndexHeadingVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.updateIndexHeadingVisibility()}updateIndexHeadingVisibility(){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)}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ve(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ve(t.value)})}function ve(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function we(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-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.pathname===r.pathname&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); /*! Bundled license information: lunr/lunr.js: diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index c3d367e6..fcb9ca49 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,117 +1,117 @@ -AbstractPool | poolifier - v3.1.21

Class AbstractPool<Worker, Data, Response>`Abstract`

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

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 full)

AbstractPool
- FixedClusterPool
- FixedThreadPool

Implements

IPool<Worker, Data, Response>

Index

Constructors

constructor

new AbstractPool<Worker, Data, Response>(minimumNumberOfWorkers, filePath, opts, maximumNumberOfWorkers?): AbstractPool<Worker, Data, Response>
Constructs a new poolifier pool.
-
Type Parameters
- Worker extends IWorker
- Data = unknown
- Response = unknown
Parameters
- minimumNumberOfWorkers: number
  Minimum number of workers that this pool manages.
  -
- filePath: string
  Path to the worker file.
  -
- opts: PoolOptions<Worker>
  Options for the pool.
  -
- Optional maximumNumberOfWorkers: number
  Maximum number of workers that this pool manages.
  -
Returns AbstractPool<Worker, Data, Response>
- Defined in src/pools/abstract-pool.ts:136

Properties

`Private` destroying

destroying: boolean

Whether the pool is destroying or not.

`Optional` emitter

emitter?: EventEmitterAsyncResource

Event emitter integrated with async resource on which events can be listened to. +AbstractPool | poolifier - v3.1.21

Class AbstractPool<Worker, Data, Response>`Abstract`

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

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 full)

AbstractPool
- FixedClusterPool
- FixedThreadPool

Implements

IPool<Worker, Data, Response>

Index

Constructors

constructor +

Properties

destroying +emitter? +filePath +maximumNumberOfWorkers? +minimumNumberOfWorkers +opts +promiseResponseMap +readyEventEmitted +startTimestamp +started +starting +taskFunctions +workerChoiceStrategyContext? +workerNodes +

Accessors

busy +empty +full +info +ready +type +utilization +worker +

Methods

addTaskFunction +addWorkerNode +afterTaskExecutionHook +afterWorkerNodeSetup +beforeTaskExecutionHook +buildTasksQueueOptions +cannotStealTask +checkAndEmitDynamicWorkerCreationEvents +checkAndEmitEmptyEvent +checkAndEmitReadyEvent +checkAndEmitTaskExecutionEvents +checkAndEmitTaskQueuingEvents +checkMessageWorkerId +checkMinimumNumberOfWorkers +checkPoolOptions +checkPoolType +checkValidWorkerChoiceStrategyOptions +chooseWorkerNode +createAndSetupDynamicWorkerNode +createAndSetupWorkerNode +createWorkerNode +deleteTaskFunctionWorkerUsages +dequeueTask +deregisterWorkerMessageListener +destroy +destroyWorkerNode +enableTasksQueue +enqueueTask +execute +executeTask +flagWorkerNodeAsNotReady +flushTasksQueue +flushTasksQueues +getWorkerInfo +getWorkerNodeKeyByWorkerId +handleTask +handleTaskExecutionResponse +handleWorkerNodeBackPressureEvent +handleWorkerNodeIdleEvent +handleWorkerReadyResponse +hasBackPressure +hasTaskFunction +initializeEventEmitter +internalBusy +isMain +isWorkerNodeBusy +listTaskFunctionNames +redistributeQueuedTasks +registerOnceWorkerMessageListener +registerWorkerMessageListener +removeTaskFunction +removeWorkerNode +resetTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage +resetTaskSequentiallyStolenStatisticsWorkerUsage +sendKillMessageToWorker +sendStartupMessageToWorker +sendStatisticsMessageToWorker +sendTaskFunctionOperationToWorker +sendTaskFunctionOperationToWorkers +sendToWorker +setDefaultTaskFunction +setTaskStealing +setTasksQueueOptions +setTasksQueueSize +setTasksStealingOnBackPressure +setWorkerChoiceStrategy +setWorkerChoiceStrategyOptions +setupHook +shallCreateDynamicWorker +shallExecuteTask +shallUpdateTaskFunctionWorkerUsage +start +tasksQueueSize +unsetTaskStealing +unsetTasksStealingOnBackPressure +updateTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage +updateTaskSequentiallyStolenStatisticsWorkerUsage +updateTaskStolenStatisticsWorkerUsage +workerMessageListener +workerNodeStealTask +

Constructors

constructor

new AbstractPool<Worker, Data, Response>(minimumNumberOfWorkers, filePath, opts, maximumNumberOfWorkers?): AbstractPool<Worker, Data, Response>
Constructs a new poolifier pool.
+
Type Parameters
- Worker extends IWorker
- Data = unknown
- Response = unknown
Parameters
- minimumNumberOfWorkers: number
  Minimum number of workers that this pool manages.
  +
- filePath: string
  Path to the worker file.
  +
- opts: PoolOptions<Worker>
  Options for the pool.
  +
- Optional maximumNumberOfWorkers: number
  Maximum number of workers that this pool manages.
  +
Returns AbstractPool<Worker, Data, Response>
- Defined in src/pools/abstract-pool.ts:136

Properties

`Private` destroying

destroying: boolean

Whether the pool is destroying or not.

`Optional` emitter

emitter?: EventEmitterAsyncResource

Event emitter integrated with async resource on which events can be listened to. The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

Events that can currently be listened to:

poolifier:<PoolType>-<Wo
 'taskError': Emitted when an error occurs while executing a task.
 'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).

Protected Readonly filePath
filePath: string
Path to the worker file.
-
Defined in src/pools/abstract-pool.ts:138

Protected Optional Readonly maximumNumberOfWorkers
maximumNumberOfWorkers?: number
Maximum number of workers that this pool manages.
-
Defined in src/pools/abstract-pool.ts:140

Protected Readonly minimumNumberOfWorkers
minimumNumberOfWorkers: number
Minimum number of workers that this pool manages.
-
Defined in src/pools/abstract-pool.ts:137

Protected Readonly opts
opts: PoolOptions<Worker>
Options for the pool.
-
Defined in src/pools/abstract-pool.ts:139

Protected promiseResponseMap
promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
The task execution response promise map:
+
Implementation of IPool.emitter
Defined in src/pools/abstract-pool.ts:79

Protected Readonly filePath
filePath: string
Path to the worker file.
+
Defined in src/pools/abstract-pool.ts:138

Protected Optional Readonly maximumNumberOfWorkers
maximumNumberOfWorkers?: number
Maximum number of workers that this pool manages.
+
Defined in src/pools/abstract-pool.ts:140

Protected Readonly minimumNumberOfWorkers
minimumNumberOfWorkers: number
Minimum number of workers that this pool manages.
+
Defined in src/pools/abstract-pool.ts:137

Protected Readonly opts
opts: PoolOptions<Worker>
Options for the pool.
+
Defined in src/pools/abstract-pool.ts:139

Protected promiseResponseMap
promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
The task execution response promise map:
 
 key: The message id of each submitted task.
 value: An object that contains the worker, the execution response promise resolve and reject callbacks.
 
 When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
-
Defined in src/pools/abstract-pool.ts:88

Private readyEventEmitted
readyEventEmitted: boolean
Whether the pool ready event has been emitted or not.
-
Defined in src/pools/abstract-pool.ts:122

Private Readonly startTimestamp
startTimestamp: number
The start timestamp of the pool.
-
Defined in src/pools/abstract-pool.ts:126

Private started
started: boolean
Whether the pool is started or not.
-
Defined in src/pools/abstract-pool.ts:110

Private starting
starting: boolean
Whether the pool is starting or not.
-
Defined in src/pools/abstract-pool.ts:114

Private Readonly taskFunctions
taskFunctions: Map<string, TaskFunction<Data, Response>>
The task functions added at runtime map:
+
Defined in src/pools/abstract-pool.ts:88

Private readyEventEmitted
readyEventEmitted: boolean
Whether the pool ready event has been emitted or not.
+
Defined in src/pools/abstract-pool.ts:122

Private Readonly startTimestamp
startTimestamp: number
The start timestamp of the pool.
+
Defined in src/pools/abstract-pool.ts:126

Private started
started: boolean
Whether the pool is started or not.
+
Defined in src/pools/abstract-pool.ts:110

Private starting
starting: boolean
Whether the pool is starting or not.
+
Defined in src/pools/abstract-pool.ts:114

Private Readonly taskFunctions
taskFunctions: Map<string, TaskFunction<Data, Response>>
The task functions added at runtime map:
 
 key: The task function name.
 value: The task function itself.
 
-
Defined in src/pools/abstract-pool.ts:105

Protected Optional workerChoiceStrategyContext
workerChoiceStrategyContext?: WorkerChoiceStrategyContext<Worker, Data, Response>
Worker choice strategy context referencing a worker choice algorithm implementation.
-
Defined in src/pools/abstract-pool.ts:94

Readonly Internal workerNodes
workerNodes: IWorkerNode<Worker, Data>[] = []
Pool worker nodes.
-
Implementation of IPool.workerNodes
Defined in src/pools/abstract-pool.ts:76

`Accessors`

Protected Abstract busy
get busy(): boolean
Whether the pool is busy or not.
+
Defined in src/pools/abstract-pool.ts:105

Protected Optional workerChoiceStrategyContext
workerChoiceStrategyContext?: WorkerChoiceStrategyContext<Worker, Data, Response>
Worker choice strategy context referencing a worker choice algorithm implementation.
+
Defined in src/pools/abstract-pool.ts:94

Readonly Internal workerNodes
workerNodes: IWorkerNode<Worker, Data>[] = []
Pool worker nodes.
+
Implementation of IPool.workerNodes
Defined in src/pools/abstract-pool.ts:76

`Accessors`

Protected Abstract busy
get busy(): boolean
Whether the pool is busy or not.
 The pool busyness boolean status.
-
Returns boolean
Defined in src/pools/abstract-pool.ts:670

Protected empty
get empty(): boolean
The pool emptiness boolean status.
-
Returns boolean
Defined in src/pools/abstract-pool.ts:464

Protected full
get full(): boolean
Whether the pool is full or not.
+
Returns boolean
Defined in src/pools/abstract-pool.ts:670

Protected empty
get empty(): boolean
The pool emptiness boolean status.
+
Returns boolean
Defined in src/pools/abstract-pool.ts:464

Protected full
get full(): boolean
Whether the pool is full or not.
 The pool filling boolean status.
-
Returns boolean
Defined in src/pools/abstract-pool.ts:658

info
get info(): PoolInfo
Pool information.
-
Returns PoolInfo
Implementation of IPool.info
Defined in src/pools/abstract-pool.ts:277

Private ready
get ready(): boolean
The pool readiness boolean status.
-
Returns boolean
Defined in src/pools/abstract-pool.ts:446

Protected Abstract type
get type(): "fixed" | "dynamic"
The pool type.
+
Returns boolean
Defined in src/pools/abstract-pool.ts:658

info
get info(): PoolInfo
Pool information.
+
Returns PoolInfo
Implementation of IPool.info
Defined in src/pools/abstract-pool.ts:277

Private ready
get ready(): boolean
The pool readiness boolean status.
+
Returns boolean
Defined in src/pools/abstract-pool.ts:446

Protected Abstract type
get type(): "fixed" | "dynamic"
The pool type.
 If it is 'dynamic', it provides the max property.
-
Returns "fixed" | "dynamic"
Defined in src/pools/abstract-pool.ts:495

Private utilization
get utilization(): number
The approximate pool utilization.
+
Returns "fixed" | "dynamic"
Defined in src/pools/abstract-pool.ts:495

Private utilization
get utilization(): number
The approximate pool utilization.
 
Returns number
The pool utilization.
-
Defined in src/pools/abstract-pool.ts:473

Protected Abstract worker
get worker(): "thread" | "cluster"
The worker type.
-
Returns "thread" | "cluster"
Defined in src/pools/abstract-pool.ts:500

`Methods`

addTaskFunction
addTaskFunction(name, fn): Promise<boolean>
Adds a task function to this pool.
-If a task function with the same name already exists, it will be overwritten.
-
Parameters
name: string
The name of the task function.
-
fn: TaskFunction<Data, Response>
The task function.
-
Returns Promise<boolean>
true if the task function was added, false otherwise.
-Throws
https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.
-Throws
https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.
-
Implementation of IPool.addTaskFunction
Defined in src/pools/abstract-pool.ts:812

Private addWorkerNode
addWorkerNode(workerNode): number
Adds the given worker node in the pool worker nodes.
-
Parameters
workerNode: IWorkerNode<Worker, Data>
The worker node.
+
Defined in src/pools/abstract-pool.ts:473

Protected Abstract worker
get worker(): "thread" | "cluster"
The worker type.
+
Returns "thread" | "cluster"
Defined in src/pools/abstract-pool.ts:500

`Methods`

addTaskFunction
addTaskFunction(name, fn): Promise<boolean>
Parameters
name: string
fn: TaskFunction<Data, Response>
Returns Promise<boolean>
Inherit Doc
Implementation of IPool.addTaskFunction
Defined in src/pools/abstract-pool.ts:812

Private addWorkerNode
addWorkerNode(workerNode): number
Adds the given worker node in the pool worker nodes.
+
Parameters
workerNode: IWorkerNode<Worker, Data>The worker node.
 
Returns number
The added worker node key.
 Throws
https://nodejs.org/api/errors.html#class-error If the added worker node is not found.
-
Defined in src/pools/abstract-pool.ts:1860

Protected afterTaskExecutionHook
afterTaskExecutionHook(workerNodeKey, message): void
Hook executed after the worker task execution.
+
Defined in src/pools/abstract-pool.ts:1860

Protected afterTaskExecutionHook
afterTaskExecutionHook(workerNodeKey, message): void
Hook executed after the worker task execution.
 Can be overridden.
-
Parameters
workerNodeKey: number
The worker node key.
-
message: MessageValue<Response, unknown>
The received message.
-
Returns void
Defined in src/pools/abstract-pool.ts:1111

Protected afterWorkerNodeSetup
afterWorkerNodeSetup(workerNodeKey): void
Method hooked up after a worker node has been newly created.
+
Parameters
workerNodeKey: numberThe worker node key.
+
message: MessageValue<Response, unknown>The received message.
+
Returns void
Defined in src/pools/abstract-pool.ts:1111

Protected afterWorkerNodeSetup
afterWorkerNodeSetup(workerNodeKey): 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
Defined in src/pools/abstract-pool.ts:1378

Protected beforeTaskExecutionHook
beforeTaskExecutionHook(workerNodeKey, task): void
Hook executed before the worker task execution.
+
Parameters
workerNodeKey: numberThe newly created worker node key.
+
Returns void
Defined in src/pools/abstract-pool.ts:1378

Protected beforeTaskExecutionHook
beforeTaskExecutionHook(workerNodeKey, task): 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
Defined in src/pools/abstract-pool.ts:1070

Private buildTasksQueueOptions
buildTasksQueueOptions(tasksQueueOptions): TasksQueueOptions
Parameters
tasksQueueOptions: undefined | TasksQueueOptions
Returns TasksQueueOptions
Defined in src/pools/abstract-pool.ts:603

Private cannotStealTask
cannotStealTask(): boolean
Returns boolean
Defined in src/pools/abstract-pool.ts:1429

Protected Abstract checkAndEmitDynamicWorkerCreationEvents
checkAndEmitDynamicWorkerCreationEvents(): void
Emits dynamic worker creation events.
-
Returns void
Defined in src/pools/abstract-pool.ts:1815

Private checkAndEmitEmptyEvent
checkAndEmitEmptyEvent(): void
Returns void
Defined in src/pools/abstract-pool.ts:1869

Private checkAndEmitReadyEvent
checkAndEmitReadyEvent(): void
Returns void
Defined in src/pools/abstract-pool.ts:1724

Private checkAndEmitTaskExecutionEvents
checkAndEmitTaskExecutionEvents(): void
Returns void
Defined in src/pools/abstract-pool.ts:1800

Private checkAndEmitTaskQueuingEvents
checkAndEmitTaskQueuingEvents(): void
Returns void
Defined in src/pools/abstract-pool.ts:1806

Private checkMessageWorkerId
checkMessageWorkerId(message): void
Checks if the worker id sent in the received message from a worker is valid.
-
Parameters
message: MessageValue<Data | Response, unknown>
The received message.
+
Parameters
workerNodeKey: numberThe worker node key.
+
task: Task<Data>The task to execute.
+
Returns void
Defined in src/pools/abstract-pool.ts:1070

Private buildTasksQueueOptions
buildTasksQueueOptions(tasksQueueOptions): TasksQueueOptions
Parameters
tasksQueueOptions: undefined | TasksQueueOptions
Returns TasksQueueOptions
Defined in src/pools/abstract-pool.ts:603

Private cannotStealTask
cannotStealTask(): boolean
Returns boolean
Defined in src/pools/abstract-pool.ts:1429

Protected Abstract checkAndEmitDynamicWorkerCreationEvents
checkAndEmitDynamicWorkerCreationEvents(): void
Emits dynamic worker creation events.
+
Returns void
Defined in src/pools/abstract-pool.ts:1815

Private checkAndEmitEmptyEvent
checkAndEmitEmptyEvent(): void
Returns void
Defined in src/pools/abstract-pool.ts:1869

Private checkAndEmitReadyEvent
checkAndEmitReadyEvent(): void
Returns void
Defined in src/pools/abstract-pool.ts:1724

Private checkAndEmitTaskExecutionEvents
checkAndEmitTaskExecutionEvents(): void
Returns void
Defined in src/pools/abstract-pool.ts:1800

Private checkAndEmitTaskQueuingEvents
checkAndEmitTaskQueuingEvents(): void
Returns void
Defined in src/pools/abstract-pool.ts:1806

Private checkMessageWorkerId
checkMessageWorkerId(message): void
Checks if the worker id sent in the received message from a worker is valid.
+
Parameters
message: MessageValue<Data | Response, unknown>The received message.
 
Returns void
Throws
https://nodejs.org/api/errors.html#class-error If the worker id is invalid.
-
Defined in src/pools/abstract-pool.ts:508

Private checkMinimumNumberOfWorkers
checkMinimumNumberOfWorkers(minimumNumberOfWorkers): void
Parameters
minimumNumberOfWorkers: undefined | number
Returns void
Defined in src/pools/abstract-pool.ts:192

Private checkPoolOptions
checkPoolOptions(opts): void
Parameters
opts: PoolOptions<Worker>
Returns void
Defined in src/pools/abstract-pool.ts:212

Private checkPoolType
checkPoolType(): void
Returns void
Defined in src/pools/abstract-pool.ts:184

Private checkValidWorkerChoiceStrategyOptions
checkValidWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void
Parameters
workerChoiceStrategyOptions: undefined | WorkerChoiceStrategyOptions
Returns void
Defined in src/pools/abstract-pool.ts:238

Private chooseWorkerNode
chooseWorkerNode(): number
Chooses a worker node for the next task.
+
Defined in src/pools/abstract-pool.ts:508

Private checkMinimumNumberOfWorkers
checkMinimumNumberOfWorkers(minimumNumberOfWorkers): void
Parameters
minimumNumberOfWorkers: undefined | number
Returns void
Defined in src/pools/abstract-pool.ts:192

Private checkPoolOptions
checkPoolOptions(opts): void
Parameters
opts: PoolOptions<Worker>
Returns void
Defined in src/pools/abstract-pool.ts:212

Private checkPoolType
checkPoolType(): void
Returns void
Defined in src/pools/abstract-pool.ts:184

Private checkValidWorkerChoiceStrategyOptions
checkValidWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void
Parameters
workerChoiceStrategyOptions: undefined | WorkerChoiceStrategyOptions
Returns void
Defined in src/pools/abstract-pool.ts:238

Private chooseWorkerNode
chooseWorkerNode(): number
Chooses a worker node for the next task.
 The default worker choice strategy uses a round robin algorithm to distribute the tasks.
 
Returns number
The chosen worker node key
-
Defined in src/pools/abstract-pool.ts:1184

Protected createAndSetupDynamicWorkerNode
createAndSetupDynamicWorkerNode(): number
Creates a new, completely set up dynamic worker node.
+
Defined in src/pools/abstract-pool.ts:1184

Protected createAndSetupDynamicWorkerNode
createAndSetupDynamicWorkerNode(): number
Creates a new, completely set up dynamic worker node.
 
Returns number
New, completely set up dynamic worker node key.
-
Defined in src/pools/abstract-pool.ts:1280

Protected createAndSetupWorkerNode
createAndSetupWorkerNode(): number
Creates a new, completely set up worker node.
+
Defined in src/pools/abstract-pool.ts:1280

Protected createAndSetupWorkerNode
createAndSetupWorkerNode(): number
Creates a new, completely set up worker node.
 
Returns number
New, completely set up worker node key.
-
Defined in src/pools/abstract-pool.ts:1223

Private createWorkerNode
createWorkerNode(): IWorkerNode<Worker, Data>
Creates a worker node.
+
Defined in src/pools/abstract-pool.ts:1223

Private createWorkerNode
createWorkerNode(): IWorkerNode<Worker, Data>
Creates a worker node.
 
Returns IWorkerNode<Worker, Data>
The created worker node.
-
Defined in src/pools/abstract-pool.ts:1832

Private deleteTaskFunctionWorkerUsages
deleteTaskFunctionWorkerUsages(name): void
Parameters
name: string
Returns void
Defined in src/pools/abstract-pool.ts:871

Private dequeueTask
dequeueTask(workerNodeKey): undefined | Task<Data>
Parameters
workerNodeKey: number
Returns undefined | Task<Data>
Defined in src/pools/abstract-pool.ts:1924

Protected Abstract deregisterWorkerMessageListener
deregisterWorkerMessageListener<Message>(workerNodeKey, listener): 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) => void)
The message listener callback.
-
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Defined in src/pools/abstract-pool.ts:1365

destroy
destroy(): Promise<void>
Terminates all workers in this pool.
-
Returns Promise<void>
Implementation of IPool.destroy
Defined in src/pools/abstract-pool.ts:977

Protected destroyWorkerNode
destroyWorkerNode(workerNodeKey): Promise<void>
Terminates the worker node given its worker node key.
-
Parameters
workerNodeKey: number
The worker node key.
-
Returns Promise<void>
Defined in src/pools/abstract-pool.ts:1031

enableTasksQueue
enableTasksQueue(enable, tasksQueueOptions?): void
Enables/disables the worker node tasks queue in this pool.
-
Parameters
enable: boolean
Whether to enable or disable the worker node tasks queue.
-
Optional tasksQueueOptions: TasksQueueOptions
The worker node tasks queue options.
-
Returns void
Implementation of IPool.enableTasksQueue
Defined in src/pools/abstract-pool.ts:563

Private enqueueTask
enqueueTask(workerNodeKey, task): number
Parameters
workerNodeKey: number
task: Task<Data>
Returns number
Defined in src/pools/abstract-pool.ts:1918

execute
execute(data?, name?, transferList?): Promise<Response>
Executes the specified function in the worker constructor with the task data input parameter.
-
Parameters
Optional data: Data
The optional task input data for the specified task function. This can only be structured-cloneable data.
-
Optional name: string
The optional name of the task function to execute. If not specified, the default task function will be executed.
-
Optional transferList: TransferListItem[]
An 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 that will be fulfilled when the task is completed.
-
Implementation of IPool.execute
Defined in src/pools/abstract-pool.ts:887

Private executeTask
executeTask(workerNodeKey, task): void
Executes the given task on the worker given its worker node key.
-
Parameters
workerNodeKey: number
The worker node key.
-
task: Task<Data>
The task to execute.
-
Returns void
Defined in src/pools/abstract-pool.ts:1912

Protected flagWorkerNodeAsNotReady
flagWorkerNodeAsNotReady(workerNodeKey): void
Parameters
workerNodeKey: number
Returns void
Defined in src/pools/abstract-pool.ts:1890

Protected flushTasksQueue
flushTasksQueue(workerNodeKey): number
Parameters
workerNodeKey: number
Returns number
Defined in src/pools/abstract-pool.ts:1932

Private flushTasksQueues
flushTasksQueues(): void
Returns void
Defined in src/pools/abstract-pool.ts:1943

Protected getWorkerInfo
getWorkerInfo(workerNodeKey): undefined | WorkerInfo
Gets the worker information given its worker node key.
-
Parameters
workerNodeKey: number
The worker node key.
+
Defined in src/pools/abstract-pool.ts:1832

Private deleteTaskFunctionWorkerUsages
deleteTaskFunctionWorkerUsages(name): void
Parameters
name: string
Returns void
Defined in src/pools/abstract-pool.ts:871

Private dequeueTask
dequeueTask(workerNodeKey): undefined | Task<Data>
Parameters
workerNodeKey: number
Returns undefined | Task<Data>
Defined in src/pools/abstract-pool.ts:1924

Protected Abstract deregisterWorkerMessageListener
deregisterWorkerMessageListener<Message>(workerNodeKey, listener): void
Deregisters a listener callback on the worker given its worker node key.
+
Type Parameters
Message
Parameters
workerNodeKey: numberThe worker node key.
+
listener: ((message) => void)The message listener callback.
+
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Defined in src/pools/abstract-pool.ts:1365

destroy
destroy(): Promise<void>
Returns Promise<void>
Inherit Doc
Implementation of IPool.destroy
Defined in src/pools/abstract-pool.ts:977

Protected destroyWorkerNode
destroyWorkerNode(workerNodeKey): Promise<void>
Terminates the worker node given its worker node key.
+
Parameters
workerNodeKey: numberThe worker node key.
+
Returns Promise<void>
Defined in src/pools/abstract-pool.ts:1031

enableTasksQueue
enableTasksQueue(enable, tasksQueueOptions?): void
Parameters
enable: boolean
Optional tasksQueueOptions: TasksQueueOptions
Returns void
Inherit Doc
Implementation of IPool.enableTasksQueue
Defined in src/pools/abstract-pool.ts:563

Private enqueueTask
enqueueTask(workerNodeKey, task): number
Parameters
workerNodeKey: number
task: Task<Data>
Returns number
Defined in src/pools/abstract-pool.ts:1918

execute
execute(data?, name?, transferList?): Promise<Response>
Parameters
Optional data: Data
Optional name: string
Optional transferList: TransferListItem[]
Returns Promise<Response>
Inherit Doc
Implementation of IPool.execute
Defined in src/pools/abstract-pool.ts:887

Private executeTask
executeTask(workerNodeKey, task): void
Executes the given task on the worker given its worker node key.
+
Parameters
workerNodeKey: numberThe worker node key.
+
task: Task<Data>The task to execute.
+
Returns void
Defined in src/pools/abstract-pool.ts:1912

Protected flagWorkerNodeAsNotReady
flagWorkerNodeAsNotReady(workerNodeKey): void
Parameters
workerNodeKey: number
Returns void
Defined in src/pools/abstract-pool.ts:1890

Protected flushTasksQueue
flushTasksQueue(workerNodeKey): number
Parameters
workerNodeKey: number
Returns number
Defined in src/pools/abstract-pool.ts:1932

Private flushTasksQueues
flushTasksQueues(): void
Returns void
Defined in src/pools/abstract-pool.ts:1943

Protected getWorkerInfo
getWorkerInfo(workerNodeKey): undefined | WorkerInfo
Gets the worker information given its worker node key.
+
Parameters
workerNodeKey: numberThe worker node key.
 
Returns undefined | WorkerInfo
The worker information.
-
Defined in src/pools/abstract-pool.ts:1823

Private getWorkerNodeKeyByWorkerId
getWorkerNodeKeyByWorkerId(workerId): number
Gets the worker node key given its worker id.
-
Parameters
workerId: undefined | number
The worker id.
+
Defined in src/pools/abstract-pool.ts:1823

Private getWorkerNodeKeyByWorkerId
getWorkerNodeKeyByWorkerId(workerId): number
Gets the worker node key given its worker id.
+
Parameters
workerId: undefined | numberThe worker id.
 
Returns number
The worker node key if the worker id is found in the pool worker nodes, -1 otherwise.
-
Defined in src/pools/abstract-pool.ts:524

Private handleTask
handleTask(workerNodeKey, task): void
Parameters
workerNodeKey: number
task: Task<Data>
Returns void
Defined in src/pools/abstract-pool.ts:1433

Private handleTaskExecutionResponse
handleTaskExecutionResponse(message): void
Parameters
message: MessageValue<Response, unknown>
Returns void
Defined in src/pools/abstract-pool.ts:1743

Private Readonly handleWorkerNodeBackPressureEvent
handleWorkerNodeBackPressureEvent(eventDetail): void
Parameters
eventDetail: WorkerNodeEventDetail
Returns void
Defined in src/pools/abstract-pool.ts:1648

Private Readonly handleWorkerNodeIdleEvent
handleWorkerNodeIdleEvent(eventDetail, previousStolenTask?): void
Parameters
eventDetail: WorkerNodeEventDetail
Optional previousStolenTask: Task<Data>
Returns void
Defined in src/pools/abstract-pool.ts:1536

Private handleWorkerReadyResponse
handleWorkerReadyResponse(message): void
Parameters
message: MessageValue<Response, unknown>
Returns void
Defined in src/pools/abstract-pool.ts:1731

Private hasBackPressure
hasBackPressure(): boolean
Returns boolean
Defined in src/pools/abstract-pool.ts:1897

hasTaskFunction
hasTaskFunction(name): boolean
Whether the specified task function exists in this pool.
-
Parameters
name: string
The name of the task function.
-
Returns boolean
true if the task function exists, false otherwise.
-
Implementation of IPool.hasTaskFunction
Defined in src/pools/abstract-pool.ts:799

Private initializeEventEmitter
initializeEventEmitter(): void
Returns void
Defined in src/pools/abstract-pool.ts:270

Protected internalBusy
internalBusy(): boolean
Whether worker nodes are executing concurrently their tasks quota or not.
+
Defined in src/pools/abstract-pool.ts:524

Private handleTask
handleTask(workerNodeKey, task): void
Parameters
workerNodeKey: number
task: Task<Data>
Returns void
Defined in src/pools/abstract-pool.ts:1433

Private handleTaskExecutionResponse
handleTaskExecutionResponse(message): void
Parameters
message: MessageValue<Response, unknown>
Returns void
Defined in src/pools/abstract-pool.ts:1743

Private Readonly handleWorkerNodeBackPressureEvent
handleWorkerNodeBackPressureEvent(eventDetail): void
Parameters
eventDetail: WorkerNodeEventDetail
Returns void
Defined in src/pools/abstract-pool.ts:1648

Private Readonly handleWorkerNodeIdleEvent
handleWorkerNodeIdleEvent(eventDetail, previousStolenTask?): void
Parameters
eventDetail: WorkerNodeEventDetail
Optional previousStolenTask: Task<Data>
Returns void
Defined in src/pools/abstract-pool.ts:1536

Private handleWorkerReadyResponse
handleWorkerReadyResponse(message): void
Parameters
message: MessageValue<Response, unknown>
Returns void
Defined in src/pools/abstract-pool.ts:1731

Private hasBackPressure
hasBackPressure(): boolean
Returns boolean
Defined in src/pools/abstract-pool.ts:1897

hasTaskFunction
hasTaskFunction(name): boolean
Parameters
name: string
Returns boolean
Inherit Doc
Implementation of IPool.hasTaskFunction
Defined in src/pools/abstract-pool.ts:799

Private initializeEventEmitter
initializeEventEmitter(): void
Returns void
Defined in src/pools/abstract-pool.ts:270

Protected internalBusy
internalBusy(): boolean
Whether worker nodes are executing concurrently their tasks quota or not.
 
Returns boolean
Worker nodes busyness boolean status.
-
Defined in src/pools/abstract-pool.ts:677

Protected Abstract isMain
isMain(): boolean
Should return whether the worker is the main worker or not.
-
Returns boolean
Defined in src/pools/abstract-pool.ts:1061

Private isWorkerNodeBusy
isWorkerNodeBusy(workerNodeKey): boolean
Parameters
workerNodeKey: number
Returns boolean
Defined in src/pools/abstract-pool.ts:697

listTaskFunctionNames
listTaskFunctionNames(): string[]
Lists the names of task function available in this pool.
-
Returns string[]
The names of task function available in this pool.
-
Implementation of IPool.listTaskFunctionNames
Defined in src/pools/abstract-pool.ts:851

Private redistributeQueuedTasks
redistributeQueuedTasks(workerNodeKey): void
Parameters
workerNodeKey: number
Returns void
Defined in src/pools/abstract-pool.ts:1441

Protected Abstract registerOnceWorkerMessageListener
registerOnceWorkerMessageListener<Message>(workerNodeKey, listener): void
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) => void)
The message listener callback.
-
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Defined in src/pools/abstract-pool.ts:1352

Protected Abstract registerWorkerMessageListener
registerWorkerMessageListener<Message>(workerNodeKey, listener): 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) => void)
The message listener callback.
-
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Defined in src/pools/abstract-pool.ts:1339

removeTaskFunction
removeTaskFunction(name): Promise<boolean>
Removes a task function from this pool.
-
Parameters
name: string
The name of the task function.
-
Returns Promise<boolean>
true if the task function was removed, false otherwise.
-
Implementation of IPool.removeTaskFunction
Defined in src/pools/abstract-pool.ts:835

Private removeWorkerNode
removeWorkerNode(workerNode): void
Removes the worker node from the pool worker nodes.
-
Parameters
workerNode: IWorkerNode<Worker, Data>
The worker node.
-
Returns void
Defined in src/pools/abstract-pool.ts:1881

Private resetTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage
resetTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage(workerNodeKey, taskName): void
Parameters
workerNodeKey: number
taskName: string
Returns void
Defined in src/pools/abstract-pool.ts:1520

Private resetTaskSequentiallyStolenStatisticsWorkerUsage
resetTaskSequentiallyStolenStatisticsWorkerUsage(workerNodeKey): void
Parameters
workerNodeKey: number
Returns void
Defined in src/pools/abstract-pool.ts:1510

Private sendKillMessageToWorker
sendKillMessageToWorker(workerNodeKey): Promise<void>
Parameters
workerNodeKey: number
Returns Promise<void>
Defined in src/pools/abstract-pool.ts:1001

Protected Abstract sendStartupMessageToWorker
sendStartupMessageToWorker(workerNodeKey): void
Sends the startup message to worker given its worker node key.
-
Parameters
workerNodeKey: number
The worker node key.
-
Returns void
Defined in src/pools/abstract-pool.ts:1409

Private sendStatisticsMessageToWorker
sendStatisticsMessageToWorker(workerNodeKey): void
Sends the statistics message to worker given its worker node key.
-
Parameters
workerNodeKey: number
The worker node key.
-
Returns void
Defined in src/pools/abstract-pool.ts:1416

Private sendTaskFunctionOperationToWorker
sendTaskFunctionOperationToWorker(workerNodeKey, message): Promise<boolean>
Parameters
workerNodeKey: number
message: MessageValue<Data, unknown>
Returns Promise<boolean>
Defined in src/pools/abstract-pool.ts:708

Private sendTaskFunctionOperationToWorkers
sendTaskFunctionOperationToWorkers(message): Promise<boolean>
Parameters
message: MessageValue<Data, unknown>
Returns Promise<boolean>
Defined in src/pools/abstract-pool.ts:745

Protected Abstract sendToWorker
sendToWorker(workerNodeKey, message, transferList?): void
Sends a message to worker given its worker node key.
-
Parameters
workerNodeKey: number
The worker node key.
-
message: MessageValue<Data, unknown>
The message.
-
Optional transferList: TransferListItem[]
The optional array of transferable objects.
-
Returns void
Defined in src/pools/abstract-pool.ts:1212

setDefaultTaskFunction
setDefaultTaskFunction(name): Promise<boolean>
Sets the default task function in this pool.
-
Parameters
name: string
The name of the task function.
-
Returns Promise<boolean>
true if the default task function was set, false otherwise.
-
Implementation of IPool.setDefaultTaskFunction
Defined in src/pools/abstract-pool.ts:864

Private setTaskStealing
setTaskStealing(): void
Returns void
Defined in src/pools/abstract-pool.ts:620

setTasksQueueOptions
setTasksQueueOptions(tasksQueueOptions): void
Sets the worker node tasks queue options in this pool.
-
Parameters
tasksQueueOptions: undefined | TasksQueueOptions
The worker node tasks queue options.
-
Returns void
Implementation of IPool.setTasksQueueOptions
Defined in src/pools/abstract-pool.ts:577

Private setTasksQueueSize
setTasksQueueSize(size): void
Parameters
size: number
Returns void
Defined in src/pools/abstract-pool.ts:614

Private setTasksStealingOnBackPressure
setTasksStealingOnBackPressure(): void
Returns void
Defined in src/pools/abstract-pool.ts:635

setWorkerChoiceStrategy
setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void
Sets the worker choice strategy in this pool.
-
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
The worker choice strategy.
-
Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
The worker choice strategy options.
-
Returns void
Implementation of IPool.setWorkerChoiceStrategy
Defined in src/pools/abstract-pool.ts:531

setWorkerChoiceStrategyOptions
setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void
Sets the worker choice strategy options in this pool.
-
Parameters
workerChoiceStrategyOptions: undefined | WorkerChoiceStrategyOptions
The worker choice strategy options.
-
Returns void
Implementation of IPool.setWorkerChoiceStrategyOptions
Defined in src/pools/abstract-pool.ts:550

Protected setupHook
setupHook(): void
Setup hook to execute code before worker nodes are created in the abstract constructor.
+
Defined in src/pools/abstract-pool.ts:677

Protected Abstract isMain
isMain(): boolean
Should return whether the worker is the main worker or not.
+
Returns boolean
Defined in src/pools/abstract-pool.ts:1061

Private isWorkerNodeBusy
isWorkerNodeBusy(workerNodeKey): boolean
Parameters
workerNodeKey: number
Returns boolean
Defined in src/pools/abstract-pool.ts:697

listTaskFunctionNames
listTaskFunctionNames(): string[]
Returns string[]
Inherit Doc
Implementation of IPool.listTaskFunctionNames
Defined in src/pools/abstract-pool.ts:851

Private redistributeQueuedTasks
redistributeQueuedTasks(workerNodeKey): void
Parameters
workerNodeKey: number
Returns void
Defined in src/pools/abstract-pool.ts:1441

Protected Abstract registerOnceWorkerMessageListener
registerOnceWorkerMessageListener<Message>(workerNodeKey, listener): void
Registers once a listener callback on the worker given its worker node key.
+
Type Parameters
Message
Parameters
workerNodeKey: numberThe worker node key.
+
listener: ((message) => void)The message listener callback.
+
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Defined in src/pools/abstract-pool.ts:1352

Protected Abstract registerWorkerMessageListener
registerWorkerMessageListener<Message>(workerNodeKey, listener): void
Registers a listener callback on the worker given its worker node key.
+
Type Parameters
Message
Parameters
workerNodeKey: numberThe worker node key.
+
listener: ((message) => void)The message listener callback.
+
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Defined in src/pools/abstract-pool.ts:1339

removeTaskFunction
removeTaskFunction(name): Promise<boolean>
Parameters
name: string
Returns Promise<boolean>
Inherit Doc
Implementation of IPool.removeTaskFunction
Defined in src/pools/abstract-pool.ts:835

Private removeWorkerNode
removeWorkerNode(workerNode): void
Removes the worker node from the pool worker nodes.
+
Parameters
workerNode: IWorkerNode<Worker, Data>The worker node.
+
Returns void
Defined in src/pools/abstract-pool.ts:1881

Private resetTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage
resetTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage(workerNodeKey, taskName): void
Parameters
workerNodeKey: number
taskName: string
Returns void
Defined in src/pools/abstract-pool.ts:1520

Private resetTaskSequentiallyStolenStatisticsWorkerUsage
resetTaskSequentiallyStolenStatisticsWorkerUsage(workerNodeKey): void
Parameters
workerNodeKey: number
Returns void
Defined in src/pools/abstract-pool.ts:1510

Private sendKillMessageToWorker
sendKillMessageToWorker(workerNodeKey): Promise<void>
Parameters
workerNodeKey: number
Returns Promise<void>
Defined in src/pools/abstract-pool.ts:1001

Protected Abstract sendStartupMessageToWorker
sendStartupMessageToWorker(workerNodeKey): void
Sends the startup message to worker given its worker node key.
+
Parameters
workerNodeKey: numberThe worker node key.
+
Returns void
Defined in src/pools/abstract-pool.ts:1409

Private sendStatisticsMessageToWorker
sendStatisticsMessageToWorker(workerNodeKey): void
Sends the statistics message to worker given its worker node key.
+
Parameters
workerNodeKey: numberThe worker node key.
+
Returns void
Defined in src/pools/abstract-pool.ts:1416

Private sendTaskFunctionOperationToWorker
sendTaskFunctionOperationToWorker(workerNodeKey, message): Promise<boolean>
Parameters
workerNodeKey: number
message: MessageValue<Data, unknown>
Returns Promise<boolean>
Defined in src/pools/abstract-pool.ts:708

Private sendTaskFunctionOperationToWorkers
sendTaskFunctionOperationToWorkers(message): Promise<boolean>
Parameters
message: MessageValue<Data, unknown>
Returns Promise<boolean>
Defined in src/pools/abstract-pool.ts:745

Protected Abstract sendToWorker
sendToWorker(workerNodeKey, message, transferList?): void
Sends a message to worker given its worker node key.
+
Parameters
workerNodeKey: numberThe worker node key.
+
message: MessageValue<Data, unknown>The message.
+
Optional transferList: TransferListItem[]The optional array of transferable objects.
+
Returns void
Defined in src/pools/abstract-pool.ts:1212

setDefaultTaskFunction
setDefaultTaskFunction(name): Promise<boolean>
Parameters
name: string
Returns Promise<boolean>
Inherit Doc
Implementation of IPool.setDefaultTaskFunction
Defined in src/pools/abstract-pool.ts:864

Private setTaskStealing
setTaskStealing(): void
Returns void
Defined in src/pools/abstract-pool.ts:620

setTasksQueueOptions
setTasksQueueOptions(tasksQueueOptions): void
Parameters
tasksQueueOptions: undefined | TasksQueueOptions
Returns void
Inherit Doc
Implementation of IPool.setTasksQueueOptions
Defined in src/pools/abstract-pool.ts:577

Private setTasksQueueSize
setTasksQueueSize(size): void
Parameters
size: number
Returns void
Defined in src/pools/abstract-pool.ts:614

Private setTasksStealingOnBackPressure
setTasksStealingOnBackPressure(): void
Returns void
Defined in src/pools/abstract-pool.ts:635

setWorkerChoiceStrategy
setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
Returns void
Inherit Doc
Implementation of IPool.setWorkerChoiceStrategy
Defined in src/pools/abstract-pool.ts:531

setWorkerChoiceStrategyOptions
setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void
Parameters
workerChoiceStrategyOptions: undefined | WorkerChoiceStrategyOptions
Returns void
Inherit Doc
Implementation of IPool.setWorkerChoiceStrategyOptions
Defined in src/pools/abstract-pool.ts:550

Protected setupHook
setupHook(): void
Setup hook to execute code before worker nodes are created in the abstract constructor.
 Can be overridden.
-
Returns void
Defined in src/pools/abstract-pool.ts:1054

Protected Abstract shallCreateDynamicWorker
shallCreateDynamicWorker(): boolean
Conditions for dynamic worker creation.
+
Returns void
Defined in src/pools/abstract-pool.ts:1054

Protected Abstract shallCreateDynamicWorker
shallCreateDynamicWorker(): boolean
Conditions for dynamic worker creation.
 
Returns boolean
Whether to create a dynamic worker or not.
-
Defined in src/pools/abstract-pool.ts:1203

Private shallExecuteTask
shallExecuteTask(workerNodeKey): boolean
Parameters
workerNodeKey: number
Returns boolean
Defined in src/pools/abstract-pool.ts:877

Private shallUpdateTaskFunctionWorkerUsage
shallUpdateTaskFunctionWorkerUsage(workerNodeKey): boolean
Whether the worker node shall update its task function worker usage or not.
-
Parameters
workerNodeKey: number
The worker node key.
+
Defined in src/pools/abstract-pool.ts:1203

Private shallExecuteTask
shallExecuteTask(workerNodeKey): boolean
Parameters
workerNodeKey: number
Returns boolean
Defined in src/pools/abstract-pool.ts:877

Private shallUpdateTaskFunctionWorkerUsage
shallUpdateTaskFunctionWorkerUsage(workerNodeKey): boolean
Whether the worker node shall update its task function worker usage or not.
+
Parameters
workerNodeKey: numberThe worker node key.
 
Returns boolean
true if the worker node shall update its task function worker usage, false otherwise.
-
Defined in src/pools/abstract-pool.ts:1168

start
start(): void
Starts the minimum number of workers in this pool.
-
Returns void
Implementation of IPool.start
Defined in src/pools/abstract-pool.ts:952

Private tasksQueueSize
tasksQueueSize(workerNodeKey): number
Parameters
workerNodeKey: number
Returns number
Defined in src/pools/abstract-pool.ts:1928

Private unsetTaskStealing
unsetTaskStealing(): void
Returns void
Defined in src/pools/abstract-pool.ts:626

Private unsetTasksStealingOnBackPressure
unsetTasksStealingOnBackPressure(): void
Returns void
Defined in src/pools/abstract-pool.ts:644

Private updateTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage
updateTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage(workerNodeKey, taskName): void
Parameters
workerNodeKey: number
taskName: string
Returns void
Defined in src/pools/abstract-pool.ts:1494

Private updateTaskSequentiallyStolenStatisticsWorkerUsage
updateTaskSequentiallyStolenStatisticsWorkerUsage(workerNodeKey): void
Parameters
workerNodeKey: number
Returns void
Defined in src/pools/abstract-pool.ts:1484

Private updateTaskStolenStatisticsWorkerUsage
updateTaskStolenStatisticsWorkerUsage(workerNodeKey, taskName): void
Parameters
workerNodeKey: number
taskName: string
Returns void
Defined in src/pools/abstract-pool.ts:1464

Protected Readonly workerMessageListener
workerMessageListener(message): void
This method is the message listener registered on each worker.
-
Parameters
message: MessageValue<Response, unknown>
Returns void
Defined in src/pools/abstract-pool.ts:1702

Private Readonly workerNodeStealTask
workerNodeStealTask(workerNodeKey): undefined | Task<Data>
Parameters
workerNodeKey: number
Returns undefined | Task<Data>
Defined in src/pools/abstract-pool.ts:1621

Generated using TypeDoc


\ No newline at end of file
+
Defined in src/pools/abstract-pool.ts:1168

start
start(): void
Returns void
Inherit Doc
Implementation of IPool.start
Defined in src/pools/abstract-pool.ts:952

Private tasksQueueSize
tasksQueueSize(workerNodeKey): number
Parameters
workerNodeKey: number
Returns number
Defined in src/pools/abstract-pool.ts:1928

Private unsetTaskStealing
unsetTaskStealing(): void
Returns void
Defined in src/pools/abstract-pool.ts:626

Private unsetTasksStealingOnBackPressure
unsetTasksStealingOnBackPressure(): void
Returns void
Defined in src/pools/abstract-pool.ts:644

Private updateTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage
updateTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage(workerNodeKey, taskName): void
Parameters
workerNodeKey: number
taskName: string
Returns void
Defined in src/pools/abstract-pool.ts:1494

Private updateTaskSequentiallyStolenStatisticsWorkerUsage
updateTaskSequentiallyStolenStatisticsWorkerUsage(workerNodeKey): void
Parameters
workerNodeKey: number
Returns void
Defined in src/pools/abstract-pool.ts:1484

Private updateTaskStolenStatisticsWorkerUsage
updateTaskStolenStatisticsWorkerUsage(workerNodeKey, taskName): void
Parameters
workerNodeKey: number
taskName: string
Returns void
Defined in src/pools/abstract-pool.ts:1464

Protected Readonly workerMessageListener
workerMessageListener(message): void
This method is the message listener registered on each worker.
+
Parameters
message: MessageValue<Response, unknown>
Returns void
Defined in src/pools/abstract-pool.ts:1702

Private Readonly workerNodeStealTask
workerNodeStealTask(workerNodeKey): undefined | Task<Data>
Parameters
workerNodeKey: number
Returns undefined | Task<Data>
Defined in src/pools/abstract-pool.ts:1621

Generated using TypeDoc


\ No newline at end of file
diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html
index e54d1b0f..863a0df7 100644
--- a/docs/classes/AbstractWorker.html
+++ b/docs/classes/AbstractWorker.html
@@ -1,98 +1,98 @@
-AbstractWorker | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
AbstractWorker
Class AbstractWorker<MainWorker, Data, Response>Abstract 
Base class that implements some shared logic for all poolifier workers.
-
 Type Parameters
MainWorker extends Worker | MessagePort
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 full)
AbstractWorkerClusterWorker
ThreadWorker
Defined in src/worker/abstract-worker.ts:54
 Index
Constructors
constructor
-
Properties
activeInterval?
-id
-isMain
-lastTaskTimestamp
-mainWorker
-opts
-statistics?
-taskFunctions
-
Methods
addTaskFunction
-beginTaskPerformance
-checkActive
-checkMessageWorkerId
-checkTaskFunctions
-checkWorkerOptions
-endTaskPerformance
-getMainWorker
-handleError
-handleKillMessage
-handleReadyMessage
-handleTaskFunctionOperationMessage
-hasTaskFunction
-listTaskFunctionNames
-messageListener
-removeTaskFunction
-run
-runAsync
-runSync
-sendTaskFunctionNamesToMainWorker
-sendToMainWorker
-setDefaultTaskFunction
-startCheckActive
-stopCheckActive
-updateLastTaskTimestamp
-
Constructors
constructor
new AbstractWorker<MainWorker, Data, Response>(isMain, mainWorker, taskFunctions, opts?): AbstractWorker<MainWorker, Data, Response>
Constructs a new poolifier worker.
-
Type Parameters
MainWorker extends MessagePort | Worker
Data = unknown
Response = unknown
Parameters
isMain: undefined | boolean
Whether this is the main worker or not.
-
mainWorker: undefined | null | MainWorker
Reference to main worker.
-
taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>
Task function(s) processed by the worker when the pool's execution function is invoked. The first function is the default function.
-
opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
Options for the worker.
-
Returns AbstractWorker<MainWorker, Data, Response>
Defined in src/worker/abstract-worker.ts:88
Properties
Protected Optional activeInterval
activeInterval?: Timeout
Handler id of the activeInterval worker activity check.
-
Defined in src/worker/abstract-worker.ts:78
Protected Abstract id
id: number
Worker id.
-
Defined in src/worker/abstract-worker.ts:62
Protected Readonly isMain
isMain: undefined | boolean
Whether this is the main worker or not.
-
Defined in src/worker/abstract-worker.ts:89
Protected lastTaskTimestamp
lastTaskTimestamp: number
Timestamp of the last task processed by this worker.
-
Defined in src/worker/abstract-worker.ts:70
Private Readonly mainWorker
mainWorker: undefined | null | MainWorker
Reference to main worker.
-
Defined in src/worker/abstract-worker.ts:90
Protected opts
opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
Options for the worker.
-
Defined in src/worker/abstract-worker.ts:92
Protected Optional statistics
statistics?: WorkerStatistics
Performance statistics computation requirements.
-
Defined in src/worker/abstract-worker.ts:74
Protected taskFunctions
taskFunctions: Map<string, TaskFunction<Data, Response>>
Task function(s) processed by the worker when the pool's execution function is invoked.
-
Defined in src/worker/abstract-worker.ts:66
Methods
addTaskFunction
addTaskFunction(name, fn): TaskFunctionOperationResult
Adds a task function to the worker.
+AbstractWorker | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
AbstractWorker
Class AbstractWorker<MainWorker, Data, Response>Abstract 
Base class that implements some shared logic for all poolifier workers.
+
 Type Parameters
MainWorker extends Worker | MessagePortType of main worker.
+
Data = unknownType of data this worker receives from pool's execution. This can only be structured-cloneable data.
+
Response = unknownType of response the worker sends back to the main worker. This can only be structured-cloneable data.
+
 Hierarchy (view full)
AbstractWorkerClusterWorker
ThreadWorker
Defined in src/worker/abstract-worker.ts:54
 Index
Constructors
constructor
+
Properties
activeInterval?
+id
+isMain
+lastTaskTimestamp
+mainWorker
+opts
+statistics?
+taskFunctions
+
Methods
addTaskFunction
+beginTaskPerformance
+checkActive
+checkMessageWorkerId
+checkTaskFunctions
+checkWorkerOptions
+endTaskPerformance
+getMainWorker
+handleError
+handleKillMessage
+handleReadyMessage
+handleTaskFunctionOperationMessage
+hasTaskFunction
+listTaskFunctionNames
+messageListener
+removeTaskFunction
+run
+runAsync
+runSync
+sendTaskFunctionNamesToMainWorker
+sendToMainWorker
+setDefaultTaskFunction
+startCheckActive
+stopCheckActive
+updateLastTaskTimestamp
+
Constructors
constructor
new AbstractWorker<MainWorker, Data, Response>(isMain, mainWorker, taskFunctions, opts?): AbstractWorker<MainWorker, Data, Response>
Constructs a new poolifier worker.
+
Type Parameters
MainWorker extends MessagePort | Worker
Data = unknown
Response = unknown
Parameters
isMain: undefined | booleanWhether this is the main worker or not.
+
mainWorker: undefined | null | MainWorkerReference to main worker.
+
taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>Task function(s) processed by the worker when the pool's execution function is invoked. The first function is the default function.
+
opts: WorkerOptions = DEFAULT_WORKER_OPTIONSOptions for the worker.
+
Returns AbstractWorker<MainWorker, Data, Response>
Defined in src/worker/abstract-worker.ts:88
Properties
Protected Optional activeInterval
activeInterval?: Timeout
Handler id of the activeInterval worker activity check.
+
Defined in src/worker/abstract-worker.ts:78
Protected Abstract id
id: number
Worker id.
+
Defined in src/worker/abstract-worker.ts:62
Protected Readonly isMain
isMain: undefined | boolean
Whether this is the main worker or not.
+
Defined in src/worker/abstract-worker.ts:89
Protected lastTaskTimestamp
lastTaskTimestamp: number
Timestamp of the last task processed by this worker.
+
Defined in src/worker/abstract-worker.ts:70
Private Readonly mainWorker
mainWorker: undefined | null | MainWorker
Reference to main worker.
+
Defined in src/worker/abstract-worker.ts:90
Protected opts
opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
Options for the worker.
+
Defined in src/worker/abstract-worker.ts:92
Protected Optional statistics
statistics?: WorkerStatistics
Performance statistics computation requirements.
+
Defined in src/worker/abstract-worker.ts:74
Protected taskFunctions
taskFunctions: Map<string, TaskFunction<Data, Response>>
Task function(s) processed by the worker when the pool's execution function is invoked.
+
Defined in src/worker/abstract-worker.ts:66
Methods
addTaskFunction
addTaskFunction(name, fn): TaskFunctionOperationResult
Adds a task function to the worker.
 If a task function with the same name already exists, it is replaced.
-
Parameters
name: string
The name of the task function to add.
-
fn: TaskFunction<Data, Response>
The task function to add.
+
Parameters
name: stringThe name of the task function to add.
+
fn: TaskFunction<Data, Response>The task function to add.
 
Returns TaskFunctionOperationResult
Whether the task function was added or not.
-
Defined in src/worker/abstract-worker.ts:179
Private beginTaskPerformance
beginTaskPerformance(name?): TaskPerformance
Parameters
Optional name: string
Returns TaskPerformance
Defined in src/worker/abstract-worker.ts:588
Private checkActive
checkActive(): void
Checks if the worker should be terminated, because its living too long.
-
Returns void
Defined in src/worker/abstract-worker.ts:436
Private checkMessageWorkerId
checkMessageWorkerId(message): void
Check if the message worker id is set and matches the worker id.
-
Parameters
message: MessageValue<Data, unknown>
The message to check.
+
Defined in src/worker/abstract-worker.ts:179
Private beginTaskPerformance
beginTaskPerformance(name?): TaskPerformance
Parameters
Optional name: string
Returns TaskPerformance
Defined in src/worker/abstract-worker.ts:588
Private checkActive
checkActive(): void
Checks if the worker should be terminated, because its living too long.
+
Returns void
Defined in src/worker/abstract-worker.ts:436
Private checkMessageWorkerId
checkMessageWorkerId(message): void
Check if the message worker id is set and matches the worker id.
+
Parameters
message: MessageValue<Data, unknown>The message to check.
 
Returns void
Throws
https://nodejs.org/api/errors.html#class-error If the message worker id is not set or does not match the worker id.
-
Defined in src/worker/abstract-worker.ts:402
Private checkTaskFunctions
checkTaskFunctions(taskFunctions): void
Checks if the taskFunctions parameter is passed to the constructor and valid.
-
Parameters
taskFunctions: undefined | TaskFunction<Data, Response> | TaskFunctions<Data, Response>
The task function(s) parameter that should be checked.
-
Returns void
Defined in src/worker/abstract-worker.ts:115
Private checkWorkerOptions
checkWorkerOptions(opts): void
Parameters
opts: WorkerOptions
Returns void
Defined in src/worker/abstract-worker.ts:105
Private endTaskPerformance
endTaskPerformance(taskPerformance): TaskPerformance
Parameters
taskPerformance: TaskPerformance
Returns TaskPerformance
Defined in src/worker/abstract-worker.ts:601
Protected getMainWorker
getMainWorker(): MainWorker
Returns the main worker.
+
Defined in src/worker/abstract-worker.ts:402
Private checkTaskFunctions
checkTaskFunctions(taskFunctions): void
Checks if the taskFunctions parameter is passed to the constructor and valid.
+
Parameters
taskFunctions: undefined | TaskFunction<Data, Response> | TaskFunctions<Data, Response>The task function(s) parameter that should be checked.
+
Returns void
Defined in src/worker/abstract-worker.ts:115
Private checkWorkerOptions
checkWorkerOptions(opts): void
Parameters
opts: WorkerOptions
Returns void
Defined in src/worker/abstract-worker.ts:105
Private endTaskPerformance
endTaskPerformance(taskPerformance): TaskPerformance
Parameters
taskPerformance: TaskPerformance
Returns TaskPerformance
Defined in src/worker/abstract-worker.ts:601
Protected getMainWorker
getMainWorker(): MainWorker
Returns the main worker.
 
Returns MainWorker
Reference to the main worker.
 Throws
https://nodejs.org/api/errors.html#class-error If the main worker is not set.
-
Defined in src/worker/abstract-worker.ts:451
Protected handleError
handleError(error): string
Handles an error and convert it to a string so it can be sent back to the main worker.
-
Parameters
error: string | Error
The error raised by the worker.
+
Defined in src/worker/abstract-worker.ts:451
Protected handleError
handleError(error): string
Handles an error and convert it to a string so it can be sent back to the main worker.
+
Parameters
error: string | ErrorThe error raised by the worker.
 
Returns string
The error message.
-
Defined in src/worker/abstract-worker.ts:482
Protected handleKillMessage
handleKillMessage(_message): void
Handles a kill message sent by the main worker.
-
Parameters
_message: MessageValue<Data, unknown>
Returns void
Defined in src/worker/abstract-worker.ts:374
Protected Abstract handleReadyMessage
handleReadyMessage(message): void
Handles the ready message sent by the main worker.
-
Parameters
message: MessageValue<Data, unknown>
The ready message.
-
Returns void
Defined in src/worker/abstract-worker.ts:297
Protected handleTaskFunctionOperationMessage
handleTaskFunctionOperationMessage(message): void
Parameters
message: MessageValue<Data, unknown>
Returns void
Defined in src/worker/abstract-worker.ts:324
hasTaskFunction
hasTaskFunction(name): TaskFunctionOperationResult
Checks if the worker has a task function with the given name.
-
Parameters
name: string
The name of the task function to check.
+
Defined in src/worker/abstract-worker.ts:482
Protected handleKillMessage
handleKillMessage(_message): void
Handles a kill message sent by the main worker.
+
Parameters
_message: MessageValue<Data, unknown>
Returns void
Defined in src/worker/abstract-worker.ts:374
Protected Abstract handleReadyMessage
handleReadyMessage(message): void
Handles the ready message sent by the main worker.
+
Parameters
message: MessageValue<Data, unknown>The ready message.
+
Returns void
Defined in src/worker/abstract-worker.ts:297
Protected handleTaskFunctionOperationMessage
handleTaskFunctionOperationMessage(message): void
Parameters
message: MessageValue<Data, unknown>
Returns void
Defined in src/worker/abstract-worker.ts:324
hasTaskFunction
hasTaskFunction(name): TaskFunctionOperationResult
Checks if the worker has a task function with the given name.
+
Parameters
name: stringThe name of the task function to check.
 
Returns TaskFunctionOperationResult
Whether the worker has a task function with the given name or not.
-
Defined in src/worker/abstract-worker.ts:162
listTaskFunctionNames
listTaskFunctionNames(): string[]
Lists the names of the worker's task functions.
+
Defined in src/worker/abstract-worker.ts:162
listTaskFunctionNames
listTaskFunctionNames(): string[]
Lists the names of the worker's task functions.
 
Returns string[]
The names of the worker's task functions.
-
Defined in src/worker/abstract-worker.ts:243
Protected messageListener
messageListener(message): void
Worker message listener.
-
Parameters
message: MessageValue<Data, unknown>
The received message.
-
Returns void
Defined in src/worker/abstract-worker.ts:304
removeTaskFunction
removeTaskFunction(name): TaskFunctionOperationResult
Removes a task function from the worker.
-
Parameters
name: string
The name of the task function to remove.
+
Defined in src/worker/abstract-worker.ts:243
Protected messageListener
messageListener(message): void
Worker message listener.
+
Parameters
message: MessageValue<Data, unknown>The received message.
+
Returns void
Defined in src/worker/abstract-worker.ts:304
removeTaskFunction
removeTaskFunction(name): TaskFunctionOperationResult
Removes a task function from the worker.
+
Parameters
name: stringThe name of the task function to remove.
 
Returns TaskFunctionOperationResult
Whether the task function existed and was removed or not.
-
Defined in src/worker/abstract-worker.ts:214
Protected Readonly run
run(task): void
Runs the given task.
-
Parameters
task: Task<Data>
The task to execute.
-
Returns void
Defined in src/worker/abstract-worker.ts:491
Protected Readonly runAsync
runAsync(fn, task): void
Runs the given task function asynchronously.
-
Parameters
fn: TaskAsyncFunction<Data, Response>
Task function that will be executed.
-
task: Task<Data>
Input data for the task function.
-
Returns void
Defined in src/worker/abstract-worker.ts:555
Protected Readonly runSync
runSync(fn, task): void
Runs the given task function synchronously.
-
Parameters
fn: TaskSyncFunction<Data, Response>
Task function that will be executed.
-
task: Task<Data>
Input data for the task function.
-
Returns void
Defined in src/worker/abstract-worker.ts:520
Protected sendTaskFunctionNamesToMainWorker
sendTaskFunctionNamesToMainWorker(): void
Sends task function names to the main worker.
-
Returns void
Defined in src/worker/abstract-worker.ts:470
Protected Abstract sendToMainWorker
sendToMainWorker(message): void
Sends a message to main worker.
-
Parameters
message: MessageValue<Response, Data>
The response message.
-
Returns void
Defined in src/worker/abstract-worker.ts:463
setDefaultTaskFunction
setDefaultTaskFunction(name): TaskFunctionOperationResult
Sets the default task function to use in the worker.
-
Parameters
name: string
The name of the task function to use as default task function.
+
Defined in src/worker/abstract-worker.ts:214
Protected Readonly run
run(task): void
Runs the given task.
+
Parameters
task: Task<Data>The task to execute.
+
Returns void
Defined in src/worker/abstract-worker.ts:491
Protected Readonly runAsync
runAsync(fn, task): void
Runs the given task function asynchronously.
+
Parameters
fn: TaskAsyncFunction<Data, Response>Task function that will be executed.
+
task: Task<Data>Input data for the task function.
+
Returns void
Defined in src/worker/abstract-worker.ts:555
Protected Readonly runSync
runSync(fn, task): void
Runs the given task function synchronously.
+
Parameters
fn: TaskSyncFunction<Data, Response>Task function that will be executed.
+
task: Task<Data>Input data for the task function.
+
Returns void
Defined in src/worker/abstract-worker.ts:520
Protected sendTaskFunctionNamesToMainWorker
sendTaskFunctionNamesToMainWorker(): void
Sends task function names to the main worker.
+
Returns void
Defined in src/worker/abstract-worker.ts:470
Protected Abstract sendToMainWorker
sendToMainWorker(message): void
Sends a message to main worker.
+
Parameters
message: MessageValue<Response, Data>The response message.
+
Returns void
Defined in src/worker/abstract-worker.ts:463
setDefaultTaskFunction
setDefaultTaskFunction(name): TaskFunctionOperationResult
Sets the default task function to use in the worker.
+
Parameters
name: stringThe name of the task function to use as default task function.
 
Returns TaskFunctionOperationResult
Whether the default task function was set or not.
-
Defined in src/worker/abstract-worker.ts:270
Private startCheckActive
startCheckActive(): void
Starts the worker check active interval.
-
Returns void
Defined in src/worker/abstract-worker.ts:415
Private stopCheckActive
stopCheckActive(): void
Stops the worker check active interval.
-
Returns void
Defined in src/worker/abstract-worker.ts:426
Private updateLastTaskTimestamp
updateLastTaskTimestamp(): void
Returns void
Defined in src/worker/abstract-worker.ts:618
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
constructor
activeInterval
id
isMain
lastTaskTimestamp
mainWorker
opts
statistics
taskFunctions
addTaskFunction
beginTaskPerformance
checkActive
checkMessageWorkerId
checkTaskFunctions
checkWorkerOptions
endTaskPerformance
getMainWorker
handleError
handleKillMessage
handleReadyMessage
handleTaskFunctionOperationMessage
hasTaskFunction
listTaskFunctionNames
messageListener
removeTaskFunction
run
runAsync
runSync
sendTaskFunctionNamesToMainWorker
sendToMainWorker
setDefaultTaskFunction
startCheckActive
stopCheckActive
updateLastTaskTimestamp
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+
Defined in src/worker/abstract-worker.ts:270
Private startCheckActive
startCheckActive(): void
Starts the worker check active interval.
+
Returns void
Defined in src/worker/abstract-worker.ts:415
Private stopCheckActive
stopCheckActive(): void
Stops the worker check active interval.
+
Returns void
Defined in src/worker/abstract-worker.ts:426
Private updateLastTaskTimestamp
updateLastTaskTimestamp(): void
Returns void
Defined in src/worker/abstract-worker.ts:618
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
constructor
activeInterval
id
isMain
lastTaskTimestamp
mainWorker
opts
statistics
taskFunctions
addTaskFunction
beginTaskPerformance
checkActive
checkMessageWorkerId
checkTaskFunctions
checkWorkerOptions
endTaskPerformance
getMainWorker
handleError
handleKillMessage
handleReadyMessage
handleTaskFunctionOperationMessage
hasTaskFunction
listTaskFunctionNames
messageListener
removeTaskFunction
run
runAsync
runSync
sendTaskFunctionNamesToMainWorker
sendToMainWorker
setDefaultTaskFunction
startCheckActive
stopCheckActive
updateLastTaskTimestamp
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html
index cf81e9d7..777d1fe7 100644
--- a/docs/classes/CircularArray.html
+++ b/docs/classes/CircularArray.html
@@ -1,184 +1,184 @@
-CircularArray | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
CircularArray
Class CircularArray<T>Internal 
Array with a maximum length and shifting items when full.
-
 Type Parameters
T
Type of items.
-
 Hierarchy
Array<T>CircularArray
Defined in src/circular-array.ts:11
 Index
Constructors
constructor
-
Properties
[unscopables]
-length
-size
-[species]
-
Methods
[iterator]
-at
-checkSize
-concat
-copyWithin
-empty
-entries
-every
-fill
-filter
-find
-findIndex
-flat
-flatMap
-forEach
-full
-includes
-indexOf
-join
-keys
-lastIndexOf
-map
-pop
-push
-reduce
-reduceRight
-resize
-reverse
-shift
-slice
-some
-sort
-splice
-toLocaleString
-toString
-unshift
-values
-from
-isArray
-of
-
Constructors
constructor
new CircularArray<T>(size?, ...items): CircularArray<T>
Type Parameters
T
Parameters
size: number = DEFAULT_CIRCULAR_ARRAY_SIZE
Rest ...items: T[]
Returns CircularArray<T>
Overrides Array<T>.constructor
Defined in src/circular-array.ts:14
Properties
Readonly [unscopables]
[unscopables]: { 
Â Â Â Â [unscopables]?: boolean; 
Â Â Â Â length?: boolean; 
Â Â Â Â [iterator]?: any; 
Â Â Â Â at?: any; 
Â Â Â Â concat?: any; 
Â Â Â Â copyWithin?: any; 
Â Â Â Â entries?: any; 
Â Â Â Â every?: any; 
Â Â Â Â fill?: any; 
Â Â Â Â filter?: any; 
Â Â Â Â find?: any; 
Â Â Â Â findIndex?: any; 
Â Â Â Â flat?: any; 
Â Â Â Â flatMap?: any; 
Â Â Â Â forEach?: any; 
Â Â Â Â includes?: any; 
Â Â Â Â indexOf?: any; 
Â Â Â Â join?: any; 
Â Â Â Â keys?: any; 
Â Â Â Â lastIndexOf?: any; 
Â Â Â Â map?: any; 
Â Â Â Â pop?: any; 
Â Â Â Â push?: any; 
Â Â Â Â reduce?: any; 
Â Â Â Â reduceRight?: any; 
Â Â Â Â reverse?: any; 
Â Â Â Â shift?: any; 
Â Â Â Â slice?: any; 
Â Â Â Â some?: any; 
Â Â Â Â sort?: any; 
Â Â Â Â splice?: any; 
Â Â Â Â toLocaleString?: any; 
Â Â Â Â toString?: any; 
Â Â Â Â unshift?: any; 
Â Â Â Â values?: any; 
}
Is an object whose properties have the value 'true'
+CircularArray | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
CircularArray
Class CircularArray<T>Internal 
Array with a maximum length and shifting items when full.
+
 Type Parameters
TType of items.
+
 Hierarchy
Array<T>CircularArray
Defined in src/circular-array.ts:11
 Index
Constructors
constructor
+
Properties
[unscopables]
+length
+size
+[species]
+
Methods
[iterator]
+at
+checkSize
+concat
+copyWithin
+empty
+entries
+every
+fill
+filter
+find
+findIndex
+flat
+flatMap
+forEach
+full
+includes
+indexOf
+join
+keys
+lastIndexOf
+map
+pop
+push
+reduce
+reduceRight
+resize
+reverse
+shift
+slice
+some
+sort
+splice
+toLocaleString
+toString
+unshift
+values
+from
+isArray
+of
+
Constructors
constructor
new CircularArray<T>(size?, ...items): CircularArray<T>
Type Parameters
T
Parameters
size: number = DEFAULT_CIRCULAR_ARRAY_SIZE
Rest ...items: T[]
Returns CircularArray<T>
Overrides Array<T>.constructor
Defined in src/circular-array.ts:14
Properties
Readonly [unscopables]
[unscopables]: { 
Â Â Â Â [unscopables]?: boolean; 
Â Â Â Â length?: boolean; 
Â Â Â Â [iterator]?: any; 
Â Â Â Â at?: any; 
Â Â Â Â concat?: any; 
Â Â Â Â copyWithin?: any; 
Â Â Â Â entries?: any; 
Â Â Â Â every?: any; 
Â Â Â Â fill?: any; 
Â Â Â Â filter?: any; 
Â Â Â Â find?: any; 
Â Â Â Â findIndex?: any; 
Â Â Â Â flat?: any; 
Â Â Â Â flatMap?: any; 
Â Â Â Â forEach?: any; 
Â Â Â Â includes?: any; 
Â Â Â Â indexOf?: any; 
Â Â Â Â join?: any; 
Â Â Â Â keys?: any; 
Â Â Â Â lastIndexOf?: any; 
Â Â Â Â map?: any; 
Â Â Â Â pop?: any; 
Â Â Â Â push?: any; 
Â Â Â Â reduce?: any; 
Â Â Â Â reduceRight?: any; 
Â Â Â Â reverse?: any; 
Â Â Â Â shift?: any; 
Â Â Â Â slice?: any; 
Â Â Â Â some?: any; 
Â Â Â Â sort?: any; 
Â Â Â Â splice?: any; 
Â Â Â Â toLocaleString?: any; 
Â Â Â Â toString?: any; 
Â Â Â Â unshift?: any; 
Â Â Â Â values?: any; 
}
Is an object whose properties have the value 'true'
 when they will be absent when used in a 'with' statement.
 
Type declaration
Optional Readonly [unscopables]?: boolean
Is an object whose properties have the value 'true'
 when they will be absent when used in a 'with' statement.
 
Optional length?: boolean
Gets or sets the length of the array. This is a number one higher than the highest index in the array.
-
Inherited from Array.[unscopables]
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:97
length
length: number
Gets or sets the length of the array. This is a number one higher than the highest index in the array.
-
Inherited from Array.length
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1325
size
size: number
Defined in src/circular-array.ts:12
Static Readonly [species]
[species]: ArrayConstructor
Inherited from Array.[species]
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:316
Methods
[iterator]
[iterator](): IterableIterator<T>
Iterator
-
Returns IterableIterator<T>
Inherited from Array.[iterator]
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:58
at
at(index): undefined | T
Returns the item located at the specified index.
-
Parameters
index: number
The zero-based index of the desired code unit. A negative index will count back from the last item.
-
Returns undefined | T
Inherited from Array.at
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2022.array.d.ts:24
Private checkSize
checkSize(size): void
Parameters
size: number
Returns void
Defined in src/circular-array.ts:101
concat
concat(...items): CircularArray<T>
Parameters
Rest ...items: (T | ConcatArray<T>)[]
Returns CircularArray<T>
Inherit Doc
Overrides Array.concat
Defined in src/circular-array.ts:42
copyWithin
copyWithin(target, start, end?): this
Returns the this object after copying a section of the array identified by start and end
+
Inherited from Array.[unscopables]
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:97
length
length: number
Gets or sets the length of the array. This is a number one higher than the highest index in the array.
+
Inherited from Array.length
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1325
size
size: number
Defined in src/circular-array.ts:12
Static Readonly [species]
[species]: ArrayConstructor
Inherited from Array.[species]
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:316
Methods
[iterator]
[iterator](): IterableIterator<T>
Iterator
+
Returns IterableIterator<T>
Inherited from Array.[iterator]
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:58
at
at(index): undefined | T
Returns the item located at the specified index.
+
Parameters
index: numberThe zero-based index of the desired code unit. A negative index will count back from the last item.
+
Returns undefined | T
Inherited from Array.at
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2022.array.d.ts:24
Private checkSize
checkSize(size): void
Parameters
size: number
Returns void
Defined in src/circular-array.ts:101
concat
concat(...items): CircularArray<T>
Parameters
Rest ...items: (T | ConcatArray<T>)[]
Returns CircularArray<T>
Inherit Doc
Overrides Array.concat
Defined in src/circular-array.ts:42
copyWithin
copyWithin(target, start, end?): this
Returns the this object after copying a section of the array identified by start and end
 to the same array starting at position target
-
Parameters
target: number
If target is negative, it is treated as length+target where length is the
+
Parameters
target: numberIf target is negative, it is treated as length+target where length is the
 length of the array.
-
start: number
If start is negative, it is treated as length+start. If end is negative, it
+
start: numberIf start is negative, it is treated as length+start. If end is negative, it
 is treated as length+end.
-
Optional end: number
If not specified, length of the this object is used as its default value.
-
Returns this
Inherited from Array.copyWithin
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.core.d.ts:62
empty
empty(): boolean
Returns boolean
Defined in src/circular-array.ts:93
entries
entries(): IterableIterator<[number, T]>
Returns an iterable of key, value pairs for every entry in the array
-
Returns IterableIterator<[number, T]>
Inherited from Array.entries
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:63
every
every<S>(predicate, thisArg?): this is S[]
Determines whether all the members of an array satisfy the specified test.
-
Type Parameters
S
Parameters
predicate: ((value, index, array) => value is S)
A function that accepts up to three arguments. The every method calls
+
Optional end: numberIf not specified, length of the this object is used as its default value.
+
Returns this
Inherited from Array.copyWithin
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.core.d.ts:62
empty
empty(): boolean
Returns boolean
Defined in src/circular-array.ts:93
entries
entries(): IterableIterator<[number, T]>
Returns an iterable of key, value pairs for every entry in the array
+
Returns IterableIterator<[number, T]>
Inherited from Array.entries
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:63
every
every<S>(predicate, thisArg?): this is S[]
Determines whether all the members of an array satisfy the specified test.
+
Type Parameters
S
Parameters
predicate: ((value, index, array) => value is S)A function that accepts up to three arguments. The every method calls
 the predicate function for each element in the array until the predicate returns a value
 which is coercible to the Boolean value false, or until the end of the array.
-
(value, index, array): value is S
Parameters
value: T
index: number
array: T[]
Returns value is S
Optional thisArg: any
An object to which the this keyword can refer in the predicate function.
+
(value, index, array): value is S
Parameters
value: T
index: number
array: T[]
Returns value is S
Optional thisArg: anyAn object to which the this keyword can refer in the predicate function.
 If thisArg is omitted, undefined is used as the this value.
-
Returns this is S[]
Inherited from Array.every
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1432
every(predicate, thisArg?): boolean
Determines whether all the members of an array satisfy the specified test.
-
Parameters
predicate: ((value, index, array) => unknown)
A function that accepts up to three arguments. The every method calls
+
Returns this is S[]
Inherited from Array.every
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1432
every(predicate, thisArg?): boolean
Determines whether all the members of an array satisfy the specified test.
+
Parameters
predicate: ((value, index, array) => unknown)A function that accepts up to three arguments. The every method calls
 the predicate function for each element in the array until the predicate returns a value
 which is coercible to the Boolean value false, or until the end of the array.
-
(value, index, array): unknown
Parameters
value: T
index: number
array: T[]
Returns unknown
Optional thisArg: any
An object to which the this keyword can refer in the predicate function.
+
(value, index, array): unknown
Parameters
value: T
index: number
array: T[]
Returns unknown
Optional thisArg: anyAn object to which the this keyword can refer in the predicate function.
 If thisArg is omitted, undefined is used as the this value.
-
Returns boolean
Inherited from Array.every
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1441
fill
fill(value, start?, end?): this
Changes all array elements from start to end index to a static value and returns the modified array
-
Parameters
value: T
value to fill array section with
-
Optional start: number
index to start filling the array at. If start is negative, it is treated as
+
Returns boolean
Inherited from Array.every
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1441
fill
fill(value, start?, end?): this
Changes all array elements from start to end index to a static value and returns the modified array
+
Parameters
value: Tvalue to fill array section with
+
Optional start: numberindex to start filling the array at. If start is negative, it is treated as
 length+start where length is the length of the array.
-
Optional end: number
index to stop filling the array at. If end is negative, it is treated as
+
Optional end: numberindex to stop filling the array at. If end is negative, it is treated as
 length+end.
-
Returns this
Inherited from Array.fill
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.core.d.ts:51
filter
filter<S>(predicate, thisArg?): S[]
Returns the elements of an array that meet the condition specified in a callback function.
-
Type Parameters
S
Parameters
predicate: ((value, index, array) => value is S)
A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
-
(value, index, array): value is S
Parameters
value: T
index: number
array: T[]
Returns value is S
Optional thisArg: any
An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
-
Returns S[]
Inherited from Array.filter
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1468
filter(predicate, thisArg?): T[]
Returns the elements of an array that meet the condition specified in a callback function.
-
Parameters
predicate: ((value, index, array) => unknown)
A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
-
(value, index, array): unknown
Parameters
value: T
index: number
array: T[]
Returns unknown
Optional thisArg: any
An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
-
Returns T[]
Inherited from Array.filter
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1474
find
find<S>(predicate, thisArg?): undefined | S
Returns the value of the first element in the array where predicate is true, and undefined
+
Returns this
Inherited from Array.fill
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.core.d.ts:51
filter
filter<S>(predicate, thisArg?): S[]
Returns the elements of an array that meet the condition specified in a callback function.
+
Type Parameters
S
Parameters
predicate: ((value, index, array) => value is S)A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
+
(value, index, array): value is S
Parameters
value: T
index: number
array: T[]
Returns value is S
Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
+
Returns S[]
Inherited from Array.filter
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1468
filter(predicate, thisArg?): T[]
Returns the elements of an array that meet the condition specified in a callback function.
+
Parameters
predicate: ((value, index, array) => unknown)A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
+
(value, index, array): unknown
Parameters
value: T
index: number
array: T[]
Returns unknown
Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
+
Returns T[]
Inherited from Array.filter
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1474
find
find<S>(predicate, thisArg?): undefined | S
Returns the value of the first element in the array where predicate is true, and undefined
 otherwise.
-
Type Parameters
S
Parameters
predicate: ((value, index, obj) => value is S)
find calls predicate once for each element of the array, in ascending
+
Type Parameters
S
Parameters
predicate: ((value, index, obj) => value is S)find calls predicate once for each element of the array, in ascending
 order, until it finds one where predicate returns true. If such an element is found, find
 immediately returns that element value. Otherwise, find returns undefined.
-
(value, index, obj): value is S
Parameters
value: T
index: number
obj: T[]
Returns value is S
Optional thisArg: any
If provided, it will be used as the this value for each invocation of
+
(value, index, obj): value is S
Parameters
value: T
index: number
obj: T[]
Returns value is S
Optional thisArg: anyIf provided, it will be used as the this value for each invocation of
 predicate. If it is not provided, undefined is used instead.
-
Returns undefined | S
Inherited from Array.find
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.core.d.ts:29
find(predicate, thisArg?): undefined | T
Parameters
predicate: ((value, index, obj) => unknown)
(value, index, obj): unknown
Parameters
value: T
index: number
obj: T[]
Returns unknown
Optional thisArg: any
Returns undefined | T
Inherited from Array.find
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.core.d.ts:30
findIndex
findIndex(predicate, thisArg?): number
Returns the index of the first element in the array where predicate is true, and -1
+
Returns undefined | S
Inherited from Array.find
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.core.d.ts:29
find(predicate, thisArg?): undefined | T
Parameters
predicate: ((value, index, obj) => unknown)(value, index, obj): unknown
Parameters
value: T
index: number
obj: T[]
Returns unknown
Optional thisArg: any
Returns undefined | T
Inherited from Array.find
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.core.d.ts:30
findIndex
findIndex(predicate, thisArg?): number
Returns the index of the first element in the array where predicate is true, and -1
 otherwise.
-
Parameters
predicate: ((value, index, obj) => unknown)
find calls predicate once for each element of the array, in ascending
+
Parameters
predicate: ((value, index, obj) => unknown)find calls predicate once for each element of the array, in ascending
 order, until it finds one where predicate returns true. If such an element is found,
 findIndex immediately returns that element index. Otherwise, findIndex returns -1.
-
(value, index, obj): unknown
Parameters
value: T
index: number
obj: T[]
Returns unknown
Optional thisArg: any
If provided, it will be used as the this value for each invocation of
+
(value, index, obj): unknown
Parameters
value: T
index: number
obj: T[]
Returns unknown
Optional thisArg: anyIf provided, it will be used as the this value for each invocation of
 predicate. If it is not provided, undefined is used instead.
-
Returns number
Inherited from Array.findIndex
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.core.d.ts:41
flat
flat<A, D>(this, depth?): FlatArray<A, D>[]
Returns a new array with all sub-array elements concatenated into it recursively up to the
+
Returns number
Inherited from Array.findIndex
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.core.d.ts:41
flat
flat<A, D>(this, depth?): FlatArray<A, D>[]
Returns a new array with all sub-array elements concatenated into it recursively up to the
 specified depth.
-
Type Parameters
A
D extends number = 1
Parameters
this: A
Optional depth: D
The maximum recursion depth
-
Returns FlatArray<A, D>[]
Inherited from Array.flat
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2019.array.d.ts:75
flatMap
flatMap<U, This>(callback, thisArg?): U[]
Calls a defined callback function on each element of an array. Then, flattens the result into
+
Type Parameters
A
D extends number = 1
Parameters
this: A
Optional depth: DThe maximum recursion depth
+
Returns FlatArray<A, D>[]
Inherited from Array.flat
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2019.array.d.ts:75
flatMap
flatMap<U, This>(callback, thisArg?): U[]
Calls a defined callback function on each element of an array. Then, flattens the result into
 a new array.
 This is identical to a map followed by flat with depth 1.
-
Type Parameters
U
This = undefined
Parameters
callback: ((this, value, index, array) => U | readonly U[])
A function that accepts up to three arguments. The flatMap method calls the
+
Type Parameters
U
This = undefined
Parameters
callback: ((this, value, index, array) => U | readonly U[])A function that accepts up to three arguments. The flatMap method calls the
 callback function one time for each element in the array.
-
(this, value, index, array): U | readonly U[]
Parameters
this: This
value: T
index: number
array: T[]
Returns U | readonly U[]
Optional thisArg: This
An object to which the this keyword can refer in the callback function. If
+
(this, value, index, array): U | readonly U[]
Parameters
this: This
value: T
index: number
array: T[]
Returns U | readonly U[]
Optional thisArg: ThisAn object to which the this keyword can refer in the callback function. If
 thisArg is omitted, undefined is used as the this value.
-
Returns U[]
Inherited from Array.flatMap
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2019.array.d.ts:64
forEach
forEach(callbackfn, thisArg?): void
Performs the specified action for each element in an array.
-
Parameters
callbackfn: ((value, index, array) => void)
A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
-
(value, index, array): void
Parameters
value: T
index: number
array: T[]
Returns void
Optional thisArg: any
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
-
Returns void
Inherited from Array.forEach
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1456
full
full(): boolean
Returns boolean
Defined in src/circular-array.ts:97
includes
includes(searchElement, fromIndex?): boolean
Determines whether an array includes a certain element, returning true or false as appropriate.
-
Parameters
searchElement: T
The element to search for.
-
Optional fromIndex: number
The position in this array at which to begin searching for searchElement.
-
Returns boolean
Inherited from Array.includes
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2016.array.include.d.ts:25
indexOf
indexOf(searchElement, fromIndex?): number
Returns the index of the first occurrence of a value in an array, or -1 if it is not present.
-
Parameters
searchElement: T
The value to locate in the array.
-
Optional fromIndex: number
The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
-
Returns number
Inherited from Array.indexOf
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1417
join
join(separator?): string
Adds all the elements of an array into a string, separated by the specified separator string.
-
Parameters
Optional separator: string
A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.
-
Returns string
Inherited from Array.join
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1360
keys
keys(): IterableIterator<number>
Returns an iterable of keys in the array
-
Returns IterableIterator<number>
Inherited from Array.keys
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:68
lastIndexOf
lastIndexOf(searchElement, fromIndex?): number
Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.
-
Parameters
searchElement: T
The value to locate in the array.
-
Optional fromIndex: number
The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.
-
Returns number
Inherited from Array.lastIndexOf
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1423
map
map<U>(callbackfn, thisArg?): U[]
Calls a defined callback function on each element of an array, and returns an array that contains the results.
-
Type Parameters
U
Parameters
callbackfn: ((value, index, array) => U)
A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
-
(value, index, array): U
Parameters
value: T
index: number
array: T[]
Returns U
Optional thisArg: any
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
-
Returns U[]
Inherited from Array.map
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1462
pop
pop(): undefined | T
Removes the last element from an array and returns it.
+
Returns U[]
Inherited from Array.flatMap
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2019.array.d.ts:64
forEach
forEach(callbackfn, thisArg?): void
Performs the specified action for each element in an array.
+
Parameters
callbackfn: ((value, index, array) => void)A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
+
(value, index, array): void
Parameters
value: T
index: number
array: T[]
Returns void
Optional thisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
+
Returns void
Inherited from Array.forEach
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1456
full
full(): boolean
Returns boolean
Defined in src/circular-array.ts:97
includes
includes(searchElement, fromIndex?): boolean
Determines whether an array includes a certain element, returning true or false as appropriate.
+
Parameters
searchElement: TThe element to search for.
+
Optional fromIndex: numberThe position in this array at which to begin searching for searchElement.
+
Returns boolean
Inherited from Array.includes
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2016.array.include.d.ts:25
indexOf
indexOf(searchElement, fromIndex?): number
Returns the index of the first occurrence of a value in an array, or -1 if it is not present.
+
Parameters
searchElement: TThe value to locate in the array.
+
Optional fromIndex: numberThe array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
+
Returns number
Inherited from Array.indexOf
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1417
join
join(separator?): string
Adds all the elements of an array into a string, separated by the specified separator string.
+
Parameters
Optional separator: stringA string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.
+
Returns string
Inherited from Array.join
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1360
keys
keys(): IterableIterator<number>
Returns an iterable of keys in the array
+
Returns IterableIterator<number>
Inherited from Array.keys
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:68
lastIndexOf
lastIndexOf(searchElement, fromIndex?): number
Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.
+
Parameters
searchElement: TThe value to locate in the array.
+
Optional fromIndex: numberThe array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.
+
Returns number
Inherited from Array.lastIndexOf
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1423
map
map<U>(callbackfn, thisArg?): U[]
Calls a defined callback function on each element of an array, and returns an array that contains the results.
+
Type Parameters
U
Parameters
callbackfn: ((value, index, array) => U)A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
+
(value, index, array): U
Parameters
value: T
index: number
array: T[]
Returns U
Optional thisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
+
Returns U[]
Inherited from Array.map
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1462
pop
pop(): undefined | T
Removes the last element from an array and returns it.
 If the array is empty, undefined is returned and the array is not modified.
-
Returns undefined | T
Inherited from Array.pop
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1338
push
push(...items): number
Parameters
Rest ...items: T[]
Returns number
Inherit Doc
Overrides Array.push
Defined in src/circular-array.ts:24
reduce
reduce(callbackfn): T
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
-
Parameters
callbackfn: ((previousValue, currentValue, currentIndex, array) => T)
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
-
(previousValue, currentValue, currentIndex, array): T
Parameters
previousValue: T
currentValue: T
currentIndex: number
array: T[]
Returns T
Returns T
Inherited from Array.reduce
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1480
reduce(callbackfn, initialValue): T
Parameters
callbackfn: ((previousValue, currentValue, currentIndex, array) => T)
(previousValue, currentValue, currentIndex, array): T
Parameters
previousValue: T
currentValue: T
currentIndex: number
array: T[]
Returns T
initialValue: T
Returns T
Inherited from Array.reduce
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1481
reduce<U>(callbackfn, initialValue): U
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
-
Type Parameters
U
Parameters
callbackfn: ((previousValue, currentValue, currentIndex, array) => U)
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
-
(previousValue, currentValue, currentIndex, array): U
Parameters
previousValue: U
currentValue: T
currentIndex: number
array: T[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
-
Returns U
Inherited from Array.reduce
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1487
reduceRight
reduceRight(callbackfn): T
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
-
Parameters
callbackfn: ((previousValue, currentValue, currentIndex, array) => T)
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
-
(previousValue, currentValue, currentIndex, array): T
Parameters
previousValue: T
currentValue: T
currentIndex: number
array: T[]
Returns T
Returns T
Inherited from Array.reduceRight
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1493
reduceRight(callbackfn, initialValue): T
Parameters
callbackfn: ((previousValue, currentValue, currentIndex, array) => T)
(previousValue, currentValue, currentIndex, array): T
Parameters
previousValue: T
currentValue: T
currentIndex: number
array: T[]
Returns T
initialValue: T
Returns T
Inherited from Array.reduceRight
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1494
reduceRight<U>(callbackfn, initialValue): U
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
-
Type Parameters
U
Parameters
callbackfn: ((previousValue, currentValue, currentIndex, array) => U)
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
-
(previousValue, currentValue, currentIndex, array): U
Parameters
previousValue: U
currentValue: T
currentIndex: number
array: T[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
-
Returns U
Inherited from Array.reduceRight
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1500
resize
resize(size): void
Parameters
size: number
Returns void
Defined in src/circular-array.ts:81
reverse
reverse(): T[]
Reverses the elements in an array in place.
+
Returns undefined | T
Inherited from Array.pop
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1338
push
push(...items): number
Parameters
Rest ...items: T[]
Returns number
Inherit Doc
Overrides Array.push
Defined in src/circular-array.ts:24
reduce
reduce(callbackfn): T
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
+
Parameters
callbackfn: ((previousValue, currentValue, currentIndex, array) => T)A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
+
(previousValue, currentValue, currentIndex, array): T
Parameters
previousValue: T
currentValue: T
currentIndex: number
array: T[]
Returns T
Returns T
Inherited from Array.reduce
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1480
reduce(callbackfn, initialValue): T
Parameters
callbackfn: ((previousValue, currentValue, currentIndex, array) => T)(previousValue, currentValue, currentIndex, array): T
Parameters
previousValue: T
currentValue: T
currentIndex: number
array: T[]
Returns T
initialValue: T
Returns T
Inherited from Array.reduce
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1481
reduce<U>(callbackfn, initialValue): U
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
+
Type Parameters
U
Parameters
callbackfn: ((previousValue, currentValue, currentIndex, array) => U)A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
+
(previousValue, currentValue, currentIndex, array): U
Parameters
previousValue: U
currentValue: T
currentIndex: number
array: T[]
Returns U
initialValue: UIf initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
+
Returns U
Inherited from Array.reduce
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1487
reduceRight
reduceRight(callbackfn): T
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
+
Parameters
callbackfn: ((previousValue, currentValue, currentIndex, array) => T)A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
+
(previousValue, currentValue, currentIndex, array): T
Parameters
previousValue: T
currentValue: T
currentIndex: number
array: T[]
Returns T
Returns T
Inherited from Array.reduceRight
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1493
reduceRight(callbackfn, initialValue): T
Parameters
callbackfn: ((previousValue, currentValue, currentIndex, array) => T)(previousValue, currentValue, currentIndex, array): T
Parameters
previousValue: T
currentValue: T
currentIndex: number
array: T[]
Returns T
initialValue: T
Returns T
Inherited from Array.reduceRight
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1494
reduceRight<U>(callbackfn, initialValue): U
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
+
Type Parameters
U
Parameters
callbackfn: ((previousValue, currentValue, currentIndex, array) => U)A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
+
(previousValue, currentValue, currentIndex, array): U
Parameters
previousValue: U
currentValue: T
currentIndex: number
array: T[]
Returns U
initialValue: UIf initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
+
Returns U
Inherited from Array.reduceRight
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1500
resize
resize(size): void
Parameters
size: number
Returns void
Defined in src/circular-array.ts:81
reverse
reverse(): T[]
Reverses the elements in an array in place.
 This method mutates the array and returns a reference to the same array.
-
Returns T[]
Inherited from Array.reverse
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1365
shift
shift(): undefined | T
Removes the first element from an array and returns it.
+
Returns T[]
Inherited from Array.reverse
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1365
shift
shift(): undefined | T
Removes the first element from an array and returns it.
 If the array is empty, undefined is returned and the array is not modified.
-
Returns undefined | T
Inherited from Array.shift
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1370
slice
slice(start?, end?): T[]
Returns a copy of a section of an array.
+
Returns undefined | T
Inherited from Array.shift
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1370
slice
slice(start?, end?): T[]
Returns a copy of a section of an array.
 For both start and end, a negative index can be used to indicate an offset from the end of the array.
 For example, -2 refers to the second to last element of the array.
-
Parameters
Optional start: number
The beginning index of the specified portion of the array.
+
Parameters
Optional start: numberThe beginning index of the specified portion of the array.
 If start is undefined, then the slice begins at index 0.
-
Optional end: number
The end index of the specified portion of the array. This is exclusive of the element at the index 'end'.
+
Optional end: numberThe end index of the specified portion of the array. This is exclusive of the element at the index 'end'.
 If end is undefined, then the slice extends to the end of the array.
-
Returns T[]
Inherited from Array.slice
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1380
some
some(predicate, thisArg?): boolean
Determines whether the specified callback function returns true for any element of an array.
-
Parameters
predicate: ((value, index, array) => unknown)
A function that accepts up to three arguments. The some method calls
+
Returns T[]
Inherited from Array.slice
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1380
some
some(predicate, thisArg?): boolean
Determines whether the specified callback function returns true for any element of an array.
+
Parameters
predicate: ((value, index, array) => unknown)A function that accepts up to three arguments. The some method calls
 the predicate function for each element in the array until the predicate returns a value
 which is coercible to the Boolean value true, or until the end of the array.
-
(value, index, array): unknown
Parameters
value: T
index: number
array: T[]
Returns unknown
Optional thisArg: any
An object to which the this keyword can refer in the predicate function.
+
(value, index, array): unknown
Parameters
value: T
index: number
array: T[]
Returns unknown
Optional thisArg: anyAn object to which the this keyword can refer in the predicate function.
 If thisArg is omitted, undefined is used as the this value.
-
Returns boolean
Inherited from Array.some
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1450
sort
sort(compareFn?): this
Sorts an array in place.
+
Returns boolean
Inherited from Array.some
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1450
sort
sort(compareFn?): this
Sorts an array in place.
 This method mutates the array and returns a reference to the same array.
-
Parameters
Optional compareFn: ((a, b) => number)
Function used to determine the order of the elements. It is expected to return
+
Parameters
Optional compareFn: ((a, b) => number)Function used to determine the order of the elements. It is expected to return
 a negative value if the first argument is less than the second argument, zero if they're equal, and a positive
 value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.
 [11,2,22,1].sort((a, b) => a - b)
 
-
(a, b): number
Parameters
a: T
b: T
Returns number
Returns this
Inherited from Array.sort
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1391
splice
splice(start, deleteCount?, ...items): CircularArray<T>
Parameters
start: number
Optional deleteCount: number
Rest ...items: T[]
Returns CircularArray<T>
Inherit Doc
Overrides Array.splice
Defined in src/circular-array.ts:57
toLocaleString
toLocaleString(): string
Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.
-
Returns string
Inherited from Array.toLocaleString
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1333
toString
toString(): string
Returns a string representation of an array.
-
Returns string
Inherited from Array.toString
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1329
unshift
unshift(...items): number
Parameters
Rest ...items: T[]
Returns number
Inherit Doc
Overrides Array.unshift
Defined in src/circular-array.ts:33
values
values(): IterableIterator<T>
Returns an iterable of values in the array
-
Returns IterableIterator<T>
Inherited from Array.values
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:73
Static from
from<T>(arrayLike): T[]
Creates an array from an array-like object.
-
Type Parameters
T
Parameters
arrayLike: ArrayLike<T>
An array-like object to convert to an array.
-
Returns T[]
Inherited from Array.from
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.core.d.ts:70
from<T, U>(arrayLike, mapfn, thisArg?): U[]
Creates an array from an iterable object.
-
Type Parameters
T
U
Parameters
arrayLike: ArrayLike<T>
An array-like object to convert to an array.
-
mapfn: ((v, k) => U)
A mapping function to call on every element of the array.
-
(v, k): U
Parameters
v: T
k: number
Returns U
Optional thisArg: any
Value of 'this' used to invoke the mapfn.
-
Returns U[]
Inherited from Array.from
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.core.d.ts:78
from<T>(iterable): T[]
Creates an array from an iterable object.
-
Type Parameters
T
Parameters
iterable: Iterable<T> | ArrayLike<T>
An iterable object to convert to an array.
-
Returns T[]
Inherited from Array.from
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:81
from<T, U>(iterable, mapfn, thisArg?): U[]
Creates an array from an iterable object.
-
Type Parameters
T
U
Parameters
iterable: Iterable<T> | ArrayLike<T>
An iterable object to convert to an array.
-
mapfn: ((v, k) => U)
A mapping function to call on every element of the array.
-
(v, k): U
Parameters
v: T
k: number
Returns U
Optional thisArg: any
Value of 'this' used to invoke the mapfn.
-
Returns U[]
Inherited from Array.from
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:89
Static isArray
isArray(arg): arg is any[]
Parameters
arg: any
Returns arg is any[]
Inherited from Array.isArray
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1512
Static of
of<T>(...items): T[]
Returns a new array from a set of elements.
-
Type Parameters
T
Parameters
Rest ...items: T[]
A set of elements to include in the new array object.
-
Returns T[]
Inherited from Array.of
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.core.d.ts:84
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
constructor
[unscopables]
length
size
[species]
[iterator]
at
checkSize
concat
copyWithin
empty
entries
every
fill
filter
find
findIndex
flat
flatMap
forEach
full
includes
indexOf
join
keys
lastIndexOf
map
pop
push
reduce
reduceRight
resize
reverse
shift
slice
some
sort
splice
toLocaleString
toString
unshift
values
from
isArray
of
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+
(a, b): number
Parameters
a: T
b: T
Returns number
Returns this
Inherited from Array.sort
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1391
splice
splice(start, deleteCount?, ...items): CircularArray<T>
Parameters
start: number
Optional deleteCount: number
Rest ...items: T[]
Returns CircularArray<T>
Inherit Doc
Overrides Array.splice
Defined in src/circular-array.ts:57
toLocaleString
toLocaleString(): string
Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.
+
Returns string
Inherited from Array.toLocaleString
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1333
toString
toString(): string
Returns a string representation of an array.
+
Returns string
Inherited from Array.toString
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1329
unshift
unshift(...items): number
Parameters
Rest ...items: T[]
Returns number
Inherit Doc
Overrides Array.unshift
Defined in src/circular-array.ts:33
values
values(): IterableIterator<T>
Returns an iterable of values in the array
+
Returns IterableIterator<T>
Inherited from Array.values
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:73
Static from
from<T>(arrayLike): T[]
Creates an array from an array-like object.
+
Type Parameters
T
Parameters
arrayLike: ArrayLike<T>An array-like object to convert to an array.
+
Returns T[]
Inherited from Array.from
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.core.d.ts:70
from<T, U>(arrayLike, mapfn, thisArg?): U[]
Creates an array from an iterable object.
+
Type Parameters
T
U
Parameters
arrayLike: ArrayLike<T>An array-like object to convert to an array.
+
mapfn: ((v, k) => U)A mapping function to call on every element of the array.
+
(v, k): U
Parameters
v: T
k: number
Returns U
Optional thisArg: anyValue of 'this' used to invoke the mapfn.
+
Returns U[]
Inherited from Array.from
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.core.d.ts:78
from<T>(iterable): T[]
Creates an array from an iterable object.
+
Type Parameters
T
Parameters
iterable: Iterable<T> | ArrayLike<T>An iterable object to convert to an array.
+
Returns T[]
Inherited from Array.from
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:81
from<T, U>(iterable, mapfn, thisArg?): U[]
Creates an array from an iterable object.
+
Type Parameters
T
U
Parameters
iterable: Iterable<T> | ArrayLike<T>An iterable object to convert to an array.
+
mapfn: ((v, k) => U)A mapping function to call on every element of the array.
+
(v, k): U
Parameters
v: T
k: number
Returns U
Optional thisArg: anyValue of 'this' used to invoke the mapfn.
+
Returns U[]
Inherited from Array.from
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:89
Static isArray
isArray(arg): arg is any[]
Parameters
arg: any
Returns arg is any[]
Inherited from Array.isArray
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1512
Static of
of<T>(...items): T[]
Returns a new array from a set of elements.
+
Type Parameters
T
Parameters
Rest ...items: T[]A set of elements to include in the new array object.
+
Returns T[]
Inherited from Array.of
Defined in node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es2015.core.d.ts:84
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
constructor
[unscopables]
length
size
[species]
[iterator]
at
checkSize
concat
copyWithin
empty
entries
every
fill
filter
find
findIndex
flat
flatMap
forEach
full
includes
indexOf
join
keys
lastIndexOf
map
pop
push
reduce
reduceRight
resize
reverse
shift
slice
some
sort
splice
toLocaleString
toString
unshift
values
from
isArray
of
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html
index 52c4e2d4..60a63dc4 100644
--- a/docs/classes/ClusterWorker.html
+++ b/docs/classes/ClusterWorker.html
@@ -1,82 +1,82 @@
-ClusterWorker | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
ClusterWorker
Class ClusterWorker<Data, Response>
A cluster worker used by a poolifier ClusterPool.
+ClusterWorker | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
ClusterWorker
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.
 
Author
Christopher Quadflieg
 Since
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 full)
AbstractWorker<Worker, Data, Response>ClusterWorker
Defined in src/worker/cluster-worker.ts:21
 Index
Constructors
constructor
-
Properties
activeInterval?
-isMain
-lastTaskTimestamp
-opts
-statistics?
-taskFunctions
-
Accessors
id
-
Methods
addTaskFunction
-getMainWorker
-handleError
-handleKillMessage
-handleReadyMessage
-handleTaskFunctionOperationMessage
-hasTaskFunction
-listTaskFunctionNames
-messageListener
-removeTaskFunction
-run
-runAsync
-runSync
-sendTaskFunctionNamesToMainWorker
-sendToMainWorker
-setDefaultTaskFunction
-
Constructors
constructor
new ClusterWorker<Data, Response>(taskFunctions, opts?): ClusterWorker<Data, Response>
Constructs a new poolifier cluster worker.
-
Type Parameters
Data = unknown
Response = unknown
Parameters
taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>
Task function(s) processed by the worker when the pool's execution function is invoked.
-
opts: WorkerOptions = {}
Options for the worker.
-
Returns ClusterWorker<Data, Response>
Overrides AbstractWorker.constructor
Defined in src/worker/cluster-worker.ts:31
Properties
Protected Optional activeInterval
activeInterval?: Timeout
Handler id of the activeInterval worker activity check.
-
Inherited from AbstractWorker.activeInterval
Defined in src/worker/abstract-worker.ts:78
Protected Readonly isMain
isMain: undefined | boolean
Whether this is the main worker or not.
-
Inherited from AbstractWorker.isMain
Defined in src/worker/abstract-worker.ts:89
Protected lastTaskTimestamp
lastTaskTimestamp: number
Timestamp of the last task processed by this worker.
-
Inherited from AbstractWorker.lastTaskTimestamp
Defined in src/worker/abstract-worker.ts:70
Protected opts
opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
Options for the worker.
-
Inherited from AbstractWorker.opts
Defined in src/worker/abstract-worker.ts:92
Protected Optional statistics
statistics?: WorkerStatistics
Performance statistics computation requirements.
-
Inherited from AbstractWorker.statistics
Defined in src/worker/abstract-worker.ts:74
Protected taskFunctions
taskFunctions: Map<string, TaskFunction<Data, Response>>
Task function(s) processed by the worker when the pool's execution function is invoked.
-
Inherited from AbstractWorker.taskFunctions
Defined in src/worker/abstract-worker.ts:66
Accessors
Protected id
get id(): number
Worker id.
-
Returns number
Overrides AbstractWorker.id
Defined in src/worker/cluster-worker.ts:57
Methods
addTaskFunction
addTaskFunction(name, fn): TaskFunctionOperationResult
Adds a task function to the worker.
+
 Type Parameters
Data = unknownType of data this worker receives from pool's execution. This can only be structured-cloneable data.
+
Response = unknownType of response the worker sends back to the main worker. This can only be structured-cloneable data.
+
 Hierarchy (view full)
AbstractWorker<Worker, Data, Response>ClusterWorker
Defined in src/worker/cluster-worker.ts:21
 Index
Constructors
constructor
+
Properties
activeInterval?
+isMain
+lastTaskTimestamp
+opts
+statistics?
+taskFunctions
+
Accessors
id
+
Methods
addTaskFunction
+getMainWorker
+handleError
+handleKillMessage
+handleReadyMessage
+handleTaskFunctionOperationMessage
+hasTaskFunction
+listTaskFunctionNames
+messageListener
+removeTaskFunction
+run
+runAsync
+runSync
+sendTaskFunctionNamesToMainWorker
+sendToMainWorker
+setDefaultTaskFunction
+
Constructors
constructor
new ClusterWorker<Data, Response>(taskFunctions, opts?): ClusterWorker<Data, Response>
Constructs a new poolifier cluster worker.
+
Type Parameters
Data = unknown
Response = unknown
Parameters
taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>Task function(s) processed by the worker when the pool's execution function is invoked.
+
opts: WorkerOptions = {}Options for the worker.
+
Returns ClusterWorker<Data, Response>
Overrides AbstractWorker.constructor
Defined in src/worker/cluster-worker.ts:31
Properties
Protected Optional activeInterval
activeInterval?: Timeout
Handler id of the activeInterval worker activity check.
+
Inherited from AbstractWorker.activeInterval
Defined in src/worker/abstract-worker.ts:78
Protected Readonly isMain
isMain: undefined | boolean
Whether this is the main worker or not.
+
Inherited from AbstractWorker.isMain
Defined in src/worker/abstract-worker.ts:89
Protected lastTaskTimestamp
lastTaskTimestamp: number
Timestamp of the last task processed by this worker.
+
Inherited from AbstractWorker.lastTaskTimestamp
Defined in src/worker/abstract-worker.ts:70
Protected opts
opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
Options for the worker.
+
Inherited from AbstractWorker.opts
Defined in src/worker/abstract-worker.ts:92
Protected Optional statistics
statistics?: WorkerStatistics
Performance statistics computation requirements.
+
Inherited from AbstractWorker.statistics
Defined in src/worker/abstract-worker.ts:74
Protected taskFunctions
taskFunctions: Map<string, TaskFunction<Data, Response>>
Task function(s) processed by the worker when the pool's execution function is invoked.
+
Inherited from AbstractWorker.taskFunctions
Defined in src/worker/abstract-worker.ts:66
Accessors
Protected id
get id(): number
Worker id.
+
Returns number
Overrides AbstractWorker.id
Defined in src/worker/cluster-worker.ts:57
Methods
addTaskFunction
addTaskFunction(name, fn): TaskFunctionOperationResult
Adds a task function to the worker.
 If a task function with the same name already exists, it is replaced.
-
Parameters
name: string
The name of the task function to add.
-
fn: TaskFunction<Data, Response>
The task function to add.
+
Parameters
name: stringThe name of the task function to add.
+
fn: TaskFunction<Data, Response>The task function to add.
 
Returns TaskFunctionOperationResult
Whether the task function was added or not.
-
Inherited from AbstractWorker.addTaskFunction
Defined in src/worker/abstract-worker.ts:179
Protected getMainWorker
getMainWorker(): Worker
Returns the main worker.
+
Inherited from AbstractWorker.addTaskFunction
Defined in src/worker/abstract-worker.ts:179
Protected getMainWorker
getMainWorker(): Worker
Returns the main worker.
 
Returns Worker
Reference to the main worker.
 Throws
https://nodejs.org/api/errors.html#class-error If the main worker is not set.
-
Inherited from AbstractWorker.getMainWorker
Defined in src/worker/abstract-worker.ts:451
Protected handleError
handleError(error): string
Handles an error and convert it to a string so it can be sent back to the main worker.
-
Parameters
error: string | Error
The error raised by the worker.
+
Inherited from AbstractWorker.getMainWorker
Defined in src/worker/abstract-worker.ts:451
Protected handleError
handleError(error): string
Handles an error and convert it to a string so it can be sent back to the main worker.
+
Parameters
error: string | ErrorThe error raised by the worker.
 
Returns string
The error message.
-
Inherited from AbstractWorker.handleError
Defined in src/worker/abstract-worker.ts:482
Protected handleKillMessage
handleKillMessage(_message): void
Handles a kill message sent by the main worker.
-
Parameters
_message: MessageValue<Data, unknown>
Returns void
Inherited from AbstractWorker.handleKillMessage
Defined in src/worker/abstract-worker.ts:374
Protected handleReadyMessage
handleReadyMessage(message): void
Handles the ready message sent by the main worker.
-
Parameters
message: MessageValue<Data, unknown>
The ready message.
-
Returns void
Overrides AbstractWorker.handleReadyMessage
Defined in src/worker/cluster-worker.ts:39
Protected handleTaskFunctionOperationMessage
handleTaskFunctionOperationMessage(message): void
Parameters
message: MessageValue<Data, unknown>
Returns void
Inherited from AbstractWorker.handleTaskFunctionOperationMessage
Defined in src/worker/abstract-worker.ts:324
hasTaskFunction
hasTaskFunction(name): TaskFunctionOperationResult
Checks if the worker has a task function with the given name.
-
Parameters
name: string
The name of the task function to check.
+
Inherited from AbstractWorker.handleError
Defined in src/worker/abstract-worker.ts:482
Protected handleKillMessage
handleKillMessage(_message): void
Handles a kill message sent by the main worker.
+
Parameters
_message: MessageValue<Data, unknown>
Returns void
Inherited from AbstractWorker.handleKillMessage
Defined in src/worker/abstract-worker.ts:374
Protected handleReadyMessage
handleReadyMessage(message): void
Handles the ready message sent by the main worker.
+
Parameters
message: MessageValue<Data, unknown>The ready message.
+
Returns void
Overrides AbstractWorker.handleReadyMessage
Defined in src/worker/cluster-worker.ts:39
Protected handleTaskFunctionOperationMessage
handleTaskFunctionOperationMessage(message): void
Parameters
message: MessageValue<Data, unknown>
Returns void
Inherited from AbstractWorker.handleTaskFunctionOperationMessage
Defined in src/worker/abstract-worker.ts:324
hasTaskFunction
hasTaskFunction(name): TaskFunctionOperationResult
Checks if the worker has a task function with the given name.
+
Parameters
name: stringThe name of the task function to check.
 
Returns TaskFunctionOperationResult
Whether the worker has a task function with the given name or not.
-
Inherited from AbstractWorker.hasTaskFunction
Defined in src/worker/abstract-worker.ts:162
listTaskFunctionNames
listTaskFunctionNames(): string[]
Lists the names of the worker's task functions.
+
Inherited from AbstractWorker.hasTaskFunction
Defined in src/worker/abstract-worker.ts:162
listTaskFunctionNames
listTaskFunctionNames(): string[]
Lists the names of the worker's task functions.
 
Returns string[]
The names of the worker's task functions.
-
Inherited from AbstractWorker.listTaskFunctionNames
Defined in src/worker/abstract-worker.ts:243
Protected messageListener
messageListener(message): void
Worker message listener.
-
Parameters
message: MessageValue<Data, unknown>
The received message.
-
Returns void
Inherited from AbstractWorker.messageListener
Defined in src/worker/abstract-worker.ts:304
removeTaskFunction
removeTaskFunction(name): TaskFunctionOperationResult
Removes a task function from the worker.
-
Parameters
name: string
The name of the task function to remove.
+
Inherited from AbstractWorker.listTaskFunctionNames
Defined in src/worker/abstract-worker.ts:243
Protected messageListener
messageListener(message): void
Worker message listener.
+
Parameters
message: MessageValue<Data, unknown>The received message.
+
Returns void
Inherited from AbstractWorker.messageListener
Defined in src/worker/abstract-worker.ts:304
removeTaskFunction
removeTaskFunction(name): TaskFunctionOperationResult
Removes a task function from the worker.
+
Parameters
name: stringThe name of the task function to remove.
 
Returns TaskFunctionOperationResult
Whether the task function existed and was removed or not.
-
Inherited from AbstractWorker.removeTaskFunction
Defined in src/worker/abstract-worker.ts:214
Protected Readonly run
run(task): void
Runs the given task.
-
Parameters
task: Task<Data>
The task to execute.
-
Returns void
Inherited from AbstractWorker.run
Defined in src/worker/abstract-worker.ts:491
Protected Readonly runAsync
runAsync(fn, task): void
Runs the given task function asynchronously.
-
Parameters
fn: TaskAsyncFunction<Data, Response>
Task function that will be executed.
-
task: Task<Data>
Input data for the task function.
-
Returns void
Inherited from AbstractWorker.runAsync
Defined in src/worker/abstract-worker.ts:555
Protected Readonly runSync
runSync(fn, task): void
Runs the given task function synchronously.
-
Parameters
fn: TaskSyncFunction<Data, Response>
Task function that will be executed.
-
task: Task<Data>
Input data for the task function.
-
Returns void
Inherited from AbstractWorker.runSync
Defined in src/worker/abstract-worker.ts:520
Protected sendTaskFunctionNamesToMainWorker
sendTaskFunctionNamesToMainWorker(): void
Sends task function names to the main worker.
-
Returns void
Inherited from AbstractWorker.sendTaskFunctionNamesToMainWorker
Defined in src/worker/abstract-worker.ts:470
Protected Readonly sendToMainWorker
sendToMainWorker(message): void
Sends a message to main worker.
-
Parameters
message: MessageValue<Response, unknown>
The response message.
-
Returns void
Overrides AbstractWorker.sendToMainWorker
Defined in src/worker/cluster-worker.ts:62
setDefaultTaskFunction
setDefaultTaskFunction(name): TaskFunctionOperationResult
Sets the default task function to use in the worker.
-
Parameters
name: string
The name of the task function to use as default task function.
+
Inherited from AbstractWorker.removeTaskFunction
Defined in src/worker/abstract-worker.ts:214
Protected Readonly run
run(task): void
Runs the given task.
+
Parameters
task: Task<Data>The task to execute.
+
Returns void
Inherited from AbstractWorker.run
Defined in src/worker/abstract-worker.ts:491
Protected Readonly runAsync
runAsync(fn, task): void
Runs the given task function asynchronously.
+
Parameters
fn: TaskAsyncFunction<Data, Response>Task function that will be executed.
+
task: Task<Data>Input data for the task function.
+
Returns void
Inherited from AbstractWorker.runAsync
Defined in src/worker/abstract-worker.ts:555
Protected Readonly runSync
runSync(fn, task): void
Runs the given task function synchronously.
+
Parameters
fn: TaskSyncFunction<Data, Response>Task function that will be executed.
+
task: Task<Data>Input data for the task function.
+
Returns void
Inherited from AbstractWorker.runSync
Defined in src/worker/abstract-worker.ts:520
Protected sendTaskFunctionNamesToMainWorker
sendTaskFunctionNamesToMainWorker(): void
Sends task function names to the main worker.
+
Returns void
Inherited from AbstractWorker.sendTaskFunctionNamesToMainWorker
Defined in src/worker/abstract-worker.ts:470
Protected Readonly sendToMainWorker
sendToMainWorker(message): void
Sends a message to main worker.
+
Parameters
message: MessageValue<Response, unknown>The response message.
+
Returns void
Overrides AbstractWorker.sendToMainWorker
Defined in src/worker/cluster-worker.ts:62
setDefaultTaskFunction
setDefaultTaskFunction(name): TaskFunctionOperationResult
Sets the default task function to use in the worker.
+
Parameters
name: stringThe name of the task function to use as default task function.
 
Returns TaskFunctionOperationResult
Whether the default task function was set or not.
-
Inherited from AbstractWorker.setDefaultTaskFunction
Defined in src/worker/abstract-worker.ts:270
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
constructor
activeInterval
isMain
lastTaskTimestamp
opts
statistics
taskFunctions
id
addTaskFunction
getMainWorker
handleError
handleKillMessage
handleReadyMessage
handleTaskFunctionOperationMessage
hasTaskFunction
listTaskFunctionNames
messageListener
removeTaskFunction
run
runAsync
runSync
sendTaskFunctionNamesToMainWorker
sendToMainWorker
setDefaultTaskFunction
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+
Inherited from AbstractWorker.setDefaultTaskFunction
Defined in src/worker/abstract-worker.ts:270
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
constructor
activeInterval
isMain
lastTaskTimestamp
opts
statistics
taskFunctions
id
addTaskFunction
getMainWorker
handleError
handleKillMessage
handleReadyMessage
handleTaskFunctionOperationMessage
hasTaskFunction
listTaskFunctionNames
messageListener
removeTaskFunction
run
runAsync
runSync
sendTaskFunctionNamesToMainWorker
sendToMainWorker
setDefaultTaskFunction
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/classes/Deque.html b/docs/classes/Deque.html
index aa982fe2..3bbc7786 100644
--- a/docs/classes/Deque.html
+++ b/docs/classes/Deque.html
@@ -1,42 +1,42 @@
-Deque | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
Deque
Class Deque<T>Internal 
Deque.
+Deque | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
Deque
Class Deque<T>Internal 
Deque.
 Implemented with a doubly linked list.
-
 Type Parameters
T
Type of deque data.
-
 Defined in src/deque.ts:22
 Index
Constructors
constructor
-
Properties
head?
-maxSize
-size
-tail?
-
Methods
[iterator]
-backward
-clear
-incrementSize
-peekFirst
-peekLast
-pop
-push
-shift
-unshift
-
Constructors
constructor
new Deque<T>(): Deque<T>
Type Parameters
T
Returns Deque<T>
Defined in src/deque.ts:30
Properties
Private Optional head
head?: ILinkedListNode<T>
Defined in src/deque.ts:23
maxSize
maxSize: number
The maximum size of the deque.
-
Defined in src/deque.ts:28
size
size: number
The size of the deque.
-
Defined in src/deque.ts:26
Private Optional tail
tail?: ILinkedListNode<T>
Defined in src/deque.ts:24
Methods
[iterator]
[iterator](): Iterator<T, any, undefined>
Returns an iterator for the deque.
+
 Type Parameters
TType of deque data.
+
 Defined in src/deque.ts:22
 Index
Constructors
constructor
+
Properties
head?
+maxSize
+size
+tail?
+
Methods
[iterator]
+backward
+clear
+incrementSize
+peekFirst
+peekLast
+pop
+push
+shift
+unshift
+
Constructors
constructor
new Deque<T>(): Deque<T>
Type Parameters
T
Returns Deque<T>
Defined in src/deque.ts:30
Properties
Private Optional head
head?: ILinkedListNode<T>
Defined in src/deque.ts:23
maxSize
maxSize: number
The maximum size of the deque.
+
Defined in src/deque.ts:28
size
size: number
The size of the deque.
+
Defined in src/deque.ts:26
Private Optional tail
tail?: ILinkedListNode<T>
Defined in src/deque.ts:24
Methods
[iterator]
[iterator](): Iterator<T, any, undefined>
Returns an iterator for the deque.
 
Returns Iterator<T, any, undefined>
An iterator for the deque.
 See
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
-
Defined in src/deque.ts:140
backward
backward(): Iterable<T>
Returns an backward iterator for the deque.
+
Defined in src/deque.ts:140
backward
backward(): Iterable<T>
Returns an backward iterator for the deque.
 
Returns Iterable<T>
An backward iterator for the deque.
 See
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
-
Defined in src/deque.ts:166
clear
clear(): void
Clears the deque.
-
Returns void
Defined in src/deque.ts:127
Private incrementSize
incrementSize(): number
Returns number
Defined in src/deque.ts:190
peekFirst
peekFirst(): undefined | T
Peeks at the first data.
+
Defined in src/deque.ts:166
clear
clear(): void
Clears the deque.
+
Returns void
Defined in src/deque.ts:127
Private incrementSize
incrementSize(): number
Returns number
Defined in src/deque.ts:190
peekFirst
peekFirst(): undefined | T
Peeks at the first data.
 
Returns undefined | T
The first data or undefined if the deque is empty.
-
Defined in src/deque.ts:112
peekLast
peekLast(): undefined | T
Peeks at the last data.
+
Defined in src/deque.ts:112
peekLast
peekLast(): undefined | T
Peeks at the last data.
 
Returns undefined | T
The last data or undefined if the deque is empty.
-
Defined in src/deque.ts:120
pop
pop(): undefined | T
Pops data from the deque.
+
Defined in src/deque.ts:120
pop
pop(): undefined | T
Pops data from the deque.
 
Returns undefined | T
The popped data or undefined if the deque is empty.
-
Defined in src/deque.ts:73
push
push(data): number
Appends data to the deque.
-
Parameters
data: T
Data to append.
+
Defined in src/deque.ts:73
push
push(data): number
Appends data to the deque.
+
Parameters
data: TData to append.
 
Returns number
The new size of the deque.
-
Defined in src/deque.ts:40
shift
shift(): undefined | T
Shifts data from the deque.
+
Defined in src/deque.ts:40
shift
shift(): undefined | T
Shifts data from the deque.
 
Returns undefined | T
The shifted data or undefined if the deque is empty.
-
Defined in src/deque.ts:93
unshift
unshift(data): number
Prepends data to the deque.
-
Parameters
data: T
Data to prepend.
+
Defined in src/deque.ts:93
unshift
unshift(data): number
Prepends data to the deque.
+
Parameters
data: TData to prepend.
 
Returns number
The new size of the deque.
-
Defined in src/deque.ts:57
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
constructor
head
maxSize
size
tail
[iterator]
backward
clear
incrementSize
peekFirst
peekLast
pop
push
shift
unshift
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+
Defined in src/deque.ts:57
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
constructor
head
maxSize
size
tail
[iterator]
backward
clear
incrementSize
peekFirst
peekLast
pop
push
shift
unshift
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html
index 438e4c18..31822142 100644
--- a/docs/classes/DynamicClusterPool.html
+++ b/docs/classes/DynamicClusterPool.html
@@ -1,65 +1,65 @@
-DynamicClusterPool | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
DynamicClusterPool
Class DynamicClusterPool<Data, Response>
A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.
+DynamicClusterPool | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
DynamicClusterPool
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.
 
Author
Christopher Quadflieg
 Since
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 full)
FixedClusterPool<Data, Response>DynamicClusterPool
Defined in src/pools/cluster/dynamic.ts:16
 Index
Constructors
constructor
-
Properties
emitter?
-filePath
-maximumNumberOfWorkers?
-minimumNumberOfWorkers
-opts
-promiseResponseMap
-workerChoiceStrategyContext?
-workerNodes
-
Accessors
busy
-empty
-full
-info
-ready
-type
-utilization
-worker
-
Methods
addTaskFunction
-afterTaskExecutionHook
-afterWorkerNodeSetup
-beforeTaskExecutionHook
-checkAndEmitDynamicWorkerCreationEvents
-createAndSetupDynamicWorkerNode
-createAndSetupWorkerNode
-deregisterWorkerMessageListener
-destroy
-destroyWorkerNode
-enableTasksQueue
-execute
-flagWorkerNodeAsNotReady
-flushTasksQueue
-getWorkerInfo
-hasTaskFunction
-internalBusy
-isMain
-listTaskFunctionNames
-registerOnceWorkerMessageListener
-registerWorkerMessageListener
-removeTaskFunction
-sendStartupMessageToWorker
-sendToWorker
-setDefaultTaskFunction
-setTasksQueueOptions
-setWorkerChoiceStrategy
-setWorkerChoiceStrategyOptions
-setupHook
-shallCreateDynamicWorker
-start
-workerMessageListener
-
Constructors
constructor
new DynamicClusterPool<Data, Response>(min, max, filePath, opts?): DynamicClusterPool<Data, Response>
Constructs a new poolifier dynamic cluster pool.
-
Type Parameters
Data = unknown
Response = unknown
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>
Overrides FixedClusterPool.constructor
Defined in src/pools/cluster/dynamic.ts:28
Properties
Optional emitter
emitter?: EventEmitterAsyncResource
Event emitter integrated with async resource on which events can be listened to.
+
 Type Parameters
Data = unknownType of data sent to the worker. This can only be structured-cloneable data.
+
Response = unknownType of execution response. This can only be structured-cloneable data.
+
 Hierarchy (view full)
FixedClusterPool<Data, Response>DynamicClusterPool
Defined in src/pools/cluster/dynamic.ts:16
 Index
Constructors
constructor
+
Properties
emitter?
+filePath
+maximumNumberOfWorkers?
+minimumNumberOfWorkers
+opts
+promiseResponseMap
+workerChoiceStrategyContext?
+workerNodes
+
Accessors
busy
+empty
+full
+info
+ready
+type
+utilization
+worker
+
Methods
addTaskFunction
+afterTaskExecutionHook
+afterWorkerNodeSetup
+beforeTaskExecutionHook
+checkAndEmitDynamicWorkerCreationEvents
+createAndSetupDynamicWorkerNode
+createAndSetupWorkerNode
+deregisterWorkerMessageListener
+destroy
+destroyWorkerNode
+enableTasksQueue
+execute
+flagWorkerNodeAsNotReady
+flushTasksQueue
+getWorkerInfo
+hasTaskFunction
+internalBusy
+isMain
+listTaskFunctionNames
+registerOnceWorkerMessageListener
+registerWorkerMessageListener
+removeTaskFunction
+sendStartupMessageToWorker
+sendToWorker
+setDefaultTaskFunction
+setTasksQueueOptions
+setWorkerChoiceStrategy
+setWorkerChoiceStrategyOptions
+setupHook
+shallCreateDynamicWorker
+start
+workerMessageListener
+
Constructors
constructor
new DynamicClusterPool<Data, Response>(min, max, filePath, opts?): DynamicClusterPool<Data, Response>
Constructs a new poolifier dynamic cluster pool.
+
Type Parameters
Data = unknown
Response = unknown
Parameters
min: numberMinimum number of workers which are always active.
+
max: numberMaximum number of workers that can be created by this pool.
+
filePath: stringPath 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>
Overrides FixedClusterPool.constructor
Defined in src/pools/cluster/dynamic.ts:28
Properties
Optional emitter
emitter?: EventEmitterAsyncResource
Event emitter integrated with async resource on which events can be listened to.
 The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.
 Events that can currently be listened to:
 
@@ -72,106 +72,71 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
 'taskError': Emitted when an error occurs while executing a task.
 'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
 

-
Inherited from FixedClusterPool.emitter
Defined in src/pools/abstract-pool.ts:79
Protected Readonly filePath
filePath: string
Path to the worker file.
-
Inherited from FixedClusterPool.filePath
Defined in src/pools/abstract-pool.ts:138
Protected Optional Readonly maximumNumberOfWorkers
maximumNumberOfWorkers?: number
Maximum number of workers that this pool manages.
-
Inherited from FixedClusterPool.maximumNumberOfWorkers
Defined in src/pools/abstract-pool.ts:140
Protected Readonly minimumNumberOfWorkers
minimumNumberOfWorkers: number
Minimum number of workers that this pool manages.
-
Inherited from FixedClusterPool.minimumNumberOfWorkers
Defined in src/pools/abstract-pool.ts:137
Protected Readonly opts
opts: PoolOptions<Worker>
Options for the pool.
-
Inherited from FixedClusterPool.opts
Defined in src/pools/abstract-pool.ts:139
Protected promiseResponseMap
promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
The task execution response promise map:
+
Inherited from FixedClusterPool.emitter
Defined in src/pools/abstract-pool.ts:79
Protected Readonly filePath
filePath: string
Path to the worker file.
+
Inherited from FixedClusterPool.filePath
Defined in src/pools/abstract-pool.ts:138
Protected Optional Readonly maximumNumberOfWorkers
maximumNumberOfWorkers?: number
Maximum number of workers that this pool manages.
+
Inherited from FixedClusterPool.maximumNumberOfWorkers
Defined in src/pools/abstract-pool.ts:140
Protected Readonly minimumNumberOfWorkers
minimumNumberOfWorkers: number
Minimum number of workers that this pool manages.
+
Inherited from FixedClusterPool.minimumNumberOfWorkers
Defined in src/pools/abstract-pool.ts:137
Protected Readonly opts
opts: PoolOptions<Worker>
Options for the pool.
+
Inherited from FixedClusterPool.opts
Defined in src/pools/abstract-pool.ts:139
Protected promiseResponseMap
promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
The task execution response promise map:
 
 key: The message id of each submitted task.
 value: An object that contains the worker, the execution response promise resolve and reject callbacks.
 
 When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
-
Inherited from FixedClusterPool.promiseResponseMap
Defined in src/pools/abstract-pool.ts:88
Protected Optional workerChoiceStrategyContext
workerChoiceStrategyContext?: WorkerChoiceStrategyContext<Worker, Data, Response>
Worker choice strategy context referencing a worker choice algorithm implementation.
-
Inherited from FixedClusterPool.workerChoiceStrategyContext
Defined in src/pools/abstract-pool.ts:94
Readonly Internal workerNodes
workerNodes: IWorkerNode<Worker, Data>[] = []
Pool worker nodes.
-
Inherited from FixedClusterPool.workerNodes
Defined in src/pools/abstract-pool.ts:76
Accessors
Protected busy
get busy(): boolean
Whether the pool is busy or not.
+
Inherited from FixedClusterPool.promiseResponseMap
Defined in src/pools/abstract-pool.ts:88
Protected Optional workerChoiceStrategyContext
workerChoiceStrategyContext?: WorkerChoiceStrategyContext<Worker, Data, Response>
Worker choice strategy context referencing a worker choice algorithm implementation.
+
Inherited from FixedClusterPool.workerChoiceStrategyContext
Defined in src/pools/abstract-pool.ts:94
Readonly Internal workerNodes
workerNodes: IWorkerNode<Worker, Data>[] = []
Pool worker nodes.
+
Inherited from FixedClusterPool.workerNodes
Defined in src/pools/abstract-pool.ts:76
Accessors
Protected busy
get busy(): boolean
Whether the pool is busy or not.
 The pool busyness boolean status.
-
Returns boolean
Overrides FixedClusterPool.busy
Defined in src/pools/cluster/dynamic.ts:59
Protected empty
get empty(): boolean
The pool emptiness boolean status.
-
Returns boolean
Inherited from FixedClusterPool.empty
Defined in src/pools/abstract-pool.ts:464
Protected full
get full(): boolean
Whether the pool is full or not.
+
Returns boolean
Overrides FixedClusterPool.busy
Defined in src/pools/cluster/dynamic.ts:59
Protected empty
get empty(): boolean
The pool emptiness boolean status.
+
Returns boolean
Inherited from FixedClusterPool.empty
Defined in src/pools/abstract-pool.ts:464
Protected full
get full(): boolean
Whether the pool is full or not.
 The pool filling boolean status.
-
Returns boolean
Inherited from FixedClusterPool.full
Defined in src/pools/abstract-pool.ts:658
info
get info(): PoolInfo
Pool information.
-
Returns PoolInfo
Inherited from FixedClusterPool.info
Defined in src/pools/abstract-pool.ts:277
Private ready
get ready(): boolean
The pool readiness boolean status.
-
Returns boolean
Inherited from FixedClusterPool.ready
Defined in src/pools/abstract-pool.ts:446
Protected type
get type(): "fixed" | "dynamic"
The pool type.
+
Returns boolean
Inherited from FixedClusterPool.full
Defined in src/pools/abstract-pool.ts:658
info
get info(): PoolInfo
Pool information.
+
Returns PoolInfo
Inherited from FixedClusterPool.info
Defined in src/pools/abstract-pool.ts:277
Private ready
get ready(): boolean
The pool readiness boolean status.
+
Returns boolean
Inherited from FixedClusterPool.ready
Defined in src/pools/abstract-pool.ts:446
Protected type
get type(): "fixed" | "dynamic"
The pool type.
 If it is 'dynamic', it provides the max property.
-
Returns "fixed" | "dynamic"
Overrides FixedClusterPool.type
Defined in src/pools/cluster/dynamic.ts:54
Private utilization
get utilization(): number
The approximate pool utilization.
+
Returns "fixed" | "dynamic"
Overrides FixedClusterPool.type
Defined in src/pools/cluster/dynamic.ts:54
Private utilization
get utilization(): number
The approximate pool utilization.
 
Returns number
The pool utilization.
-
Inherited from FixedClusterPool.utilization
Defined in src/pools/abstract-pool.ts:473
Protected worker
get worker(): "thread" | "cluster"
The worker type.
-
Returns "thread" | "cluster"
Inherited from FixedClusterPool.worker
Defined in src/pools/cluster/fixed.ts:108
Methods
addTaskFunction
addTaskFunction(name, fn): Promise<boolean>
Adds a task function to this pool.
-If a task function with the same name already exists, it will be overwritten.
-
Parameters
name: string
The name of the task function.
-
fn: TaskFunction<Data, Response>
The task function.
-
Returns Promise<boolean>
true if the task function was added, false otherwise.
-Throws
https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.
-Throws
https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.
-
Inherited from FixedClusterPool.addTaskFunction
Defined in src/pools/abstract-pool.ts:812
Protected afterTaskExecutionHook
afterTaskExecutionHook(workerNodeKey, message): void
Hook executed after the worker task execution.
+
Inherited from FixedClusterPool.utilization
Defined in src/pools/abstract-pool.ts:473
Protected worker
get worker(): "thread" | "cluster"
The worker type.
+
Returns "thread" | "cluster"
Inherited from FixedClusterPool.worker
Defined in src/pools/cluster/fixed.ts:108
Methods
addTaskFunction
addTaskFunction(name, fn): Promise<boolean>
Parameters
name: string
fn: TaskFunction<Data, Response>
Returns Promise<boolean>
Inherit Doc
Inherited from FixedClusterPool.addTaskFunction
Defined in src/pools/abstract-pool.ts:812
Protected afterTaskExecutionHook
afterTaskExecutionHook(workerNodeKey, message): void
Hook executed after the worker task execution.
 Can be overridden.
-
Parameters
workerNodeKey: number
The worker node key.
-
message: MessageValue<Response, unknown>
The received message.
-
Returns void
Inherited from FixedClusterPool.afterTaskExecutionHook
Defined in src/pools/abstract-pool.ts:1111
Protected afterWorkerNodeSetup
afterWorkerNodeSetup(workerNodeKey): void
Method hooked up after a worker node has been newly created.
+
Parameters
workerNodeKey: numberThe worker node key.
+
message: MessageValue<Response, unknown>The received message.
+
Returns void
Inherited from FixedClusterPool.afterTaskExecutionHook
Defined in src/pools/abstract-pool.ts:1111
Protected afterWorkerNodeSetup
afterWorkerNodeSetup(workerNodeKey): 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
Inherited from FixedClusterPool.afterWorkerNodeSetup
Defined in src/pools/abstract-pool.ts:1378
Protected beforeTaskExecutionHook
beforeTaskExecutionHook(workerNodeKey, task): void
Hook executed before the worker task execution.
+
Parameters
workerNodeKey: numberThe newly created worker node key.
+
Returns void
Inherited from FixedClusterPool.afterWorkerNodeSetup
Defined in src/pools/abstract-pool.ts:1378
Protected beforeTaskExecutionHook
beforeTaskExecutionHook(workerNodeKey, task): 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
Inherited from FixedClusterPool.beforeTaskExecutionHook
Defined in src/pools/abstract-pool.ts:1070
Protected checkAndEmitDynamicWorkerCreationEvents
checkAndEmitDynamicWorkerCreationEvents(): void
Emits dynamic worker creation events.
-
Returns void
Overrides FixedClusterPool.checkAndEmitDynamicWorkerCreationEvents
Defined in src/pools/cluster/dynamic.ts:47
Protected createAndSetupDynamicWorkerNode
createAndSetupDynamicWorkerNode(): number
Creates a new, completely set up dynamic worker node.
+
Parameters
workerNodeKey: numberThe worker node key.
+
task: Task<Data>The task to execute.
+
Returns void
Inherited from FixedClusterPool.beforeTaskExecutionHook
Defined in src/pools/abstract-pool.ts:1070
Protected checkAndEmitDynamicWorkerCreationEvents
checkAndEmitDynamicWorkerCreationEvents(): void
Emits dynamic worker creation events.
+
Returns void
Overrides FixedClusterPool.checkAndEmitDynamicWorkerCreationEvents
Defined in src/pools/cluster/dynamic.ts:47
Protected createAndSetupDynamicWorkerNode
createAndSetupDynamicWorkerNode(): number
Creates a new, completely set up dynamic worker node.
 
Returns number
New, completely set up dynamic worker node key.
-
Inherited from FixedClusterPool.createAndSetupDynamicWorkerNode
Defined in src/pools/abstract-pool.ts:1280
Protected createAndSetupWorkerNode
createAndSetupWorkerNode(): number
Creates a new, completely set up worker node.
+
Inherited from FixedClusterPool.createAndSetupDynamicWorkerNode
Defined in src/pools/abstract-pool.ts:1280
Protected createAndSetupWorkerNode
createAndSetupWorkerNode(): number
Creates a new, completely set up worker node.
 
Returns number
New, completely set up worker node key.
-
Inherited from FixedClusterPool.createAndSetupWorkerNode
Defined in src/pools/abstract-pool.ts:1223
Protected deregisterWorkerMessageListener
deregisterWorkerMessageListener<Message>(workerNodeKey, listener): 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) => void)
The message listener callback.
-
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Inherited from FixedClusterPool.deregisterWorkerMessageListener
Defined in src/pools/cluster/fixed.ts:85
destroy
destroy(): Promise<void>
Terminates all workers in this pool.
-
Returns Promise<void>
Inherited from FixedClusterPool.destroy
Defined in src/pools/abstract-pool.ts:977
Protected destroyWorkerNode
destroyWorkerNode(workerNodeKey): Promise<void>
Terminates the worker node given its worker node key.
-
Parameters
workerNodeKey: number
The worker node key.
-
Returns Promise<void>
Inherited from FixedClusterPool.destroyWorkerNode
Defined in src/pools/abstract-pool.ts:1031
enableTasksQueue
enableTasksQueue(enable, tasksQueueOptions?): void
Enables/disables the worker node tasks queue in this pool.
-
Parameters
enable: boolean
Whether to enable or disable the worker node tasks queue.
-
Optional tasksQueueOptions: TasksQueueOptions
The worker node tasks queue options.
-
Returns void
Inherited from FixedClusterPool.enableTasksQueue
Defined in src/pools/abstract-pool.ts:563
execute
execute(data?, name?, transferList?): Promise<Response>
Executes the specified function in the worker constructor with the task data input parameter.
-
Parameters
Optional data: Data
The optional task input data for the specified task function. This can only be structured-cloneable data.
-
Optional name: string
The optional name of the task function to execute. If not specified, the default task function will be executed.
-
Optional transferList: TransferListItem[]
An 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 that will be fulfilled when the task is completed.
-
Inherited from FixedClusterPool.execute
Defined in src/pools/abstract-pool.ts:887
Protected flagWorkerNodeAsNotReady
flagWorkerNodeAsNotReady(workerNodeKey): void
Parameters
workerNodeKey: number
Returns void
Inherited from FixedClusterPool.flagWorkerNodeAsNotReady
Defined in src/pools/abstract-pool.ts:1890
Protected flushTasksQueue
flushTasksQueue(workerNodeKey): number
Parameters
workerNodeKey: number
Returns number
Inherited from FixedClusterPool.flushTasksQueue
Defined in src/pools/abstract-pool.ts:1932
Protected getWorkerInfo
getWorkerInfo(workerNodeKey): undefined | WorkerInfo
Gets the worker information given its worker node key.
-
Parameters
workerNodeKey: number
The worker node key.
+
Inherited from FixedClusterPool.createAndSetupWorkerNode
Defined in src/pools/abstract-pool.ts:1223
Protected deregisterWorkerMessageListener
deregisterWorkerMessageListener<Message>(workerNodeKey, listener): void
Deregisters a listener callback on the worker given its worker node key.
+
Type Parameters
Message
Parameters
workerNodeKey: numberThe worker node key.
+
listener: ((message) => void)The message listener callback.
+
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Inherited from FixedClusterPool.deregisterWorkerMessageListener
Defined in src/pools/cluster/fixed.ts:85
destroy
destroy(): Promise<void>
Returns Promise<void>
Inherit Doc
Inherited from FixedClusterPool.destroy
Defined in src/pools/abstract-pool.ts:977
Protected destroyWorkerNode
destroyWorkerNode(workerNodeKey): Promise<void>
Terminates the worker node given its worker node key.
+
Parameters
workerNodeKey: numberThe worker node key.
+
Returns Promise<void>
Inherited from FixedClusterPool.destroyWorkerNode
Defined in src/pools/abstract-pool.ts:1031
enableTasksQueue
enableTasksQueue(enable, tasksQueueOptions?): void
Parameters
enable: boolean
Optional tasksQueueOptions: TasksQueueOptions
Returns void
Inherit Doc
Inherited from FixedClusterPool.enableTasksQueue
Defined in src/pools/abstract-pool.ts:563
execute
execute(data?, name?, transferList?): Promise<Response>
Parameters
Optional data: Data
Optional name: string
Optional transferList: TransferListItem[]
Returns Promise<Response>
Inherit Doc
Inherited from FixedClusterPool.execute
Defined in src/pools/abstract-pool.ts:887
Protected flagWorkerNodeAsNotReady
flagWorkerNodeAsNotReady(workerNodeKey): void
Parameters
workerNodeKey: number
Returns void
Inherited from FixedClusterPool.flagWorkerNodeAsNotReady
Defined in src/pools/abstract-pool.ts:1890
Protected flushTasksQueue
flushTasksQueue(workerNodeKey): number
Parameters
workerNodeKey: number
Returns number
Inherited from FixedClusterPool.flushTasksQueue
Defined in src/pools/abstract-pool.ts:1932
Protected getWorkerInfo
getWorkerInfo(workerNodeKey): undefined | WorkerInfo
Gets the worker information given its worker node key.
+
Parameters
workerNodeKey: numberThe worker node key.
 
Returns undefined | WorkerInfo
The worker information.
-
Inherited from FixedClusterPool.getWorkerInfo
Defined in src/pools/abstract-pool.ts:1823
hasTaskFunction
hasTaskFunction(name): boolean
Whether the specified task function exists in this pool.
-
Parameters
name: string
The name of the task function.
-
Returns boolean
true if the task function exists, false otherwise.
-
Inherited from FixedClusterPool.hasTaskFunction
Defined in src/pools/abstract-pool.ts:799
Protected internalBusy
internalBusy(): boolean
Whether worker nodes are executing concurrently their tasks quota or not.
+
Inherited from FixedClusterPool.getWorkerInfo
Defined in src/pools/abstract-pool.ts:1823
hasTaskFunction
hasTaskFunction(name): boolean
Parameters
name: string
Returns boolean
Inherit Doc
Inherited from FixedClusterPool.hasTaskFunction
Defined in src/pools/abstract-pool.ts:799
Protected internalBusy
internalBusy(): boolean
Whether worker nodes are executing concurrently their tasks quota or not.
 
Returns boolean
Worker nodes busyness boolean status.
-
Inherited from FixedClusterPool.internalBusy
Defined in src/pools/abstract-pool.ts:677
Protected isMain
isMain(): boolean
Should return whether the worker is the main worker or not.
-
Returns boolean
Inherited from FixedClusterPool.isMain
Defined in src/pools/cluster/fixed.ts:46
listTaskFunctionNames
listTaskFunctionNames(): string[]
Lists the names of task function available in this pool.
-
Returns string[]
The names of task function available in this pool.
-
Inherited from FixedClusterPool.listTaskFunctionNames
Defined in src/pools/abstract-pool.ts:851
Protected registerOnceWorkerMessageListener
registerOnceWorkerMessageListener<Message>(workerNodeKey, listener): void
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) => void)
The message listener callback.
-
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Inherited from FixedClusterPool.registerOnceWorkerMessageListener
Defined in src/pools/cluster/fixed.ts:77
Protected registerWorkerMessageListener
registerWorkerMessageListener<Message>(workerNodeKey, listener): 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) => void)
The message listener callback.
-
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Inherited from FixedClusterPool.registerWorkerMessageListener
Defined in src/pools/cluster/fixed.ts:69
removeTaskFunction
removeTaskFunction(name): Promise<boolean>
Removes a task function from this pool.
-
Parameters
name: string
The name of the task function.
-
Returns Promise<boolean>
true if the task function was removed, false otherwise.
-
Inherited from FixedClusterPool.removeTaskFunction
Defined in src/pools/abstract-pool.ts:835
Protected sendStartupMessageToWorker
sendStartupMessageToWorker(workerNodeKey): void
Sends the startup message to worker given its worker node key.
-
Parameters
workerNodeKey: number
The worker node key.
-
Returns void
Inherited from FixedClusterPool.sendStartupMessageToWorker
Defined in src/pools/cluster/fixed.ts:62
Protected sendToWorker
sendToWorker(workerNodeKey, message): void
Sends a message to worker given its worker node key.
-
Parameters
workerNodeKey: number
The worker node key.
-
message: MessageValue<Data, unknown>
The message.
-
Returns void
Inherited from FixedClusterPool.sendToWorker
Defined in src/pools/cluster/fixed.ts:51
setDefaultTaskFunction
setDefaultTaskFunction(name): Promise<boolean>
Sets the default task function in this pool.
-
Parameters
name: string
The name of the task function.
-
Returns Promise<boolean>
true if the default task function was set, false otherwise.
-
Inherited from FixedClusterPool.setDefaultTaskFunction
Defined in src/pools/abstract-pool.ts:864
setTasksQueueOptions
setTasksQueueOptions(tasksQueueOptions): void
Sets the worker node tasks queue options in this pool.
-
Parameters
tasksQueueOptions: undefined | TasksQueueOptions
The worker node tasks queue options.
-
Returns void
Inherited from FixedClusterPool.setTasksQueueOptions
Defined in src/pools/abstract-pool.ts:577
setWorkerChoiceStrategy
setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void
Sets the worker choice strategy in this pool.
-
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
The worker choice strategy.
-
Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
The worker choice strategy options.
-
Returns void
Inherited from FixedClusterPool.setWorkerChoiceStrategy
Defined in src/pools/abstract-pool.ts:531
setWorkerChoiceStrategyOptions
setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void
Sets the worker choice strategy options in this pool.
-
Parameters
workerChoiceStrategyOptions: undefined | WorkerChoiceStrategyOptions
The worker choice strategy options.
-
Returns void
Inherited from FixedClusterPool.setWorkerChoiceStrategyOptions
Defined in src/pools/abstract-pool.ts:550
Protected setupHook
setupHook(): void
Setup hook to execute code before worker nodes are created in the abstract constructor.
+
Inherited from FixedClusterPool.internalBusy
Defined in src/pools/abstract-pool.ts:677
Protected isMain
isMain(): boolean
Should return whether the worker is the main worker or not.
+
Returns boolean
Inherited from FixedClusterPool.isMain
Defined in src/pools/cluster/fixed.ts:46
listTaskFunctionNames
listTaskFunctionNames(): string[]
Returns string[]
Inherit Doc
Inherited from FixedClusterPool.listTaskFunctionNames
Defined in src/pools/abstract-pool.ts:851
Protected registerOnceWorkerMessageListener
registerOnceWorkerMessageListener<Message>(workerNodeKey, listener): void
Registers once a listener callback on the worker given its worker node key.
+
Type Parameters
Message
Parameters
workerNodeKey: numberThe worker node key.
+
listener: ((message) => void)The message listener callback.
+
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Inherited from FixedClusterPool.registerOnceWorkerMessageListener
Defined in src/pools/cluster/fixed.ts:77
Protected registerWorkerMessageListener
registerWorkerMessageListener<Message>(workerNodeKey, listener): void
Registers a listener callback on the worker given its worker node key.
+
Type Parameters
Message
Parameters
workerNodeKey: numberThe worker node key.
+
listener: ((message) => void)The message listener callback.
+
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Inherited from FixedClusterPool.registerWorkerMessageListener
Defined in src/pools/cluster/fixed.ts:69
removeTaskFunction
removeTaskFunction(name): Promise<boolean>
Parameters
name: string
Returns Promise<boolean>
Inherit Doc
Inherited from FixedClusterPool.removeTaskFunction
Defined in src/pools/abstract-pool.ts:835
Protected sendStartupMessageToWorker
sendStartupMessageToWorker(workerNodeKey): void
Sends the startup message to worker given its worker node key.
+
Parameters
workerNodeKey: numberThe worker node key.
+
Returns void
Inherited from FixedClusterPool.sendStartupMessageToWorker
Defined in src/pools/cluster/fixed.ts:62
Protected sendToWorker
sendToWorker(workerNodeKey, message): void
Sends a message to worker given its worker node key.
+
Parameters
workerNodeKey: numberThe worker node key.
+
message: MessageValue<Data, unknown>The message.
+
Returns void
Inherited from FixedClusterPool.sendToWorker
Defined in src/pools/cluster/fixed.ts:51
setDefaultTaskFunction
setDefaultTaskFunction(name): Promise<boolean>
Parameters
name: string
Returns Promise<boolean>
Inherit Doc
Inherited from FixedClusterPool.setDefaultTaskFunction
Defined in src/pools/abstract-pool.ts:864
setTasksQueueOptions
setTasksQueueOptions(tasksQueueOptions): void
Parameters
tasksQueueOptions: undefined | TasksQueueOptions
Returns void
Inherit Doc
Inherited from FixedClusterPool.setTasksQueueOptions
Defined in src/pools/abstract-pool.ts:577
setWorkerChoiceStrategy
setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
Returns void
Inherit Doc
Inherited from FixedClusterPool.setWorkerChoiceStrategy
Defined in src/pools/abstract-pool.ts:531
setWorkerChoiceStrategyOptions
setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void
Parameters
workerChoiceStrategyOptions: undefined | WorkerChoiceStrategyOptions
Returns void
Inherit Doc
Inherited from FixedClusterPool.setWorkerChoiceStrategyOptions
Defined in src/pools/abstract-pool.ts:550
Protected setupHook
setupHook(): void
Setup hook to execute code before worker nodes are created in the abstract constructor.
 Can be overridden.
-
Returns void
Inherited from FixedClusterPool.setupHook
Defined in src/pools/cluster/fixed.ts:41
Protected shallCreateDynamicWorker
shallCreateDynamicWorker(): boolean
Conditions for dynamic worker creation.
+
Returns void
Inherited from FixedClusterPool.setupHook
Defined in src/pools/cluster/fixed.ts:41
Protected shallCreateDynamicWorker
shallCreateDynamicWorker(): boolean
Conditions for dynamic worker creation.
 
Returns boolean
Whether to create a dynamic worker or not.
-
Overrides FixedClusterPool.shallCreateDynamicWorker
Defined in src/pools/cluster/dynamic.ts:42
start
start(): void
Starts the minimum number of workers in this pool.
-
Returns void
Inherited from FixedClusterPool.start
Defined in src/pools/abstract-pool.ts:952
Protected Readonly workerMessageListener
workerMessageListener(message): void
This method is the message listener registered on each worker.
-
Parameters
message: MessageValue<Response, unknown>
Returns void
Inherited from FixedClusterPool.workerMessageListener
Defined in src/pools/abstract-pool.ts:1702
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
constructor
emitter
filePath
maximumNumberOfWorkers
minimumNumberOfWorkers
opts
promiseResponseMap
workerChoiceStrategyContext
workerNodes
busy
empty
full
info
ready
type
utilization
worker
addTaskFunction
afterTaskExecutionHook
afterWorkerNodeSetup
beforeTaskExecutionHook
checkAndEmitDynamicWorkerCreationEvents
createAndSetupDynamicWorkerNode
createAndSetupWorkerNode
deregisterWorkerMessageListener
destroy
destroyWorkerNode
enableTasksQueue
execute
flagWorkerNodeAsNotReady
flushTasksQueue
getWorkerInfo
hasTaskFunction
internalBusy
isMain
listTaskFunctionNames
registerOnceWorkerMessageListener
registerWorkerMessageListener
removeTaskFunction
sendStartupMessageToWorker
sendToWorker
setDefaultTaskFunction
setTasksQueueOptions
setWorkerChoiceStrategy
setWorkerChoiceStrategyOptions
setupHook
shallCreateDynamicWorker
start
workerMessageListener
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+
Overrides FixedClusterPool.shallCreateDynamicWorker
Defined in src/pools/cluster/dynamic.ts:42
start
start(): void
Returns void
Inherit Doc
Inherited from FixedClusterPool.start
Defined in src/pools/abstract-pool.ts:952
Protected Readonly workerMessageListener
workerMessageListener(message): void
This method is the message listener registered on each worker.
+
Parameters
message: MessageValue<Response, unknown>
Returns void
Inherited from FixedClusterPool.workerMessageListener
Defined in src/pools/abstract-pool.ts:1702
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
constructor
emitter
filePath
maximumNumberOfWorkers
minimumNumberOfWorkers
opts
promiseResponseMap
workerChoiceStrategyContext
workerNodes
busy
empty
full
info
ready
type
utilization
worker
addTaskFunction
afterTaskExecutionHook
afterWorkerNodeSetup
beforeTaskExecutionHook
checkAndEmitDynamicWorkerCreationEvents
createAndSetupDynamicWorkerNode
createAndSetupWorkerNode
deregisterWorkerMessageListener
destroy
destroyWorkerNode
enableTasksQueue
execute
flagWorkerNodeAsNotReady
flushTasksQueue
getWorkerInfo
hasTaskFunction
internalBusy
isMain
listTaskFunctionNames
registerOnceWorkerMessageListener
registerWorkerMessageListener
removeTaskFunction
sendStartupMessageToWorker
sendToWorker
setDefaultTaskFunction
setTasksQueueOptions
setWorkerChoiceStrategy
setWorkerChoiceStrategyOptions
setupHook
shallCreateDynamicWorker
start
workerMessageListener
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html
index 51007eb6..25d1f796 100644
--- a/docs/classes/DynamicThreadPool.html
+++ b/docs/classes/DynamicThreadPool.html
@@ -1,65 +1,65 @@
-DynamicThreadPool | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
DynamicThreadPool
Class DynamicThreadPool<Data, Response>
A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.
+DynamicThreadPool | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
DynamicThreadPool
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.
 
Author
Alessandro Pio Ardizio
 Since
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 full)
FixedThreadPool<Data, Response>DynamicThreadPool
Defined in src/pools/thread/dynamic.ts:16
 Index
Constructors
constructor
-
Properties
emitter?
-filePath
-maximumNumberOfWorkers?
-minimumNumberOfWorkers
-opts
-promiseResponseMap
-workerChoiceStrategyContext?
-workerNodes
-
Accessors
busy
-empty
-full
-info
-ready
-type
-utilization
-worker
-
Methods
addTaskFunction
-afterTaskExecutionHook
-afterWorkerNodeSetup
-beforeTaskExecutionHook
-checkAndEmitDynamicWorkerCreationEvents
-createAndSetupDynamicWorkerNode
-createAndSetupWorkerNode
-deregisterWorkerMessageListener
-destroy
-destroyWorkerNode
-enableTasksQueue
-execute
-flagWorkerNodeAsNotReady
-flushTasksQueue
-getWorkerInfo
-hasTaskFunction
-internalBusy
-isMain
-listTaskFunctionNames
-registerOnceWorkerMessageListener
-registerWorkerMessageListener
-removeTaskFunction
-sendStartupMessageToWorker
-sendToWorker
-setDefaultTaskFunction
-setTasksQueueOptions
-setWorkerChoiceStrategy
-setWorkerChoiceStrategyOptions
-setupHook
-shallCreateDynamicWorker
-start
-workerMessageListener
-
Constructors
constructor
new DynamicThreadPool<Data, Response>(min, max, filePath, opts?): DynamicThreadPool<Data, Response>
Constructs a new poolifier dynamic thread pool.
-
Type Parameters
Data = unknown
Response = unknown
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>
Overrides FixedThreadPool.constructor
Defined in src/pools/thread/dynamic.ts:28
Properties
Optional emitter
emitter?: EventEmitterAsyncResource
Event emitter integrated with async resource on which events can be listened to.
+
 Type Parameters
Data = unknownType of data sent to the worker. This can only be structured-cloneable data.
+
Response = unknownType of execution response. This can only be structured-cloneable data.
+
 Hierarchy (view full)
FixedThreadPool<Data, Response>DynamicThreadPool
Defined in src/pools/thread/dynamic.ts:16
 Index
Constructors
constructor
+
Properties
emitter?
+filePath
+maximumNumberOfWorkers?
+minimumNumberOfWorkers
+opts
+promiseResponseMap
+workerChoiceStrategyContext?
+workerNodes
+
Accessors
busy
+empty
+full
+info
+ready
+type
+utilization
+worker
+
Methods
addTaskFunction
+afterTaskExecutionHook
+afterWorkerNodeSetup
+beforeTaskExecutionHook
+checkAndEmitDynamicWorkerCreationEvents
+createAndSetupDynamicWorkerNode
+createAndSetupWorkerNode
+deregisterWorkerMessageListener
+destroy
+destroyWorkerNode
+enableTasksQueue
+execute
+flagWorkerNodeAsNotReady
+flushTasksQueue
+getWorkerInfo
+hasTaskFunction
+internalBusy
+isMain
+listTaskFunctionNames
+registerOnceWorkerMessageListener
+registerWorkerMessageListener
+removeTaskFunction
+sendStartupMessageToWorker
+sendToWorker
+setDefaultTaskFunction
+setTasksQueueOptions
+setWorkerChoiceStrategy
+setWorkerChoiceStrategyOptions
+setupHook
+shallCreateDynamicWorker
+start
+workerMessageListener
+
Constructors
constructor
new DynamicThreadPool<Data, Response>(min, max, filePath, opts?): DynamicThreadPool<Data, Response>
Constructs a new poolifier dynamic thread pool.
+
Type Parameters
Data = unknown
Response = unknown
Parameters
min: numberMinimum number of threads which are always active.
+
max: numberMaximum number of threads that can be created by this pool.
+
filePath: stringPath 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>
Overrides FixedThreadPool.constructor
Defined in src/pools/thread/dynamic.ts:28
Properties
Optional emitter
emitter?: EventEmitterAsyncResource
Event emitter integrated with async resource on which events can be listened to.
 The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.
 Events that can currently be listened to:
 
@@ -72,107 +72,72 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
 'taskError': Emitted when an error occurs while executing a task.
 'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
 

-
Inherited from FixedThreadPool.emitter
Defined in src/pools/abstract-pool.ts:79
Protected Readonly filePath
filePath: string
Path to the worker file.
-
Inherited from FixedThreadPool.filePath
Defined in src/pools/abstract-pool.ts:138
Protected Optional Readonly maximumNumberOfWorkers
maximumNumberOfWorkers?: number
Maximum number of workers that this pool manages.
-
Inherited from FixedThreadPool.maximumNumberOfWorkers
Defined in src/pools/abstract-pool.ts:140
Protected Readonly minimumNumberOfWorkers
minimumNumberOfWorkers: number
Minimum number of workers that this pool manages.
-
Inherited from FixedThreadPool.minimumNumberOfWorkers
Defined in src/pools/abstract-pool.ts:137
Protected Readonly opts
opts: PoolOptions<Worker>
Options for the pool.
-
Inherited from FixedThreadPool.opts
Defined in src/pools/abstract-pool.ts:139
Protected promiseResponseMap
promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
The task execution response promise map:
+
Inherited from FixedThreadPool.emitter
Defined in src/pools/abstract-pool.ts:79
Protected Readonly filePath
filePath: string
Path to the worker file.
+
Inherited from FixedThreadPool.filePath
Defined in src/pools/abstract-pool.ts:138
Protected Optional Readonly maximumNumberOfWorkers
maximumNumberOfWorkers?: number
Maximum number of workers that this pool manages.
+
Inherited from FixedThreadPool.maximumNumberOfWorkers
Defined in src/pools/abstract-pool.ts:140
Protected Readonly minimumNumberOfWorkers
minimumNumberOfWorkers: number
Minimum number of workers that this pool manages.
+
Inherited from FixedThreadPool.minimumNumberOfWorkers
Defined in src/pools/abstract-pool.ts:137
Protected Readonly opts
opts: PoolOptions<Worker>
Options for the pool.
+
Inherited from FixedThreadPool.opts
Defined in src/pools/abstract-pool.ts:139
Protected promiseResponseMap
promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
The task execution response promise map:
 
 key: The message id of each submitted task.
 value: An object that contains the worker, the execution response promise resolve and reject callbacks.
 
 When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
-
Inherited from FixedThreadPool.promiseResponseMap
Defined in src/pools/abstract-pool.ts:88
Protected Optional workerChoiceStrategyContext
workerChoiceStrategyContext?: WorkerChoiceStrategyContext<Worker, Data, Response>
Worker choice strategy context referencing a worker choice algorithm implementation.
-
Inherited from FixedThreadPool.workerChoiceStrategyContext
Defined in src/pools/abstract-pool.ts:94
Readonly Internal workerNodes
workerNodes: IWorkerNode<Worker, Data>[] = []
Pool worker nodes.
-
Inherited from FixedThreadPool.workerNodes
Defined in src/pools/abstract-pool.ts:76
Accessors
Protected busy
get busy(): boolean
Whether the pool is busy or not.
+
Inherited from FixedThreadPool.promiseResponseMap
Defined in src/pools/abstract-pool.ts:88
Protected Optional workerChoiceStrategyContext
workerChoiceStrategyContext?: WorkerChoiceStrategyContext<Worker, Data, Response>
Worker choice strategy context referencing a worker choice algorithm implementation.
+
Inherited from FixedThreadPool.workerChoiceStrategyContext
Defined in src/pools/abstract-pool.ts:94
Readonly Internal workerNodes
workerNodes: IWorkerNode<Worker, Data>[] = []
Pool worker nodes.
+
Inherited from FixedThreadPool.workerNodes
Defined in src/pools/abstract-pool.ts:76
Accessors
Protected busy
get busy(): boolean
Whether the pool is busy or not.
 The pool busyness boolean status.
-
Returns boolean
Overrides FixedThreadPool.busy
Defined in src/pools/thread/dynamic.ts:59
Protected empty
get empty(): boolean
The pool emptiness boolean status.
-
Returns boolean
Inherited from FixedThreadPool.empty
Defined in src/pools/abstract-pool.ts:464
Protected full
get full(): boolean
Whether the pool is full or not.
+
Returns boolean
Overrides FixedThreadPool.busy
Defined in src/pools/thread/dynamic.ts:59
Protected empty
get empty(): boolean
The pool emptiness boolean status.
+
Returns boolean
Inherited from FixedThreadPool.empty
Defined in src/pools/abstract-pool.ts:464
Protected full
get full(): boolean
Whether the pool is full or not.
 The pool filling boolean status.
-
Returns boolean
Inherited from FixedThreadPool.full
Defined in src/pools/abstract-pool.ts:658
info
get info(): PoolInfo
Pool information.
-
Returns PoolInfo
Inherited from FixedThreadPool.info
Defined in src/pools/abstract-pool.ts:277
Private ready
get ready(): boolean
The pool readiness boolean status.
-
Returns boolean
Inherited from FixedThreadPool.ready
Defined in src/pools/abstract-pool.ts:446
Protected type
get type(): "fixed" | "dynamic"
The pool type.
+
Returns boolean
Inherited from FixedThreadPool.full
Defined in src/pools/abstract-pool.ts:658
info
get info(): PoolInfo
Pool information.
+
Returns PoolInfo
Inherited from FixedThreadPool.info
Defined in src/pools/abstract-pool.ts:277
Private ready
get ready(): boolean
The pool readiness boolean status.
+
Returns boolean
Inherited from FixedThreadPool.ready
Defined in src/pools/abstract-pool.ts:446
Protected type
get type(): "fixed" | "dynamic"
The pool type.
 If it is 'dynamic', it provides the max property.
-
Returns "fixed" | "dynamic"
Overrides FixedThreadPool.type
Defined in src/pools/thread/dynamic.ts:54
Private utilization
get utilization(): number
The approximate pool utilization.
+
Returns "fixed" | "dynamic"
Overrides FixedThreadPool.type
Defined in src/pools/thread/dynamic.ts:54
Private utilization
get utilization(): number
The approximate pool utilization.
 
Returns number
The pool utilization.
-
Inherited from FixedThreadPool.utilization
Defined in src/pools/abstract-pool.ts:473
Protected worker
get worker(): "thread" | "cluster"
The worker type.
-
Returns "thread" | "cluster"
Inherited from FixedThreadPool.worker
Defined in src/pools/thread/fixed.ts:128
Methods
addTaskFunction
addTaskFunction(name, fn): Promise<boolean>
Adds a task function to this pool.
-If a task function with the same name already exists, it will be overwritten.
-
Parameters
name: string
The name of the task function.
-
fn: TaskFunction<Data, Response>
The task function.
-
Returns Promise<boolean>
true if the task function was added, false otherwise.
-Throws
https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.
-Throws
https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.
-
Inherited from FixedThreadPool.addTaskFunction
Defined in src/pools/abstract-pool.ts:812
Protected afterTaskExecutionHook
afterTaskExecutionHook(workerNodeKey, message): void
Hook executed after the worker task execution.
+
Inherited from FixedThreadPool.utilization
Defined in src/pools/abstract-pool.ts:473
Protected worker
get worker(): "thread" | "cluster"
The worker type.
+
Returns "thread" | "cluster"
Inherited from FixedThreadPool.worker
Defined in src/pools/thread/fixed.ts:128
Methods
addTaskFunction
addTaskFunction(name, fn): Promise<boolean>
Parameters
name: string
fn: TaskFunction<Data, Response>
Returns Promise<boolean>
Inherit Doc
Inherited from FixedThreadPool.addTaskFunction
Defined in src/pools/abstract-pool.ts:812
Protected afterTaskExecutionHook
afterTaskExecutionHook(workerNodeKey, message): void
Hook executed after the worker task execution.
 Can be overridden.
-
Parameters
workerNodeKey: number
The worker node key.
-
message: MessageValue<Response, unknown>
The received message.
-
Returns void
Inherited from FixedThreadPool.afterTaskExecutionHook
Defined in src/pools/abstract-pool.ts:1111
Protected afterWorkerNodeSetup
afterWorkerNodeSetup(workerNodeKey): void
Method hooked up after a worker node has been newly created.
+
Parameters
workerNodeKey: numberThe worker node key.
+
message: MessageValue<Response, unknown>The received message.
+
Returns void
Inherited from FixedThreadPool.afterTaskExecutionHook
Defined in src/pools/abstract-pool.ts:1111
Protected afterWorkerNodeSetup
afterWorkerNodeSetup(workerNodeKey): 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
Inherited from FixedThreadPool.afterWorkerNodeSetup
Defined in src/pools/abstract-pool.ts:1378
Protected beforeTaskExecutionHook
beforeTaskExecutionHook(workerNodeKey, task): void
Hook executed before the worker task execution.
+
Parameters
workerNodeKey: numberThe newly created worker node key.
+
Returns void
Inherited from FixedThreadPool.afterWorkerNodeSetup
Defined in src/pools/abstract-pool.ts:1378
Protected beforeTaskExecutionHook
beforeTaskExecutionHook(workerNodeKey, task): 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
Inherited from FixedThreadPool.beforeTaskExecutionHook
Defined in src/pools/abstract-pool.ts:1070
Protected checkAndEmitDynamicWorkerCreationEvents
checkAndEmitDynamicWorkerCreationEvents(): void
Emits dynamic worker creation events.
-
Returns void
Overrides FixedThreadPool.checkAndEmitDynamicWorkerCreationEvents
Defined in src/pools/thread/dynamic.ts:47
Protected createAndSetupDynamicWorkerNode
createAndSetupDynamicWorkerNode(): number
Creates a new, completely set up dynamic worker node.
+
Parameters
workerNodeKey: numberThe worker node key.
+
task: Task<Data>The task to execute.
+
Returns void
Inherited from FixedThreadPool.beforeTaskExecutionHook
Defined in src/pools/abstract-pool.ts:1070
Protected checkAndEmitDynamicWorkerCreationEvents
checkAndEmitDynamicWorkerCreationEvents(): void
Emits dynamic worker creation events.
+
Returns void
Overrides FixedThreadPool.checkAndEmitDynamicWorkerCreationEvents
Defined in src/pools/thread/dynamic.ts:47
Protected createAndSetupDynamicWorkerNode
createAndSetupDynamicWorkerNode(): number
Creates a new, completely set up dynamic worker node.
 
Returns number
New, completely set up dynamic worker node key.
-
Inherited from FixedThreadPool.createAndSetupDynamicWorkerNode
Defined in src/pools/abstract-pool.ts:1280
Protected createAndSetupWorkerNode
createAndSetupWorkerNode(): number
Creates a new, completely set up worker node.
+
Inherited from FixedThreadPool.createAndSetupDynamicWorkerNode
Defined in src/pools/abstract-pool.ts:1280
Protected createAndSetupWorkerNode
createAndSetupWorkerNode(): number
Creates a new, completely set up worker node.
 
Returns number
New, completely set up worker node key.
-
Inherited from FixedThreadPool.createAndSetupWorkerNode
Defined in src/pools/abstract-pool.ts:1223
Protected deregisterWorkerMessageListener
deregisterWorkerMessageListener<Message>(workerNodeKey, listener): 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) => void)
The message listener callback.
-
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Inherited from FixedThreadPool.deregisterWorkerMessageListener
Defined in src/pools/thread/fixed.ts:102
destroy
destroy(): Promise<void>
Terminates all workers in this pool.
-
Returns Promise<void>
Inherited from FixedThreadPool.destroy
Defined in src/pools/abstract-pool.ts:977
Protected destroyWorkerNode
destroyWorkerNode(workerNodeKey): Promise<void>
Terminates the worker node given its worker node key.
-
Parameters
workerNodeKey: number
The worker node key.
-
Returns Promise<void>
Inherited from FixedThreadPool.destroyWorkerNode
Defined in src/pools/abstract-pool.ts:1031
enableTasksQueue
enableTasksQueue(enable, tasksQueueOptions?): void
Enables/disables the worker node tasks queue in this pool.
-
Parameters
enable: boolean
Whether to enable or disable the worker node tasks queue.
-
Optional tasksQueueOptions: TasksQueueOptions
The worker node tasks queue options.
-
Returns void
Inherited from FixedThreadPool.enableTasksQueue
Defined in src/pools/abstract-pool.ts:563
execute
execute(data?, name?, transferList?): Promise<Response>
Executes the specified function in the worker constructor with the task data input parameter.
-
Parameters
Optional data: Data
The optional task input data for the specified task function. This can only be structured-cloneable data.
-
Optional name: string
The optional name of the task function to execute. If not specified, the default task function will be executed.
-
Optional transferList: TransferListItem[]
An 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 that will be fulfilled when the task is completed.
-
Inherited from FixedThreadPool.execute
Defined in src/pools/abstract-pool.ts:887
Protected flagWorkerNodeAsNotReady
flagWorkerNodeAsNotReady(workerNodeKey): void
Parameters
workerNodeKey: number
Returns void
Inherited from FixedThreadPool.flagWorkerNodeAsNotReady
Defined in src/pools/abstract-pool.ts:1890
Protected flushTasksQueue
flushTasksQueue(workerNodeKey): number
Parameters
workerNodeKey: number
Returns number
Inherited from FixedThreadPool.flushTasksQueue
Defined in src/pools/abstract-pool.ts:1932
Protected getWorkerInfo
getWorkerInfo(workerNodeKey): undefined | WorkerInfo
Gets the worker information given its worker node key.
-
Parameters
workerNodeKey: number
The worker node key.
+
Inherited from FixedThreadPool.createAndSetupWorkerNode
Defined in src/pools/abstract-pool.ts:1223
Protected deregisterWorkerMessageListener
deregisterWorkerMessageListener<Message>(workerNodeKey, listener): void
Deregisters a listener callback on the worker given its worker node key.
+
Type Parameters
Message
Parameters
workerNodeKey: numberThe worker node key.
+
listener: ((message) => void)The message listener callback.
+
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Inherited from FixedThreadPool.deregisterWorkerMessageListener
Defined in src/pools/thread/fixed.ts:102
destroy
destroy(): Promise<void>
Returns Promise<void>
Inherit Doc
Inherited from FixedThreadPool.destroy
Defined in src/pools/abstract-pool.ts:977
Protected destroyWorkerNode
destroyWorkerNode(workerNodeKey): Promise<void>
Terminates the worker node given its worker node key.
+
Parameters
workerNodeKey: numberThe worker node key.
+
Returns Promise<void>
Inherited from FixedThreadPool.destroyWorkerNode
Defined in src/pools/abstract-pool.ts:1031
enableTasksQueue
enableTasksQueue(enable, tasksQueueOptions?): void
Parameters
enable: boolean
Optional tasksQueueOptions: TasksQueueOptions
Returns void
Inherit Doc
Inherited from FixedThreadPool.enableTasksQueue
Defined in src/pools/abstract-pool.ts:563
execute
execute(data?, name?, transferList?): Promise<Response>
Parameters
Optional data: Data
Optional name: string
Optional transferList: TransferListItem[]
Returns Promise<Response>
Inherit Doc
Inherited from FixedThreadPool.execute
Defined in src/pools/abstract-pool.ts:887
Protected flagWorkerNodeAsNotReady
flagWorkerNodeAsNotReady(workerNodeKey): void
Parameters
workerNodeKey: number
Returns void
Inherited from FixedThreadPool.flagWorkerNodeAsNotReady
Defined in src/pools/abstract-pool.ts:1890
Protected flushTasksQueue
flushTasksQueue(workerNodeKey): number
Parameters
workerNodeKey: number
Returns number
Inherited from FixedThreadPool.flushTasksQueue
Defined in src/pools/abstract-pool.ts:1932
Protected getWorkerInfo
getWorkerInfo(workerNodeKey): undefined | WorkerInfo
Gets the worker information given its worker node key.
+
Parameters
workerNodeKey: numberThe worker node key.
 
Returns undefined | WorkerInfo
The worker information.
-
Inherited from FixedThreadPool.getWorkerInfo
Defined in src/pools/abstract-pool.ts:1823
hasTaskFunction
hasTaskFunction(name): boolean
Whether the specified task function exists in this pool.
-
Parameters
name: string
The name of the task function.
-
Returns boolean
true if the task function exists, false otherwise.
-
Inherited from FixedThreadPool.hasTaskFunction
Defined in src/pools/abstract-pool.ts:799
Protected internalBusy
internalBusy(): boolean
Whether worker nodes are executing concurrently their tasks quota or not.
+
Inherited from FixedThreadPool.getWorkerInfo
Defined in src/pools/abstract-pool.ts:1823
hasTaskFunction
hasTaskFunction(name): boolean
Parameters
name: string
Returns boolean
Inherit Doc
Inherited from FixedThreadPool.hasTaskFunction
Defined in src/pools/abstract-pool.ts:799
Protected internalBusy
internalBusy(): boolean
Whether worker nodes are executing concurrently their tasks quota or not.
 
Returns boolean
Worker nodes busyness boolean status.
-
Inherited from FixedThreadPool.internalBusy
Defined in src/pools/abstract-pool.ts:677
Protected isMain
isMain(): boolean
Should return whether the worker is the main worker or not.
-
Returns boolean
Inherited from FixedThreadPool.isMain
Defined in src/pools/thread/fixed.ts:45
listTaskFunctionNames
listTaskFunctionNames(): string[]
Lists the names of task function available in this pool.
-
Returns string[]
The names of task function available in this pool.
-
Inherited from FixedThreadPool.listTaskFunctionNames
Defined in src/pools/abstract-pool.ts:851
Protected registerOnceWorkerMessageListener
registerOnceWorkerMessageListener<Message>(workerNodeKey, listener): void
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) => void)
The message listener callback.
-
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Inherited from FixedThreadPool.registerOnceWorkerMessageListener
Defined in src/pools/thread/fixed.ts:91
Protected registerWorkerMessageListener
registerWorkerMessageListener<Message>(workerNodeKey, listener): 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) => void)
The message listener callback.
-
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Inherited from FixedThreadPool.registerWorkerMessageListener
Defined in src/pools/thread/fixed.ts:80
removeTaskFunction
removeTaskFunction(name): Promise<boolean>
Removes a task function from this pool.
-
Parameters
name: string
The name of the task function.
-
Returns Promise<boolean>
true if the task function was removed, false otherwise.
-
Inherited from FixedThreadPool.removeTaskFunction
Defined in src/pools/abstract-pool.ts:835
Protected sendStartupMessageToWorker
sendStartupMessageToWorker(workerNodeKey): void
Sends the startup message to worker given its worker node key.
-
Parameters
workerNodeKey: number
The worker node key.
-
Returns void
Inherited from FixedThreadPool.sendStartupMessageToWorker
Defined in src/pools/thread/fixed.ts:65
Protected sendToWorker
sendToWorker(workerNodeKey, message, transferList?): void
Sends a message to worker given its worker node key.
-
Parameters
workerNodeKey: number
The worker node key.
-
message: MessageValue<Data, unknown>
The message.
-
Optional transferList: TransferListItem[]
The optional array of transferable objects.
-
Returns void
Inherited from FixedThreadPool.sendToWorker
Defined in src/pools/thread/fixed.ts:50
setDefaultTaskFunction
setDefaultTaskFunction(name): Promise<boolean>
Sets the default task function in this pool.
-
Parameters
name: string
The name of the task function.
-
Returns Promise<boolean>
true if the default task function was set, false otherwise.
-
Inherited from FixedThreadPool.setDefaultTaskFunction
Defined in src/pools/abstract-pool.ts:864
setTasksQueueOptions
setTasksQueueOptions(tasksQueueOptions): void
Sets the worker node tasks queue options in this pool.
-
Parameters
tasksQueueOptions: undefined | TasksQueueOptions
The worker node tasks queue options.
-
Returns void
Inherited from FixedThreadPool.setTasksQueueOptions
Defined in src/pools/abstract-pool.ts:577
setWorkerChoiceStrategy
setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void
Sets the worker choice strategy in this pool.
-
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
The worker choice strategy.
-
Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
The worker choice strategy options.
-
Returns void
Inherited from FixedThreadPool.setWorkerChoiceStrategy
Defined in src/pools/abstract-pool.ts:531
setWorkerChoiceStrategyOptions
setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void
Sets the worker choice strategy options in this pool.
-
Parameters
workerChoiceStrategyOptions: undefined | WorkerChoiceStrategyOptions
The worker choice strategy options.
-
Returns void
Inherited from FixedThreadPool.setWorkerChoiceStrategyOptions
Defined in src/pools/abstract-pool.ts:550
Protected setupHook
setupHook(): void
Setup hook to execute code before worker nodes are created in the abstract constructor.
+
Inherited from FixedThreadPool.internalBusy
Defined in src/pools/abstract-pool.ts:677
Protected isMain
isMain(): boolean
Should return whether the worker is the main worker or not.
+
Returns boolean
Inherited from FixedThreadPool.isMain
Defined in src/pools/thread/fixed.ts:45
listTaskFunctionNames
listTaskFunctionNames(): string[]
Returns string[]
Inherit Doc
Inherited from FixedThreadPool.listTaskFunctionNames
Defined in src/pools/abstract-pool.ts:851
Protected registerOnceWorkerMessageListener
registerOnceWorkerMessageListener<Message>(workerNodeKey, listener): void
Registers once a listener callback on the worker given its worker node key.
+
Type Parameters
Message
Parameters
workerNodeKey: numberThe worker node key.
+
listener: ((message) => void)The message listener callback.
+
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Inherited from FixedThreadPool.registerOnceWorkerMessageListener
Defined in src/pools/thread/fixed.ts:91
Protected registerWorkerMessageListener
registerWorkerMessageListener<Message>(workerNodeKey, listener): void
Registers a listener callback on the worker given its worker node key.
+
Type Parameters
Message
Parameters
workerNodeKey: numberThe worker node key.
+
listener: ((message) => void)The message listener callback.
+
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Inherited from FixedThreadPool.registerWorkerMessageListener
Defined in src/pools/thread/fixed.ts:80
removeTaskFunction
removeTaskFunction(name): Promise<boolean>
Parameters
name: string
Returns Promise<boolean>
Inherit Doc
Inherited from FixedThreadPool.removeTaskFunction
Defined in src/pools/abstract-pool.ts:835
Protected sendStartupMessageToWorker
sendStartupMessageToWorker(workerNodeKey): void
Sends the startup message to worker given its worker node key.
+
Parameters
workerNodeKey: numberThe worker node key.
+
Returns void
Inherited from FixedThreadPool.sendStartupMessageToWorker
Defined in src/pools/thread/fixed.ts:65
Protected sendToWorker
sendToWorker(workerNodeKey, message, transferList?): void
Sends a message to worker given its worker node key.
+
Parameters
workerNodeKey: numberThe worker node key.
+
message: MessageValue<Data, unknown>The message.
+
Optional transferList: TransferListItem[]The optional array of transferable objects.
+
Returns void
Inherited from FixedThreadPool.sendToWorker
Defined in src/pools/thread/fixed.ts:50
setDefaultTaskFunction
setDefaultTaskFunction(name): Promise<boolean>
Parameters
name: string
Returns Promise<boolean>
Inherit Doc
Inherited from FixedThreadPool.setDefaultTaskFunction
Defined in src/pools/abstract-pool.ts:864
setTasksQueueOptions
setTasksQueueOptions(tasksQueueOptions): void
Parameters
tasksQueueOptions: undefined | TasksQueueOptions
Returns void
Inherit Doc
Inherited from FixedThreadPool.setTasksQueueOptions
Defined in src/pools/abstract-pool.ts:577
setWorkerChoiceStrategy
setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
Returns void
Inherit Doc
Inherited from FixedThreadPool.setWorkerChoiceStrategy
Defined in src/pools/abstract-pool.ts:531
setWorkerChoiceStrategyOptions
setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void
Parameters
workerChoiceStrategyOptions: undefined | WorkerChoiceStrategyOptions
Returns void
Inherit Doc
Inherited from FixedThreadPool.setWorkerChoiceStrategyOptions
Defined in src/pools/abstract-pool.ts:550
Protected setupHook
setupHook(): void
Setup hook to execute code before worker nodes are created in the abstract constructor.
 Can be overridden.
-
Returns void
Inherited from FixedThreadPool.setupHook
Defined in src/pools/abstract-pool.ts:1054
Protected shallCreateDynamicWorker
shallCreateDynamicWorker(): boolean
Conditions for dynamic worker creation.
+
Returns void
Inherited from FixedThreadPool.setupHook
Defined in src/pools/abstract-pool.ts:1054
Protected shallCreateDynamicWorker
shallCreateDynamicWorker(): boolean
Conditions for dynamic worker creation.
 
Returns boolean
Whether to create a dynamic worker or not.
-
Overrides FixedThreadPool.shallCreateDynamicWorker
Defined in src/pools/thread/dynamic.ts:42
start
start(): void
Starts the minimum number of workers in this pool.
-
Returns void
Inherited from FixedThreadPool.start
Defined in src/pools/abstract-pool.ts:952
Protected Readonly workerMessageListener
workerMessageListener(message): void
This method is the message listener registered on each worker.
-
Parameters
message: MessageValue<Response, unknown>
Returns void
Inherited from FixedThreadPool.workerMessageListener
Defined in src/pools/abstract-pool.ts:1702
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
constructor
emitter
filePath
maximumNumberOfWorkers
minimumNumberOfWorkers
opts
promiseResponseMap
workerChoiceStrategyContext
workerNodes
busy
empty
full
info
ready
type
utilization
worker
addTaskFunction
afterTaskExecutionHook
afterWorkerNodeSetup
beforeTaskExecutionHook
checkAndEmitDynamicWorkerCreationEvents
createAndSetupDynamicWorkerNode
createAndSetupWorkerNode
deregisterWorkerMessageListener
destroy
destroyWorkerNode
enableTasksQueue
execute
flagWorkerNodeAsNotReady
flushTasksQueue
getWorkerInfo
hasTaskFunction
internalBusy
isMain
listTaskFunctionNames
registerOnceWorkerMessageListener
registerWorkerMessageListener
removeTaskFunction
sendStartupMessageToWorker
sendToWorker
setDefaultTaskFunction
setTasksQueueOptions
setWorkerChoiceStrategy
setWorkerChoiceStrategyOptions
setupHook
shallCreateDynamicWorker
start
workerMessageListener
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+
Overrides FixedThreadPool.shallCreateDynamicWorker
Defined in src/pools/thread/dynamic.ts:42
start
start(): void
Returns void
Inherit Doc
Inherited from FixedThreadPool.start
Defined in src/pools/abstract-pool.ts:952
Protected Readonly workerMessageListener
workerMessageListener(message): void
This method is the message listener registered on each worker.
+
Parameters
message: MessageValue<Response, unknown>
Returns void
Inherited from FixedThreadPool.workerMessageListener
Defined in src/pools/abstract-pool.ts:1702
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
constructor
emitter
filePath
maximumNumberOfWorkers
minimumNumberOfWorkers
opts
promiseResponseMap
workerChoiceStrategyContext
workerNodes
busy
empty
full
info
ready
type
utilization
worker
addTaskFunction
afterTaskExecutionHook
afterWorkerNodeSetup
beforeTaskExecutionHook
checkAndEmitDynamicWorkerCreationEvents
createAndSetupDynamicWorkerNode
createAndSetupWorkerNode
deregisterWorkerMessageListener
destroy
destroyWorkerNode
enableTasksQueue
execute
flagWorkerNodeAsNotReady
flushTasksQueue
getWorkerInfo
hasTaskFunction
internalBusy
isMain
listTaskFunctionNames
registerOnceWorkerMessageListener
registerWorkerMessageListener
removeTaskFunction
sendStartupMessageToWorker
sendToWorker
setDefaultTaskFunction
setTasksQueueOptions
setWorkerChoiceStrategy
setWorkerChoiceStrategyOptions
setupHook
shallCreateDynamicWorker
start
workerMessageListener
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html
index ca0bffe4..0449c929 100644
--- a/docs/classes/FixedClusterPool.html
+++ b/docs/classes/FixedClusterPool.html
@@ -1,62 +1,62 @@
-FixedClusterPool | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
FixedClusterPool
Class FixedClusterPool<Data, Response>
A cluster pool with a fixed number of workers.
+FixedClusterPool | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
FixedClusterPool
Class FixedClusterPool<Data, Response>
A cluster pool with a fixed number of workers.
 
Author
Christopher Quadflieg
 Since
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 full)
AbstractPool<Worker, Data, Response>FixedClusterPoolDynamicClusterPool
Defined in src/pools/cluster/fixed.ts:20
 Index
Constructors
constructor
-
Properties
emitter?
-filePath
-maximumNumberOfWorkers?
-minimumNumberOfWorkers
-opts
-promiseResponseMap
-workerChoiceStrategyContext?
-workerNodes
-
Accessors
busy
-empty
-full
-info
-ready
-type
-utilization
-worker
-
Methods
addTaskFunction
-afterTaskExecutionHook
-afterWorkerNodeSetup
-beforeTaskExecutionHook
-checkAndEmitDynamicWorkerCreationEvents
-createAndSetupDynamicWorkerNode
-createAndSetupWorkerNode
-deregisterWorkerMessageListener
-destroy
-destroyWorkerNode
-enableTasksQueue
-execute
-flagWorkerNodeAsNotReady
-flushTasksQueue
-getWorkerInfo
-hasTaskFunction
-internalBusy
-isMain
-listTaskFunctionNames
-registerOnceWorkerMessageListener
-registerWorkerMessageListener
-removeTaskFunction
-sendStartupMessageToWorker
-sendToWorker
-setDefaultTaskFunction
-setTasksQueueOptions
-setWorkerChoiceStrategy
-setWorkerChoiceStrategyOptions
-setupHook
-shallCreateDynamicWorker
-start
-workerMessageListener
-
Constructors
constructor
new FixedClusterPool<Data, Response>(numberOfWorkers, filePath, opts?, maximumNumberOfWorkers?): FixedClusterPool<Data, Response>
Constructs a new poolifier fixed cluster pool.
-
Type Parameters
Data = unknown
Response = unknown
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.
-
Optional maximumNumberOfWorkers: number
Returns FixedClusterPool<Data, Response>
Overrides AbstractPool.constructor
Defined in src/pools/cluster/fixed.ts:31
Properties
Optional emitter
emitter?: EventEmitterAsyncResource
Event emitter integrated with async resource on which events can be listened to.
+
 Type Parameters
Data = unknownType of data sent to the worker. This can only be structured-cloneable data.
+
Response = unknownType of execution response. This can only be structured-cloneable data.
+
 Hierarchy (view full)
AbstractPool<Worker, Data, Response>FixedClusterPoolDynamicClusterPool
Defined in src/pools/cluster/fixed.ts:20
 Index
Constructors
constructor
+
Properties
emitter?
+filePath
+maximumNumberOfWorkers?
+minimumNumberOfWorkers
+opts
+promiseResponseMap
+workerChoiceStrategyContext?
+workerNodes
+
Accessors
busy
+empty
+full
+info
+ready
+type
+utilization
+worker
+
Methods
addTaskFunction
+afterTaskExecutionHook
+afterWorkerNodeSetup
+beforeTaskExecutionHook
+checkAndEmitDynamicWorkerCreationEvents
+createAndSetupDynamicWorkerNode
+createAndSetupWorkerNode
+deregisterWorkerMessageListener
+destroy
+destroyWorkerNode
+enableTasksQueue
+execute
+flagWorkerNodeAsNotReady
+flushTasksQueue
+getWorkerInfo
+hasTaskFunction
+internalBusy
+isMain
+listTaskFunctionNames
+registerOnceWorkerMessageListener
+registerWorkerMessageListener
+removeTaskFunction
+sendStartupMessageToWorker
+sendToWorker
+setDefaultTaskFunction
+setTasksQueueOptions
+setWorkerChoiceStrategy
+setWorkerChoiceStrategyOptions
+setupHook
+shallCreateDynamicWorker
+start
+workerMessageListener
+
Constructors
constructor
new FixedClusterPool<Data, Response>(numberOfWorkers, filePath, opts?, maximumNumberOfWorkers?): FixedClusterPool<Data, Response>
Constructs a new poolifier fixed cluster pool.
+
Type Parameters
Data = unknown
Response = unknown
Parameters
numberOfWorkers: numberNumber of workers for this pool.
+
filePath: stringPath to an implementation of a ClusterWorker file, which can be relative or absolute.
+
opts: ClusterPoolOptions = {}Options for this fixed cluster pool.
+
Optional maximumNumberOfWorkers: number
Returns FixedClusterPool<Data, Response>
Overrides AbstractPool.constructor
Defined in src/pools/cluster/fixed.ts:31
Properties
Optional emitter
emitter?: EventEmitterAsyncResource
Event emitter integrated with async resource on which events can be listened to.
 The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.
 Events that can currently be listened to:
 
@@ -69,106 +69,71 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
 'taskError': Emitted when an error occurs while executing a task.
 'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
 

-
Inherited from AbstractPool.emitter
Defined in src/pools/abstract-pool.ts:79
Protected Readonly filePath
filePath: string
Path to the worker file.
-
Inherited from AbstractPool.filePath
Defined in src/pools/abstract-pool.ts:138
Protected Optional Readonly maximumNumberOfWorkers
maximumNumberOfWorkers?: number
Maximum number of workers that this pool manages.
-
Inherited from AbstractPool.maximumNumberOfWorkers
Defined in src/pools/abstract-pool.ts:140
Protected Readonly minimumNumberOfWorkers
minimumNumberOfWorkers: number
Minimum number of workers that this pool manages.
-
Inherited from AbstractPool.minimumNumberOfWorkers
Defined in src/pools/abstract-pool.ts:137
Protected Readonly opts
opts: PoolOptions<Worker>
Options for the pool.
-
Inherited from AbstractPool.opts
Defined in src/pools/abstract-pool.ts:139
Protected promiseResponseMap
promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
The task execution response promise map:
+
Inherited from AbstractPool.emitter
Defined in src/pools/abstract-pool.ts:79
Protected Readonly filePath
filePath: string
Path to the worker file.
+
Inherited from AbstractPool.filePath
Defined in src/pools/abstract-pool.ts:138
Protected Optional Readonly maximumNumberOfWorkers
maximumNumberOfWorkers?: number
Maximum number of workers that this pool manages.
+
Inherited from AbstractPool.maximumNumberOfWorkers
Defined in src/pools/abstract-pool.ts:140
Protected Readonly minimumNumberOfWorkers
minimumNumberOfWorkers: number
Minimum number of workers that this pool manages.
+
Inherited from AbstractPool.minimumNumberOfWorkers
Defined in src/pools/abstract-pool.ts:137
Protected Readonly opts
opts: PoolOptions<Worker>
Options for the pool.
+
Inherited from AbstractPool.opts
Defined in src/pools/abstract-pool.ts:139
Protected promiseResponseMap
promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
The task execution response promise map:
 
 key: The message id of each submitted task.
 value: An object that contains the worker, the execution response promise resolve and reject callbacks.
 
 When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
-
Inherited from AbstractPool.promiseResponseMap
Defined in src/pools/abstract-pool.ts:88
Protected Optional workerChoiceStrategyContext
workerChoiceStrategyContext?: WorkerChoiceStrategyContext<Worker, Data, Response>
Worker choice strategy context referencing a worker choice algorithm implementation.
-
Inherited from AbstractPool.workerChoiceStrategyContext
Defined in src/pools/abstract-pool.ts:94
Readonly Internal workerNodes
workerNodes: IWorkerNode<Worker, Data>[] = []
Pool worker nodes.
-
Inherited from AbstractPool.workerNodes
Defined in src/pools/abstract-pool.ts:76
Accessors
Protected busy
get busy(): boolean
Whether the pool is busy or not.
+
Inherited from AbstractPool.promiseResponseMap
Defined in src/pools/abstract-pool.ts:88
Protected Optional workerChoiceStrategyContext
workerChoiceStrategyContext?: WorkerChoiceStrategyContext<Worker, Data, Response>
Worker choice strategy context referencing a worker choice algorithm implementation.
+
Inherited from AbstractPool.workerChoiceStrategyContext
Defined in src/pools/abstract-pool.ts:94
Readonly Internal workerNodes
workerNodes: IWorkerNode<Worker, Data>[] = []
Pool worker nodes.
+
Inherited from AbstractPool.workerNodes
Defined in src/pools/abstract-pool.ts:76
Accessors
Protected busy
get busy(): boolean
Whether the pool is busy or not.
 The pool busyness boolean status.
-
Returns boolean
Overrides AbstractPool.busy
Defined in src/pools/cluster/fixed.ts:113
Protected empty
get empty(): boolean
The pool emptiness boolean status.
-
Returns boolean
Inherited from AbstractPool.empty
Defined in src/pools/abstract-pool.ts:464
Protected full
get full(): boolean
Whether the pool is full or not.
+
Returns boolean
Overrides AbstractPool.busy
Defined in src/pools/cluster/fixed.ts:113
Protected empty
get empty(): boolean
The pool emptiness boolean status.
+
Returns boolean
Inherited from AbstractPool.empty
Defined in src/pools/abstract-pool.ts:464
Protected full
get full(): boolean
Whether the pool is full or not.
 The pool filling boolean status.
-
Returns boolean
Inherited from AbstractPool.full
Defined in src/pools/abstract-pool.ts:658
info
get info(): PoolInfo
Pool information.
-
Returns PoolInfo
Inherited from AbstractPool.info
Defined in src/pools/abstract-pool.ts:277
Private ready
get ready(): boolean
The pool readiness boolean status.
-
Returns boolean
Inherited from AbstractPool.ready
Defined in src/pools/abstract-pool.ts:446
Protected type
get type(): "fixed" | "dynamic"
The pool type.
+
Returns boolean
Inherited from AbstractPool.full
Defined in src/pools/abstract-pool.ts:658
info
get info(): PoolInfo
Pool information.
+
Returns PoolInfo
Inherited from AbstractPool.info
Defined in src/pools/abstract-pool.ts:277
Private ready
get ready(): boolean
The pool readiness boolean status.
+
Returns boolean
Inherited from AbstractPool.ready
Defined in src/pools/abstract-pool.ts:446
Protected type
get type(): "fixed" | "dynamic"
The pool type.
 If it is 'dynamic', it provides the max property.
-
Returns "fixed" | "dynamic"
Overrides AbstractPool.type
Defined in src/pools/cluster/fixed.ts:103
Private utilization
get utilization(): number
The approximate pool utilization.
+
Returns "fixed" | "dynamic"
Overrides AbstractPool.type
Defined in src/pools/cluster/fixed.ts:103
Private utilization
get utilization(): number
The approximate pool utilization.
 
Returns number
The pool utilization.
-
Inherited from AbstractPool.utilization
Defined in src/pools/abstract-pool.ts:473
Protected worker
get worker(): "thread" | "cluster"
The worker type.
-
Returns "thread" | "cluster"
Overrides AbstractPool.worker
Defined in src/pools/cluster/fixed.ts:108
Methods
addTaskFunction
addTaskFunction(name, fn): Promise<boolean>
Adds a task function to this pool.
-If a task function with the same name already exists, it will be overwritten.
-
Parameters
name: string
The name of the task function.
-
fn: TaskFunction<Data, Response>
The task function.
-
Returns Promise<boolean>
true if the task function was added, false otherwise.
-Throws
https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.
-Throws
https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.
-
Inherited from AbstractPool.addTaskFunction
Defined in src/pools/abstract-pool.ts:812
Protected afterTaskExecutionHook
afterTaskExecutionHook(workerNodeKey, message): void
Hook executed after the worker task execution.
+
Inherited from AbstractPool.utilization
Defined in src/pools/abstract-pool.ts:473
Protected worker
get worker(): "thread" | "cluster"
The worker type.
+
Returns "thread" | "cluster"
Overrides AbstractPool.worker
Defined in src/pools/cluster/fixed.ts:108
Methods
addTaskFunction
addTaskFunction(name, fn): Promise<boolean>
Parameters
name: string
fn: TaskFunction<Data, Response>
Returns Promise<boolean>
Inherit Doc
Inherited from AbstractPool.addTaskFunction
Defined in src/pools/abstract-pool.ts:812
Protected afterTaskExecutionHook
afterTaskExecutionHook(workerNodeKey, message): void
Hook executed after the worker task execution.
 Can be overridden.
-
Parameters
workerNodeKey: number
The worker node key.
-
message: MessageValue<Response, unknown>
The received message.
-
Returns void
Inherited from AbstractPool.afterTaskExecutionHook
Defined in src/pools/abstract-pool.ts:1111
Protected afterWorkerNodeSetup
afterWorkerNodeSetup(workerNodeKey): void
Method hooked up after a worker node has been newly created.
+
Parameters
workerNodeKey: numberThe worker node key.
+
message: MessageValue<Response, unknown>The received message.
+
Returns void
Inherited from AbstractPool.afterTaskExecutionHook
Defined in src/pools/abstract-pool.ts:1111
Protected afterWorkerNodeSetup
afterWorkerNodeSetup(workerNodeKey): 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
Inherited from AbstractPool.afterWorkerNodeSetup
Defined in src/pools/abstract-pool.ts:1378
Protected beforeTaskExecutionHook
beforeTaskExecutionHook(workerNodeKey, task): void
Hook executed before the worker task execution.
+
Parameters
workerNodeKey: numberThe newly created worker node key.
+
Returns void
Inherited from AbstractPool.afterWorkerNodeSetup
Defined in src/pools/abstract-pool.ts:1378
Protected beforeTaskExecutionHook
beforeTaskExecutionHook(workerNodeKey, task): 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
Inherited from AbstractPool.beforeTaskExecutionHook
Defined in src/pools/abstract-pool.ts:1070
Protected checkAndEmitDynamicWorkerCreationEvents
checkAndEmitDynamicWorkerCreationEvents(): void
Emits dynamic worker creation events.
-
Returns void
Overrides AbstractPool.checkAndEmitDynamicWorkerCreationEvents
Defined in src/pools/cluster/fixed.ts:98
Protected createAndSetupDynamicWorkerNode
createAndSetupDynamicWorkerNode(): number
Creates a new, completely set up dynamic worker node.
+
Parameters
workerNodeKey: numberThe worker node key.
+
task: Task<Data>The task to execute.
+
Returns void
Inherited from AbstractPool.beforeTaskExecutionHook
Defined in src/pools/abstract-pool.ts:1070
Protected checkAndEmitDynamicWorkerCreationEvents
checkAndEmitDynamicWorkerCreationEvents(): void
Emits dynamic worker creation events.
+
Returns void
Overrides AbstractPool.checkAndEmitDynamicWorkerCreationEvents
Defined in src/pools/cluster/fixed.ts:98
Protected createAndSetupDynamicWorkerNode
createAndSetupDynamicWorkerNode(): number
Creates a new, completely set up dynamic worker node.
 
Returns number
New, completely set up dynamic worker node key.
-
Inherited from AbstractPool.createAndSetupDynamicWorkerNode
Defined in src/pools/abstract-pool.ts:1280
Protected createAndSetupWorkerNode
createAndSetupWorkerNode(): number
Creates a new, completely set up worker node.
+
Inherited from AbstractPool.createAndSetupDynamicWorkerNode
Defined in src/pools/abstract-pool.ts:1280
Protected createAndSetupWorkerNode
createAndSetupWorkerNode(): number
Creates a new, completely set up worker node.
 
Returns number
New, completely set up worker node key.
-
Inherited from AbstractPool.createAndSetupWorkerNode
Defined in src/pools/abstract-pool.ts:1223
Protected deregisterWorkerMessageListener
deregisterWorkerMessageListener<Message>(workerNodeKey, listener): 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) => void)
The message listener callback.
-
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Overrides AbstractPool.deregisterWorkerMessageListener
Defined in src/pools/cluster/fixed.ts:85
destroy
destroy(): Promise<void>
Terminates all workers in this pool.
-
Returns Promise<void>
Inherited from AbstractPool.destroy
Defined in src/pools/abstract-pool.ts:977
Protected destroyWorkerNode
destroyWorkerNode(workerNodeKey): Promise<void>
Terminates the worker node given its worker node key.
-
Parameters
workerNodeKey: number
The worker node key.
-
Returns Promise<void>
Inherited from AbstractPool.destroyWorkerNode
Defined in src/pools/abstract-pool.ts:1031
enableTasksQueue
enableTasksQueue(enable, tasksQueueOptions?): void
Enables/disables the worker node tasks queue in this pool.
-
Parameters
enable: boolean
Whether to enable or disable the worker node tasks queue.
-
Optional tasksQueueOptions: TasksQueueOptions
The worker node tasks queue options.
-
Returns void
Inherited from AbstractPool.enableTasksQueue
Defined in src/pools/abstract-pool.ts:563
execute
execute(data?, name?, transferList?): Promise<Response>
Executes the specified function in the worker constructor with the task data input parameter.
-
Parameters
Optional data: Data
The optional task input data for the specified task function. This can only be structured-cloneable data.
-
Optional name: string
The optional name of the task function to execute. If not specified, the default task function will be executed.
-
Optional transferList: TransferListItem[]
An 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 that will be fulfilled when the task is completed.
-
Inherited from AbstractPool.execute
Defined in src/pools/abstract-pool.ts:887
Protected flagWorkerNodeAsNotReady
flagWorkerNodeAsNotReady(workerNodeKey): void
Parameters
workerNodeKey: number
Returns void
Inherited from AbstractPool.flagWorkerNodeAsNotReady
Defined in src/pools/abstract-pool.ts:1890
Protected flushTasksQueue
flushTasksQueue(workerNodeKey): number
Parameters
workerNodeKey: number
Returns number
Inherited from AbstractPool.flushTasksQueue
Defined in src/pools/abstract-pool.ts:1932
Protected getWorkerInfo
getWorkerInfo(workerNodeKey): undefined | WorkerInfo
Gets the worker information given its worker node key.
-
Parameters
workerNodeKey: number
The worker node key.
+
Inherited from AbstractPool.createAndSetupWorkerNode
Defined in src/pools/abstract-pool.ts:1223
Protected deregisterWorkerMessageListener
deregisterWorkerMessageListener<Message>(workerNodeKey, listener): void
Deregisters a listener callback on the worker given its worker node key.
+
Type Parameters
Message
Parameters
workerNodeKey: numberThe worker node key.
+
listener: ((message) => void)The message listener callback.
+
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Overrides AbstractPool.deregisterWorkerMessageListener
Defined in src/pools/cluster/fixed.ts:85
destroy
destroy(): Promise<void>
Returns Promise<void>
Inherit Doc
Inherited from AbstractPool.destroy
Defined in src/pools/abstract-pool.ts:977
Protected destroyWorkerNode
destroyWorkerNode(workerNodeKey): Promise<void>
Terminates the worker node given its worker node key.
+
Parameters
workerNodeKey: numberThe worker node key.
+
Returns Promise<void>
Inherited from AbstractPool.destroyWorkerNode
Defined in src/pools/abstract-pool.ts:1031
enableTasksQueue
enableTasksQueue(enable, tasksQueueOptions?): void
Parameters
enable: boolean
Optional tasksQueueOptions: TasksQueueOptions
Returns void
Inherit Doc
Inherited from AbstractPool.enableTasksQueue
Defined in src/pools/abstract-pool.ts:563
execute
execute(data?, name?, transferList?): Promise<Response>
Parameters
Optional data: Data
Optional name: string
Optional transferList: TransferListItem[]
Returns Promise<Response>
Inherit Doc
Inherited from AbstractPool.execute
Defined in src/pools/abstract-pool.ts:887
Protected flagWorkerNodeAsNotReady
flagWorkerNodeAsNotReady(workerNodeKey): void
Parameters
workerNodeKey: number
Returns void
Inherited from AbstractPool.flagWorkerNodeAsNotReady
Defined in src/pools/abstract-pool.ts:1890
Protected flushTasksQueue
flushTasksQueue(workerNodeKey): number
Parameters
workerNodeKey: number
Returns number
Inherited from AbstractPool.flushTasksQueue
Defined in src/pools/abstract-pool.ts:1932
Protected getWorkerInfo
getWorkerInfo(workerNodeKey): undefined | WorkerInfo
Gets the worker information given its worker node key.
+
Parameters
workerNodeKey: numberThe worker node key.
 
Returns undefined | WorkerInfo
The worker information.
-
Inherited from AbstractPool.getWorkerInfo
Defined in src/pools/abstract-pool.ts:1823
hasTaskFunction
hasTaskFunction(name): boolean
Whether the specified task function exists in this pool.
-
Parameters
name: string
The name of the task function.
-
Returns boolean
true if the task function exists, false otherwise.
-
Inherited from AbstractPool.hasTaskFunction
Defined in src/pools/abstract-pool.ts:799
Protected internalBusy
internalBusy(): boolean
Whether worker nodes are executing concurrently their tasks quota or not.
+
Inherited from AbstractPool.getWorkerInfo
Defined in src/pools/abstract-pool.ts:1823
hasTaskFunction
hasTaskFunction(name): boolean
Parameters
name: string
Returns boolean
Inherit Doc
Inherited from AbstractPool.hasTaskFunction
Defined in src/pools/abstract-pool.ts:799
Protected internalBusy
internalBusy(): boolean
Whether worker nodes are executing concurrently their tasks quota or not.
 
Returns boolean
Worker nodes busyness boolean status.
-
Inherited from AbstractPool.internalBusy
Defined in src/pools/abstract-pool.ts:677
Protected isMain
isMain(): boolean
Should return whether the worker is the main worker or not.
-
Returns boolean
Overrides AbstractPool.isMain
Defined in src/pools/cluster/fixed.ts:46
listTaskFunctionNames
listTaskFunctionNames(): string[]
Lists the names of task function available in this pool.
-
Returns string[]
The names of task function available in this pool.
-
Inherited from AbstractPool.listTaskFunctionNames
Defined in src/pools/abstract-pool.ts:851
Protected registerOnceWorkerMessageListener
registerOnceWorkerMessageListener<Message>(workerNodeKey, listener): void
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) => void)
The message listener callback.
-
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Overrides AbstractPool.registerOnceWorkerMessageListener
Defined in src/pools/cluster/fixed.ts:77
Protected registerWorkerMessageListener
registerWorkerMessageListener<Message>(workerNodeKey, listener): 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) => void)
The message listener callback.
-
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Overrides AbstractPool.registerWorkerMessageListener
Defined in src/pools/cluster/fixed.ts:69
removeTaskFunction
removeTaskFunction(name): Promise<boolean>
Removes a task function from this pool.
-
Parameters
name: string
The name of the task function.
-
Returns Promise<boolean>
true if the task function was removed, false otherwise.
-
Inherited from AbstractPool.removeTaskFunction
Defined in src/pools/abstract-pool.ts:835
Protected sendStartupMessageToWorker
sendStartupMessageToWorker(workerNodeKey): void
Sends the startup message to worker given its worker node key.
-
Parameters
workerNodeKey: number
The worker node key.
-
Returns void
Overrides AbstractPool.sendStartupMessageToWorker
Defined in src/pools/cluster/fixed.ts:62
Protected sendToWorker
sendToWorker(workerNodeKey, message): void
Sends a message to worker given its worker node key.
-
Parameters
workerNodeKey: number
The worker node key.
-
message: MessageValue<Data, unknown>
The message.
-
Returns void
Overrides AbstractPool.sendToWorker
Defined in src/pools/cluster/fixed.ts:51
setDefaultTaskFunction
setDefaultTaskFunction(name): Promise<boolean>
Sets the default task function in this pool.
-
Parameters
name: string
The name of the task function.
-
Returns Promise<boolean>
true if the default task function was set, false otherwise.
-
Inherited from AbstractPool.setDefaultTaskFunction
Defined in src/pools/abstract-pool.ts:864
setTasksQueueOptions
setTasksQueueOptions(tasksQueueOptions): void
Sets the worker node tasks queue options in this pool.
-
Parameters
tasksQueueOptions: undefined | TasksQueueOptions
The worker node tasks queue options.
-
Returns void
Inherited from AbstractPool.setTasksQueueOptions
Defined in src/pools/abstract-pool.ts:577
setWorkerChoiceStrategy
setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void
Sets the worker choice strategy in this pool.
-
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
The worker choice strategy.
-
Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
The worker choice strategy options.
-
Returns void
Inherited from AbstractPool.setWorkerChoiceStrategy
Defined in src/pools/abstract-pool.ts:531
setWorkerChoiceStrategyOptions
setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void
Sets the worker choice strategy options in this pool.
-
Parameters
workerChoiceStrategyOptions: undefined | WorkerChoiceStrategyOptions
The worker choice strategy options.
-
Returns void
Inherited from AbstractPool.setWorkerChoiceStrategyOptions
Defined in src/pools/abstract-pool.ts:550
Protected setupHook
setupHook(): void
Setup hook to execute code before worker nodes are created in the abstract constructor.
+
Inherited from AbstractPool.internalBusy
Defined in src/pools/abstract-pool.ts:677
Protected isMain
isMain(): boolean
Should return whether the worker is the main worker or not.
+
Returns boolean
Overrides AbstractPool.isMain
Defined in src/pools/cluster/fixed.ts:46
listTaskFunctionNames
listTaskFunctionNames(): string[]
Returns string[]
Inherit Doc
Inherited from AbstractPool.listTaskFunctionNames
Defined in src/pools/abstract-pool.ts:851
Protected registerOnceWorkerMessageListener
registerOnceWorkerMessageListener<Message>(workerNodeKey, listener): void
Registers once a listener callback on the worker given its worker node key.
+
Type Parameters
Message
Parameters
workerNodeKey: numberThe worker node key.
+
listener: ((message) => void)The message listener callback.
+
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Overrides AbstractPool.registerOnceWorkerMessageListener
Defined in src/pools/cluster/fixed.ts:77
Protected registerWorkerMessageListener
registerWorkerMessageListener<Message>(workerNodeKey, listener): void
Registers a listener callback on the worker given its worker node key.
+
Type Parameters
Message
Parameters
workerNodeKey: numberThe worker node key.
+
listener: ((message) => void)The message listener callback.
+
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Overrides AbstractPool.registerWorkerMessageListener
Defined in src/pools/cluster/fixed.ts:69
removeTaskFunction
removeTaskFunction(name): Promise<boolean>
Parameters
name: string
Returns Promise<boolean>
Inherit Doc
Inherited from AbstractPool.removeTaskFunction
Defined in src/pools/abstract-pool.ts:835
Protected sendStartupMessageToWorker
sendStartupMessageToWorker(workerNodeKey): void
Sends the startup message to worker given its worker node key.
+
Parameters
workerNodeKey: numberThe worker node key.
+
Returns void
Overrides AbstractPool.sendStartupMessageToWorker
Defined in src/pools/cluster/fixed.ts:62
Protected sendToWorker
sendToWorker(workerNodeKey, message): void
Sends a message to worker given its worker node key.
+
Parameters
workerNodeKey: numberThe worker node key.
+
message: MessageValue<Data, unknown>The message.
+
Returns void
Overrides AbstractPool.sendToWorker
Defined in src/pools/cluster/fixed.ts:51
setDefaultTaskFunction
setDefaultTaskFunction(name): Promise<boolean>
Parameters
name: string
Returns Promise<boolean>
Inherit Doc
Inherited from AbstractPool.setDefaultTaskFunction
Defined in src/pools/abstract-pool.ts:864
setTasksQueueOptions
setTasksQueueOptions(tasksQueueOptions): void
Parameters
tasksQueueOptions: undefined | TasksQueueOptions
Returns void
Inherit Doc
Inherited from AbstractPool.setTasksQueueOptions
Defined in src/pools/abstract-pool.ts:577
setWorkerChoiceStrategy
setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
Returns void
Inherit Doc
Inherited from AbstractPool.setWorkerChoiceStrategy
Defined in src/pools/abstract-pool.ts:531
setWorkerChoiceStrategyOptions
setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void
Parameters
workerChoiceStrategyOptions: undefined | WorkerChoiceStrategyOptions
Returns void
Inherit Doc
Inherited from AbstractPool.setWorkerChoiceStrategyOptions
Defined in src/pools/abstract-pool.ts:550
Protected setupHook
setupHook(): void
Setup hook to execute code before worker nodes are created in the abstract constructor.
 Can be overridden.
-
Returns void
Overrides AbstractPool.setupHook
Defined in src/pools/cluster/fixed.ts:41
Protected shallCreateDynamicWorker
shallCreateDynamicWorker(): boolean
Conditions for dynamic worker creation.
+
Returns void
Overrides AbstractPool.setupHook
Defined in src/pools/cluster/fixed.ts:41
Protected shallCreateDynamicWorker
shallCreateDynamicWorker(): boolean
Conditions for dynamic worker creation.
 
Returns boolean
Whether to create a dynamic worker or not.
-
Overrides AbstractPool.shallCreateDynamicWorker
Defined in src/pools/cluster/fixed.ts:93
start
start(): void
Starts the minimum number of workers in this pool.
-
Returns void
Inherited from AbstractPool.start
Defined in src/pools/abstract-pool.ts:952
Protected Readonly workerMessageListener
workerMessageListener(message): void
This method is the message listener registered on each worker.
-
Parameters
message: MessageValue<Response, unknown>
Returns void
Inherited from AbstractPool.workerMessageListener
Defined in src/pools/abstract-pool.ts:1702
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
constructor
emitter
filePath
maximumNumberOfWorkers
minimumNumberOfWorkers
opts
promiseResponseMap
workerChoiceStrategyContext
workerNodes
busy
empty
full
info
ready
type
utilization
worker
addTaskFunction
afterTaskExecutionHook
afterWorkerNodeSetup
beforeTaskExecutionHook
checkAndEmitDynamicWorkerCreationEvents
createAndSetupDynamicWorkerNode
createAndSetupWorkerNode
deregisterWorkerMessageListener
destroy
destroyWorkerNode
enableTasksQueue
execute
flagWorkerNodeAsNotReady
flushTasksQueue
getWorkerInfo
hasTaskFunction
internalBusy
isMain
listTaskFunctionNames
registerOnceWorkerMessageListener
registerWorkerMessageListener
removeTaskFunction
sendStartupMessageToWorker
sendToWorker
setDefaultTaskFunction
setTasksQueueOptions
setWorkerChoiceStrategy
setWorkerChoiceStrategyOptions
setupHook
shallCreateDynamicWorker
start
workerMessageListener
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+
Overrides AbstractPool.shallCreateDynamicWorker
Defined in src/pools/cluster/fixed.ts:93
start
start(): void
Returns void
Inherit Doc
Inherited from AbstractPool.start
Defined in src/pools/abstract-pool.ts:952
Protected Readonly workerMessageListener
workerMessageListener(message): void
This method is the message listener registered on each worker.
+
Parameters
message: MessageValue<Response, unknown>
Returns void
Inherited from AbstractPool.workerMessageListener
Defined in src/pools/abstract-pool.ts:1702
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
constructor
emitter
filePath
maximumNumberOfWorkers
minimumNumberOfWorkers
opts
promiseResponseMap
workerChoiceStrategyContext
workerNodes
busy
empty
full
info
ready
type
utilization
worker
addTaskFunction
afterTaskExecutionHook
afterWorkerNodeSetup
beforeTaskExecutionHook
checkAndEmitDynamicWorkerCreationEvents
createAndSetupDynamicWorkerNode
createAndSetupWorkerNode
deregisterWorkerMessageListener
destroy
destroyWorkerNode
enableTasksQueue
execute
flagWorkerNodeAsNotReady
flushTasksQueue
getWorkerInfo
hasTaskFunction
internalBusy
isMain
listTaskFunctionNames
registerOnceWorkerMessageListener
registerWorkerMessageListener
removeTaskFunction
sendStartupMessageToWorker
sendToWorker
setDefaultTaskFunction
setTasksQueueOptions
setWorkerChoiceStrategy
setWorkerChoiceStrategyOptions
setupHook
shallCreateDynamicWorker
start
workerMessageListener
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html
index 0ef1362e..2413fd7b 100644
--- a/docs/classes/FixedThreadPool.html
+++ b/docs/classes/FixedThreadPool.html
@@ -1,62 +1,62 @@
-FixedThreadPool | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
FixedThreadPool
Class FixedThreadPool<Data, Response>
A thread pool with a fixed number of threads.
+FixedThreadPool | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
FixedThreadPool
Class FixedThreadPool<Data, Response>
A thread pool with a fixed number of threads.
 
Author
Alessandro Pio Ardizio
 Since
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 full)
AbstractPool<Worker, Data, Response>FixedThreadPoolDynamicThreadPool
Defined in src/pools/thread/fixed.ts:24
 Index
Constructors
constructor
-
Properties
emitter?
-filePath
-maximumNumberOfWorkers?
-minimumNumberOfWorkers
-opts
-promiseResponseMap
-workerChoiceStrategyContext?
-workerNodes
-
Accessors
busy
-empty
-full
-info
-ready
-type
-utilization
-worker
-
Methods
addTaskFunction
-afterTaskExecutionHook
-afterWorkerNodeSetup
-beforeTaskExecutionHook
-checkAndEmitDynamicWorkerCreationEvents
-createAndSetupDynamicWorkerNode
-createAndSetupWorkerNode
-deregisterWorkerMessageListener
-destroy
-destroyWorkerNode
-enableTasksQueue
-execute
-flagWorkerNodeAsNotReady
-flushTasksQueue
-getWorkerInfo
-hasTaskFunction
-internalBusy
-isMain
-listTaskFunctionNames
-registerOnceWorkerMessageListener
-registerWorkerMessageListener
-removeTaskFunction
-sendStartupMessageToWorker
-sendToWorker
-setDefaultTaskFunction
-setTasksQueueOptions
-setWorkerChoiceStrategy
-setWorkerChoiceStrategyOptions
-setupHook
-shallCreateDynamicWorker
-start
-workerMessageListener
-
Constructors
constructor
new FixedThreadPool<Data, Response>(numberOfThreads, filePath, opts?, maximumNumberOfThreads?): FixedThreadPool<Data, Response>
Constructs a new poolifier fixed thread pool.
-
Type Parameters
Data = unknown
Response = unknown
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.
-
Optional maximumNumberOfThreads: number
Returns FixedThreadPool<Data, Response>
Overrides AbstractPool.constructor
Defined in src/pools/thread/fixed.ts:35
Properties
Optional emitter
emitter?: EventEmitterAsyncResource
Event emitter integrated with async resource on which events can be listened to.
+
 Type Parameters
Data = unknownType of data sent to the worker. This can only be structured-cloneable data.
+
Response = unknownType of execution response. This can only be structured-cloneable data.
+
 Hierarchy (view full)
AbstractPool<Worker, Data, Response>FixedThreadPoolDynamicThreadPool
Defined in src/pools/thread/fixed.ts:24
 Index
Constructors
constructor
+
Properties
emitter?
+filePath
+maximumNumberOfWorkers?
+minimumNumberOfWorkers
+opts
+promiseResponseMap
+workerChoiceStrategyContext?
+workerNodes
+
Accessors
busy
+empty
+full
+info
+ready
+type
+utilization
+worker
+
Methods
addTaskFunction
+afterTaskExecutionHook
+afterWorkerNodeSetup
+beforeTaskExecutionHook
+checkAndEmitDynamicWorkerCreationEvents
+createAndSetupDynamicWorkerNode
+createAndSetupWorkerNode
+deregisterWorkerMessageListener
+destroy
+destroyWorkerNode
+enableTasksQueue
+execute
+flagWorkerNodeAsNotReady
+flushTasksQueue
+getWorkerInfo
+hasTaskFunction
+internalBusy
+isMain
+listTaskFunctionNames
+registerOnceWorkerMessageListener
+registerWorkerMessageListener
+removeTaskFunction
+sendStartupMessageToWorker
+sendToWorker
+setDefaultTaskFunction
+setTasksQueueOptions
+setWorkerChoiceStrategy
+setWorkerChoiceStrategyOptions
+setupHook
+shallCreateDynamicWorker
+start
+workerMessageListener
+
Constructors
constructor
new FixedThreadPool<Data, Response>(numberOfThreads, filePath, opts?, maximumNumberOfThreads?): FixedThreadPool<Data, Response>
Constructs a new poolifier fixed thread pool.
+
Type Parameters
Data = unknown
Response = unknown
Parameters
numberOfThreads: numberNumber of threads for this pool.
+
filePath: stringPath to an implementation of a ThreadWorker file, which can be relative or absolute.
+
opts: ThreadPoolOptions = {}Options for this fixed thread pool.
+
Optional maximumNumberOfThreads: number
Returns FixedThreadPool<Data, Response>
Overrides AbstractPool.constructor
Defined in src/pools/thread/fixed.ts:35
Properties
Optional emitter
emitter?: EventEmitterAsyncResource
Event emitter integrated with async resource on which events can be listened to.
 The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.
 Events that can currently be listened to:
 
@@ -69,107 +69,72 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
 'taskError': Emitted when an error occurs while executing a task.
 'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
 

-
Inherited from AbstractPool.emitter
Defined in src/pools/abstract-pool.ts:79
Protected Readonly filePath
filePath: string
Path to the worker file.
-
Inherited from AbstractPool.filePath
Defined in src/pools/abstract-pool.ts:138
Protected Optional Readonly maximumNumberOfWorkers
maximumNumberOfWorkers?: number
Maximum number of workers that this pool manages.
-
Inherited from AbstractPool.maximumNumberOfWorkers
Defined in src/pools/abstract-pool.ts:140
Protected Readonly minimumNumberOfWorkers
minimumNumberOfWorkers: number
Minimum number of workers that this pool manages.
-
Inherited from AbstractPool.minimumNumberOfWorkers
Defined in src/pools/abstract-pool.ts:137
Protected Readonly opts
opts: PoolOptions<Worker>
Options for the pool.
-
Inherited from AbstractPool.opts
Defined in src/pools/abstract-pool.ts:139
Protected promiseResponseMap
promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
The task execution response promise map:
+
Inherited from AbstractPool.emitter
Defined in src/pools/abstract-pool.ts:79
Protected Readonly filePath
filePath: string
Path to the worker file.
+
Inherited from AbstractPool.filePath
Defined in src/pools/abstract-pool.ts:138
Protected Optional Readonly maximumNumberOfWorkers
maximumNumberOfWorkers?: number
Maximum number of workers that this pool manages.
+
Inherited from AbstractPool.maximumNumberOfWorkers
Defined in src/pools/abstract-pool.ts:140
Protected Readonly minimumNumberOfWorkers
minimumNumberOfWorkers: number
Minimum number of workers that this pool manages.
+
Inherited from AbstractPool.minimumNumberOfWorkers
Defined in src/pools/abstract-pool.ts:137
Protected Readonly opts
opts: PoolOptions<Worker>
Options for the pool.
+
Inherited from AbstractPool.opts
Defined in src/pools/abstract-pool.ts:139
Protected promiseResponseMap
promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
The task execution response promise map:
 
 key: The message id of each submitted task.
 value: An object that contains the worker, the execution response promise resolve and reject callbacks.
 
 When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
-
Inherited from AbstractPool.promiseResponseMap
Defined in src/pools/abstract-pool.ts:88
Protected Optional workerChoiceStrategyContext
workerChoiceStrategyContext?: WorkerChoiceStrategyContext<Worker, Data, Response>
Worker choice strategy context referencing a worker choice algorithm implementation.
-
Inherited from AbstractPool.workerChoiceStrategyContext
Defined in src/pools/abstract-pool.ts:94
Readonly Internal workerNodes
workerNodes: IWorkerNode<Worker, Data>[] = []
Pool worker nodes.
-
Inherited from AbstractPool.workerNodes
Defined in src/pools/abstract-pool.ts:76
Accessors
Protected busy
get busy(): boolean
Whether the pool is busy or not.
+
Inherited from AbstractPool.promiseResponseMap
Defined in src/pools/abstract-pool.ts:88
Protected Optional workerChoiceStrategyContext
workerChoiceStrategyContext?: WorkerChoiceStrategyContext<Worker, Data, Response>
Worker choice strategy context referencing a worker choice algorithm implementation.
+
Inherited from AbstractPool.workerChoiceStrategyContext
Defined in src/pools/abstract-pool.ts:94
Readonly Internal workerNodes
workerNodes: IWorkerNode<Worker, Data>[] = []
Pool worker nodes.
+
Inherited from AbstractPool.workerNodes
Defined in src/pools/abstract-pool.ts:76
Accessors
Protected busy
get busy(): boolean
Whether the pool is busy or not.
 The pool busyness boolean status.
-
Returns boolean
Overrides AbstractPool.busy
Defined in src/pools/thread/fixed.ts:133
Protected empty
get empty(): boolean
The pool emptiness boolean status.
-
Returns boolean
Inherited from AbstractPool.empty
Defined in src/pools/abstract-pool.ts:464
Protected full
get full(): boolean
Whether the pool is full or not.
+
Returns boolean
Overrides AbstractPool.busy
Defined in src/pools/thread/fixed.ts:133
Protected empty
get empty(): boolean
The pool emptiness boolean status.
+
Returns boolean
Inherited from AbstractPool.empty
Defined in src/pools/abstract-pool.ts:464
Protected full
get full(): boolean
Whether the pool is full or not.
 The pool filling boolean status.
-
Returns boolean
Inherited from AbstractPool.full
Defined in src/pools/abstract-pool.ts:658
info
get info(): PoolInfo
Pool information.
-
Returns PoolInfo
Inherited from AbstractPool.info
Defined in src/pools/abstract-pool.ts:277
Private ready
get ready(): boolean
The pool readiness boolean status.
-
Returns boolean
Inherited from AbstractPool.ready
Defined in src/pools/abstract-pool.ts:446
Protected type
get type(): "fixed" | "dynamic"
The pool type.
+
Returns boolean
Inherited from AbstractPool.full
Defined in src/pools/abstract-pool.ts:658
info
get info(): PoolInfo
Pool information.
+
Returns PoolInfo
Inherited from AbstractPool.info
Defined in src/pools/abstract-pool.ts:277
Private ready
get ready(): boolean
The pool readiness boolean status.
+
Returns boolean
Inherited from AbstractPool.ready
Defined in src/pools/abstract-pool.ts:446
Protected type
get type(): "fixed" | "dynamic"
The pool type.
 If it is 'dynamic', it provides the max property.
-
Returns "fixed" | "dynamic"
Overrides AbstractPool.type
Defined in src/pools/thread/fixed.ts:123
Private utilization
get utilization(): number
The approximate pool utilization.
+
Returns "fixed" | "dynamic"
Overrides AbstractPool.type
Defined in src/pools/thread/fixed.ts:123
Private utilization
get utilization(): number
The approximate pool utilization.
 
Returns number
The pool utilization.
-
Inherited from AbstractPool.utilization
Defined in src/pools/abstract-pool.ts:473
Protected worker
get worker(): "thread" | "cluster"
The worker type.
-
Returns "thread" | "cluster"
Overrides AbstractPool.worker
Defined in src/pools/thread/fixed.ts:128
Methods
addTaskFunction
addTaskFunction(name, fn): Promise<boolean>
Adds a task function to this pool.
-If a task function with the same name already exists, it will be overwritten.
-
Parameters
name: string
The name of the task function.
-
fn: TaskFunction<Data, Response>
The task function.
-
Returns Promise<boolean>
true if the task function was added, false otherwise.
-Throws
https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.
-Throws
https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.
-
Inherited from AbstractPool.addTaskFunction
Defined in src/pools/abstract-pool.ts:812
Protected afterTaskExecutionHook
afterTaskExecutionHook(workerNodeKey, message): void
Hook executed after the worker task execution.
+
Inherited from AbstractPool.utilization
Defined in src/pools/abstract-pool.ts:473
Protected worker
get worker(): "thread" | "cluster"
The worker type.
+
Returns "thread" | "cluster"
Overrides AbstractPool.worker
Defined in src/pools/thread/fixed.ts:128
Methods
addTaskFunction
addTaskFunction(name, fn): Promise<boolean>
Parameters
name: string
fn: TaskFunction<Data, Response>
Returns Promise<boolean>
Inherit Doc
Inherited from AbstractPool.addTaskFunction
Defined in src/pools/abstract-pool.ts:812
Protected afterTaskExecutionHook
afterTaskExecutionHook(workerNodeKey, message): void
Hook executed after the worker task execution.
 Can be overridden.
-
Parameters
workerNodeKey: number
The worker node key.
-
message: MessageValue<Response, unknown>
The received message.
-
Returns void
Inherited from AbstractPool.afterTaskExecutionHook
Defined in src/pools/abstract-pool.ts:1111
Protected afterWorkerNodeSetup
afterWorkerNodeSetup(workerNodeKey): void
Method hooked up after a worker node has been newly created.
+
Parameters
workerNodeKey: numberThe worker node key.
+
message: MessageValue<Response, unknown>The received message.
+
Returns void
Inherited from AbstractPool.afterTaskExecutionHook
Defined in src/pools/abstract-pool.ts:1111
Protected afterWorkerNodeSetup
afterWorkerNodeSetup(workerNodeKey): 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
Inherited from AbstractPool.afterWorkerNodeSetup
Defined in src/pools/abstract-pool.ts:1378
Protected beforeTaskExecutionHook
beforeTaskExecutionHook(workerNodeKey, task): void
Hook executed before the worker task execution.
+
Parameters
workerNodeKey: numberThe newly created worker node key.
+
Returns void
Inherited from AbstractPool.afterWorkerNodeSetup
Defined in src/pools/abstract-pool.ts:1378
Protected beforeTaskExecutionHook
beforeTaskExecutionHook(workerNodeKey, task): 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
Inherited from AbstractPool.beforeTaskExecutionHook
Defined in src/pools/abstract-pool.ts:1070
Protected checkAndEmitDynamicWorkerCreationEvents
checkAndEmitDynamicWorkerCreationEvents(): void
Emits dynamic worker creation events.
-
Returns void
Overrides AbstractPool.checkAndEmitDynamicWorkerCreationEvents
Defined in src/pools/thread/fixed.ts:118
Protected createAndSetupDynamicWorkerNode
createAndSetupDynamicWorkerNode(): number
Creates a new, completely set up dynamic worker node.
+
Parameters
workerNodeKey: numberThe worker node key.
+
task: Task<Data>The task to execute.
+
Returns void
Inherited from AbstractPool.beforeTaskExecutionHook
Defined in src/pools/abstract-pool.ts:1070
Protected checkAndEmitDynamicWorkerCreationEvents
checkAndEmitDynamicWorkerCreationEvents(): void
Emits dynamic worker creation events.
+
Returns void
Overrides AbstractPool.checkAndEmitDynamicWorkerCreationEvents
Defined in src/pools/thread/fixed.ts:118
Protected createAndSetupDynamicWorkerNode
createAndSetupDynamicWorkerNode(): number
Creates a new, completely set up dynamic worker node.
 
Returns number
New, completely set up dynamic worker node key.
-
Inherited from AbstractPool.createAndSetupDynamicWorkerNode
Defined in src/pools/abstract-pool.ts:1280
Protected createAndSetupWorkerNode
createAndSetupWorkerNode(): number
Creates a new, completely set up worker node.
+
Inherited from AbstractPool.createAndSetupDynamicWorkerNode
Defined in src/pools/abstract-pool.ts:1280
Protected createAndSetupWorkerNode
createAndSetupWorkerNode(): number
Creates a new, completely set up worker node.
 
Returns number
New, completely set up worker node key.
-
Inherited from AbstractPool.createAndSetupWorkerNode
Defined in src/pools/abstract-pool.ts:1223
Protected deregisterWorkerMessageListener
deregisterWorkerMessageListener<Message>(workerNodeKey, listener): 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) => void)
The message listener callback.
-
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Overrides AbstractPool.deregisterWorkerMessageListener
Defined in src/pools/thread/fixed.ts:102
destroy
destroy(): Promise<void>
Terminates all workers in this pool.
-
Returns Promise<void>
Inherited from AbstractPool.destroy
Defined in src/pools/abstract-pool.ts:977
Protected destroyWorkerNode
destroyWorkerNode(workerNodeKey): Promise<void>
Terminates the worker node given its worker node key.
-
Parameters
workerNodeKey: number
The worker node key.
-
Returns Promise<void>
Inherited from AbstractPool.destroyWorkerNode
Defined in src/pools/abstract-pool.ts:1031
enableTasksQueue
enableTasksQueue(enable, tasksQueueOptions?): void
Enables/disables the worker node tasks queue in this pool.
-
Parameters
enable: boolean
Whether to enable or disable the worker node tasks queue.
-
Optional tasksQueueOptions: TasksQueueOptions
The worker node tasks queue options.
-
Returns void
Inherited from AbstractPool.enableTasksQueue
Defined in src/pools/abstract-pool.ts:563
execute
execute(data?, name?, transferList?): Promise<Response>
Executes the specified function in the worker constructor with the task data input parameter.
-
Parameters
Optional data: Data
The optional task input data for the specified task function. This can only be structured-cloneable data.
-
Optional name: string
The optional name of the task function to execute. If not specified, the default task function will be executed.
-
Optional transferList: TransferListItem[]
An 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 that will be fulfilled when the task is completed.
-
Inherited from AbstractPool.execute
Defined in src/pools/abstract-pool.ts:887
Protected flagWorkerNodeAsNotReady
flagWorkerNodeAsNotReady(workerNodeKey): void
Parameters
workerNodeKey: number
Returns void
Inherited from AbstractPool.flagWorkerNodeAsNotReady
Defined in src/pools/abstract-pool.ts:1890
Protected flushTasksQueue
flushTasksQueue(workerNodeKey): number
Parameters
workerNodeKey: number
Returns number
Inherited from AbstractPool.flushTasksQueue
Defined in src/pools/abstract-pool.ts:1932
Protected getWorkerInfo
getWorkerInfo(workerNodeKey): undefined | WorkerInfo
Gets the worker information given its worker node key.
-
Parameters
workerNodeKey: number
The worker node key.
+
Inherited from AbstractPool.createAndSetupWorkerNode
Defined in src/pools/abstract-pool.ts:1223
Protected deregisterWorkerMessageListener
deregisterWorkerMessageListener<Message>(workerNodeKey, listener): void
Deregisters a listener callback on the worker given its worker node key.
+
Type Parameters
Message
Parameters
workerNodeKey: numberThe worker node key.
+
listener: ((message) => void)The message listener callback.
+
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Overrides AbstractPool.deregisterWorkerMessageListener
Defined in src/pools/thread/fixed.ts:102
destroy
destroy(): Promise<void>
Returns Promise<void>
Inherit Doc
Inherited from AbstractPool.destroy
Defined in src/pools/abstract-pool.ts:977
Protected destroyWorkerNode
destroyWorkerNode(workerNodeKey): Promise<void>
Terminates the worker node given its worker node key.
+
Parameters
workerNodeKey: numberThe worker node key.
+
Returns Promise<void>
Inherited from AbstractPool.destroyWorkerNode
Defined in src/pools/abstract-pool.ts:1031
enableTasksQueue
enableTasksQueue(enable, tasksQueueOptions?): void
Parameters
enable: boolean
Optional tasksQueueOptions: TasksQueueOptions
Returns void
Inherit Doc
Inherited from AbstractPool.enableTasksQueue
Defined in src/pools/abstract-pool.ts:563
execute
execute(data?, name?, transferList?): Promise<Response>
Parameters
Optional data: Data
Optional name: string
Optional transferList: TransferListItem[]
Returns Promise<Response>
Inherit Doc
Inherited from AbstractPool.execute
Defined in src/pools/abstract-pool.ts:887
Protected flagWorkerNodeAsNotReady
flagWorkerNodeAsNotReady(workerNodeKey): void
Parameters
workerNodeKey: number
Returns void
Inherited from AbstractPool.flagWorkerNodeAsNotReady
Defined in src/pools/abstract-pool.ts:1890
Protected flushTasksQueue
flushTasksQueue(workerNodeKey): number
Parameters
workerNodeKey: number
Returns number
Inherited from AbstractPool.flushTasksQueue
Defined in src/pools/abstract-pool.ts:1932
Protected getWorkerInfo
getWorkerInfo(workerNodeKey): undefined | WorkerInfo
Gets the worker information given its worker node key.
+
Parameters
workerNodeKey: numberThe worker node key.
 
Returns undefined | WorkerInfo
The worker information.
-
Inherited from AbstractPool.getWorkerInfo
Defined in src/pools/abstract-pool.ts:1823
hasTaskFunction
hasTaskFunction(name): boolean
Whether the specified task function exists in this pool.
-
Parameters
name: string
The name of the task function.
-
Returns boolean
true if the task function exists, false otherwise.
-
Inherited from AbstractPool.hasTaskFunction
Defined in src/pools/abstract-pool.ts:799
Protected internalBusy
internalBusy(): boolean
Whether worker nodes are executing concurrently their tasks quota or not.
+
Inherited from AbstractPool.getWorkerInfo
Defined in src/pools/abstract-pool.ts:1823
hasTaskFunction
hasTaskFunction(name): boolean
Parameters
name: string
Returns boolean
Inherit Doc
Inherited from AbstractPool.hasTaskFunction
Defined in src/pools/abstract-pool.ts:799
Protected internalBusy
internalBusy(): boolean
Whether worker nodes are executing concurrently their tasks quota or not.
 
Returns boolean
Worker nodes busyness boolean status.
-
Inherited from AbstractPool.internalBusy
Defined in src/pools/abstract-pool.ts:677
Protected isMain
isMain(): boolean
Should return whether the worker is the main worker or not.
-
Returns boolean
Overrides AbstractPool.isMain
Defined in src/pools/thread/fixed.ts:45
listTaskFunctionNames
listTaskFunctionNames(): string[]
Lists the names of task function available in this pool.
-
Returns string[]
The names of task function available in this pool.
-
Inherited from AbstractPool.listTaskFunctionNames
Defined in src/pools/abstract-pool.ts:851
Protected registerOnceWorkerMessageListener
registerOnceWorkerMessageListener<Message>(workerNodeKey, listener): void
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) => void)
The message listener callback.
-
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Overrides AbstractPool.registerOnceWorkerMessageListener
Defined in src/pools/thread/fixed.ts:91
Protected registerWorkerMessageListener
registerWorkerMessageListener<Message>(workerNodeKey, listener): 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) => void)
The message listener callback.
-
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Overrides AbstractPool.registerWorkerMessageListener
Defined in src/pools/thread/fixed.ts:80
removeTaskFunction
removeTaskFunction(name): Promise<boolean>
Removes a task function from this pool.
-
Parameters
name: string
The name of the task function.
-
Returns Promise<boolean>
true if the task function was removed, false otherwise.
-
Inherited from AbstractPool.removeTaskFunction
Defined in src/pools/abstract-pool.ts:835
Protected sendStartupMessageToWorker
sendStartupMessageToWorker(workerNodeKey): void
Sends the startup message to worker given its worker node key.
-
Parameters
workerNodeKey: number
The worker node key.
-
Returns void
Overrides AbstractPool.sendStartupMessageToWorker
Defined in src/pools/thread/fixed.ts:65
Protected sendToWorker
sendToWorker(workerNodeKey, message, transferList?): void
Sends a message to worker given its worker node key.
-
Parameters
workerNodeKey: number
The worker node key.
-
message: MessageValue<Data, unknown>
The message.
-
Optional transferList: TransferListItem[]
The optional array of transferable objects.
-
Returns void
Overrides AbstractPool.sendToWorker
Defined in src/pools/thread/fixed.ts:50
setDefaultTaskFunction
setDefaultTaskFunction(name): Promise<boolean>
Sets the default task function in this pool.
-
Parameters
name: string
The name of the task function.
-
Returns Promise<boolean>
true if the default task function was set, false otherwise.
-
Inherited from AbstractPool.setDefaultTaskFunction
Defined in src/pools/abstract-pool.ts:864
setTasksQueueOptions
setTasksQueueOptions(tasksQueueOptions): void
Sets the worker node tasks queue options in this pool.
-
Parameters
tasksQueueOptions: undefined | TasksQueueOptions
The worker node tasks queue options.
-
Returns void
Inherited from AbstractPool.setTasksQueueOptions
Defined in src/pools/abstract-pool.ts:577
setWorkerChoiceStrategy
setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void
Sets the worker choice strategy in this pool.
-
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
The worker choice strategy.
-
Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
The worker choice strategy options.
-
Returns void
Inherited from AbstractPool.setWorkerChoiceStrategy
Defined in src/pools/abstract-pool.ts:531
setWorkerChoiceStrategyOptions
setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void
Sets the worker choice strategy options in this pool.
-
Parameters
workerChoiceStrategyOptions: undefined | WorkerChoiceStrategyOptions
The worker choice strategy options.
-
Returns void
Inherited from AbstractPool.setWorkerChoiceStrategyOptions
Defined in src/pools/abstract-pool.ts:550
Protected setupHook
setupHook(): void
Setup hook to execute code before worker nodes are created in the abstract constructor.
+
Inherited from AbstractPool.internalBusy
Defined in src/pools/abstract-pool.ts:677
Protected isMain
isMain(): boolean
Should return whether the worker is the main worker or not.
+
Returns boolean
Overrides AbstractPool.isMain
Defined in src/pools/thread/fixed.ts:45
listTaskFunctionNames
listTaskFunctionNames(): string[]
Returns string[]
Inherit Doc
Inherited from AbstractPool.listTaskFunctionNames
Defined in src/pools/abstract-pool.ts:851
Protected registerOnceWorkerMessageListener
registerOnceWorkerMessageListener<Message>(workerNodeKey, listener): void
Registers once a listener callback on the worker given its worker node key.
+
Type Parameters
Message
Parameters
workerNodeKey: numberThe worker node key.
+
listener: ((message) => void)The message listener callback.
+
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Overrides AbstractPool.registerOnceWorkerMessageListener
Defined in src/pools/thread/fixed.ts:91
Protected registerWorkerMessageListener
registerWorkerMessageListener<Message>(workerNodeKey, listener): void
Registers a listener callback on the worker given its worker node key.
+
Type Parameters
Message
Parameters
workerNodeKey: numberThe worker node key.
+
listener: ((message) => void)The message listener callback.
+
(message): void
Parameters
message: MessageValue<Message, unknown>
Returns void
Returns void
Overrides AbstractPool.registerWorkerMessageListener
Defined in src/pools/thread/fixed.ts:80
removeTaskFunction
removeTaskFunction(name): Promise<boolean>
Parameters
name: string
Returns Promise<boolean>
Inherit Doc
Inherited from AbstractPool.removeTaskFunction
Defined in src/pools/abstract-pool.ts:835
Protected sendStartupMessageToWorker
sendStartupMessageToWorker(workerNodeKey): void
Sends the startup message to worker given its worker node key.
+
Parameters
workerNodeKey: numberThe worker node key.
+
Returns void
Overrides AbstractPool.sendStartupMessageToWorker
Defined in src/pools/thread/fixed.ts:65
Protected sendToWorker
sendToWorker(workerNodeKey, message, transferList?): void
Sends a message to worker given its worker node key.
+
Parameters
workerNodeKey: numberThe worker node key.
+
message: MessageValue<Data, unknown>The message.
+
Optional transferList: TransferListItem[]The optional array of transferable objects.
+
Returns void
Overrides AbstractPool.sendToWorker
Defined in src/pools/thread/fixed.ts:50
setDefaultTaskFunction
setDefaultTaskFunction(name): Promise<boolean>
Parameters
name: string
Returns Promise<boolean>
Inherit Doc
Inherited from AbstractPool.setDefaultTaskFunction
Defined in src/pools/abstract-pool.ts:864
setTasksQueueOptions
setTasksQueueOptions(tasksQueueOptions): void
Parameters
tasksQueueOptions: undefined | TasksQueueOptions
Returns void
Inherit Doc
Inherited from AbstractPool.setTasksQueueOptions
Defined in src/pools/abstract-pool.ts:577
setWorkerChoiceStrategy
setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
Returns void
Inherit Doc
Inherited from AbstractPool.setWorkerChoiceStrategy
Defined in src/pools/abstract-pool.ts:531
setWorkerChoiceStrategyOptions
setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void
Parameters
workerChoiceStrategyOptions: undefined | WorkerChoiceStrategyOptions
Returns void
Inherit Doc
Inherited from AbstractPool.setWorkerChoiceStrategyOptions
Defined in src/pools/abstract-pool.ts:550
Protected setupHook
setupHook(): void
Setup hook to execute code before worker nodes are created in the abstract constructor.
 Can be overridden.
-
Returns void
Inherited from AbstractPool.setupHook
Defined in src/pools/abstract-pool.ts:1054
Protected shallCreateDynamicWorker
shallCreateDynamicWorker(): boolean
Conditions for dynamic worker creation.
+
Returns void
Inherited from AbstractPool.setupHook
Defined in src/pools/abstract-pool.ts:1054
Protected shallCreateDynamicWorker
shallCreateDynamicWorker(): boolean
Conditions for dynamic worker creation.
 
Returns boolean
Whether to create a dynamic worker or not.
-
Overrides AbstractPool.shallCreateDynamicWorker
Defined in src/pools/thread/fixed.ts:113
start
start(): void
Starts the minimum number of workers in this pool.
-
Returns void
Inherited from AbstractPool.start
Defined in src/pools/abstract-pool.ts:952
Protected Readonly workerMessageListener
workerMessageListener(message): void
This method is the message listener registered on each worker.
-
Parameters
message: MessageValue<Response, unknown>
Returns void
Inherited from AbstractPool.workerMessageListener
Defined in src/pools/abstract-pool.ts:1702
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
constructor
emitter
filePath
maximumNumberOfWorkers
minimumNumberOfWorkers
opts
promiseResponseMap
workerChoiceStrategyContext
workerNodes
busy
empty
full
info
ready
type
utilization
worker
addTaskFunction
afterTaskExecutionHook
afterWorkerNodeSetup
beforeTaskExecutionHook
checkAndEmitDynamicWorkerCreationEvents
createAndSetupDynamicWorkerNode
createAndSetupWorkerNode
deregisterWorkerMessageListener
destroy
destroyWorkerNode
enableTasksQueue
execute
flagWorkerNodeAsNotReady
flushTasksQueue
getWorkerInfo
hasTaskFunction
internalBusy
isMain
listTaskFunctionNames
registerOnceWorkerMessageListener
registerWorkerMessageListener
removeTaskFunction
sendStartupMessageToWorker
sendToWorker
setDefaultTaskFunction
setTasksQueueOptions
setWorkerChoiceStrategy
setWorkerChoiceStrategyOptions
setupHook
shallCreateDynamicWorker
start
workerMessageListener
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+
Overrides AbstractPool.shallCreateDynamicWorker
Defined in src/pools/thread/fixed.ts:113
start
start(): void
Returns void
Inherit Doc
Inherited from AbstractPool.start
Defined in src/pools/abstract-pool.ts:952
Protected Readonly workerMessageListener
workerMessageListener(message): void
This method is the message listener registered on each worker.
+
Parameters
message: MessageValue<Response, unknown>
Returns void
Inherited from AbstractPool.workerMessageListener
Defined in src/pools/abstract-pool.ts:1702
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
constructor
emitter
filePath
maximumNumberOfWorkers
minimumNumberOfWorkers
opts
promiseResponseMap
workerChoiceStrategyContext
workerNodes
busy
empty
full
info
ready
type
utilization
worker
addTaskFunction
afterTaskExecutionHook
afterWorkerNodeSetup
beforeTaskExecutionHook
checkAndEmitDynamicWorkerCreationEvents
createAndSetupDynamicWorkerNode
createAndSetupWorkerNode
deregisterWorkerMessageListener
destroy
destroyWorkerNode
enableTasksQueue
execute
flagWorkerNodeAsNotReady
flushTasksQueue
getWorkerInfo
hasTaskFunction
internalBusy
isMain
listTaskFunctionNames
registerOnceWorkerMessageListener
registerWorkerMessageListener
removeTaskFunction
sendStartupMessageToWorker
sendToWorker
setDefaultTaskFunction
setTasksQueueOptions
setWorkerChoiceStrategy
setWorkerChoiceStrategyOptions
setupHook
shallCreateDynamicWorker
start
workerMessageListener
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html
index fc092ca1..ad62d1c2 100644
--- a/docs/classes/ThreadWorker.html
+++ b/docs/classes/ThreadWorker.html
@@ -1,84 +1,84 @@
-ThreadWorker | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
ThreadWorker
Class ThreadWorker<Data, Response>
A thread worker used by a poolifier ThreadPool.
+ThreadWorker | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
ThreadWorker
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.
 
Author
Alessandro Pio Ardizio
 Since
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 full)
AbstractWorker<MessagePort, Data, Response>ThreadWorker
Defined in src/worker/thread-worker.ts:26
 Index
Constructors
constructor
-
Properties
activeInterval?
-isMain
-lastTaskTimestamp
-opts
-port?
-statistics?
-taskFunctions
-
Accessors
id
-
Methods
addTaskFunction
-getMainWorker
-handleError
-handleKillMessage
-handleReadyMessage
-handleTaskFunctionOperationMessage
-hasTaskFunction
-listTaskFunctionNames
-messageListener
-removeTaskFunction
-run
-runAsync
-runSync
-sendTaskFunctionNamesToMainWorker
-sendToMainWorker
-setDefaultTaskFunction
-
Constructors
constructor
new ThreadWorker<Data, Response>(taskFunctions, opts?): ThreadWorker<Data, Response>
Constructs a new poolifier thread worker.
-
Type Parameters
Data = unknown
Response = unknown
Parameters
taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>
Task function(s) processed by the worker when the pool's execution function is invoked.
-
opts: WorkerOptions = {}
Options for the worker.
-
Returns ThreadWorker<Data, Response>
Overrides AbstractWorker.constructor
Defined in src/worker/thread-worker.ts:41
Properties
Protected Optional activeInterval
activeInterval?: Timeout
Handler id of the activeInterval worker activity check.
-
Inherited from AbstractWorker.activeInterval
Defined in src/worker/abstract-worker.ts:78
Protected Readonly isMain
isMain: undefined | boolean
Whether this is the main worker or not.
-
Inherited from AbstractWorker.isMain
Defined in src/worker/abstract-worker.ts:89
Protected lastTaskTimestamp
lastTaskTimestamp: number
Timestamp of the last task processed by this worker.
-
Inherited from AbstractWorker.lastTaskTimestamp
Defined in src/worker/abstract-worker.ts:70
Protected opts
opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
Options for the worker.
-
Inherited from AbstractWorker.opts
Defined in src/worker/abstract-worker.ts:92
Private Optional port
port?: MessagePort
Message port used to communicate with the main worker.
-
Defined in src/worker/thread-worker.ts:33
Protected Optional statistics
statistics?: WorkerStatistics
Performance statistics computation requirements.
-
Inherited from AbstractWorker.statistics
Defined in src/worker/abstract-worker.ts:74
Protected taskFunctions
taskFunctions: Map<string, TaskFunction<Data, Response>>
Task function(s) processed by the worker when the pool's execution function is invoked.
-
Inherited from AbstractWorker.taskFunctions
Defined in src/worker/abstract-worker.ts:66
Accessors
Protected id
get id(): number
Worker id.
-
Returns number
Overrides AbstractWorker.id
Defined in src/worker/thread-worker.ts:79
Methods
addTaskFunction
addTaskFunction(name, fn): TaskFunctionOperationResult
Adds a task function to the worker.
+
 Type Parameters
Data = unknownType of data this worker receives from pool's execution. This can only be structured-cloneable data.
+
Response = unknownType of response the worker sends back to the main thread. This can only be structured-cloneable data.
+
 Hierarchy (view full)
AbstractWorker<MessagePort, Data, Response>ThreadWorker
Defined in src/worker/thread-worker.ts:26
 Index
Constructors
constructor
+
Properties
activeInterval?
+isMain
+lastTaskTimestamp
+opts
+port?
+statistics?
+taskFunctions
+
Accessors
id
+
Methods
addTaskFunction
+getMainWorker
+handleError
+handleKillMessage
+handleReadyMessage
+handleTaskFunctionOperationMessage
+hasTaskFunction
+listTaskFunctionNames
+messageListener
+removeTaskFunction
+run
+runAsync
+runSync
+sendTaskFunctionNamesToMainWorker
+sendToMainWorker
+setDefaultTaskFunction
+
Constructors
constructor
new ThreadWorker<Data, Response>(taskFunctions, opts?): ThreadWorker<Data, Response>
Constructs a new poolifier thread worker.
+
Type Parameters
Data = unknown
Response = unknown
Parameters
taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>Task function(s) processed by the worker when the pool's execution function is invoked.
+
opts: WorkerOptions = {}Options for the worker.
+
Returns ThreadWorker<Data, Response>
Overrides AbstractWorker.constructor
Defined in src/worker/thread-worker.ts:41
Properties
Protected Optional activeInterval
activeInterval?: Timeout
Handler id of the activeInterval worker activity check.
+
Inherited from AbstractWorker.activeInterval
Defined in src/worker/abstract-worker.ts:78
Protected Readonly isMain
isMain: undefined | boolean
Whether this is the main worker or not.
+
Inherited from AbstractWorker.isMain
Defined in src/worker/abstract-worker.ts:89
Protected lastTaskTimestamp
lastTaskTimestamp: number
Timestamp of the last task processed by this worker.
+
Inherited from AbstractWorker.lastTaskTimestamp
Defined in src/worker/abstract-worker.ts:70
Protected opts
opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
Options for the worker.
+
Inherited from AbstractWorker.opts
Defined in src/worker/abstract-worker.ts:92
Private Optional port
port?: MessagePort
Message port used to communicate with the main worker.
+
Defined in src/worker/thread-worker.ts:33
Protected Optional statistics
statistics?: WorkerStatistics
Performance statistics computation requirements.
+
Inherited from AbstractWorker.statistics
Defined in src/worker/abstract-worker.ts:74
Protected taskFunctions
taskFunctions: Map<string, TaskFunction<Data, Response>>
Task function(s) processed by the worker when the pool's execution function is invoked.
+
Inherited from AbstractWorker.taskFunctions
Defined in src/worker/abstract-worker.ts:66
Accessors
Protected id
get id(): number
Worker id.
+
Returns number
Overrides AbstractWorker.id
Defined in src/worker/thread-worker.ts:79
Methods
addTaskFunction
addTaskFunction(name, fn): TaskFunctionOperationResult
Adds a task function to the worker.
 If a task function with the same name already exists, it is replaced.
-
Parameters
name: string
The name of the task function to add.
-
fn: TaskFunction<Data, Response>
The task function to add.
+
Parameters
name: stringThe name of the task function to add.
+
fn: TaskFunction<Data, Response>The task function to add.
 
Returns TaskFunctionOperationResult
Whether the task function was added or not.
-
Inherited from AbstractWorker.addTaskFunction
Defined in src/worker/abstract-worker.ts:179
Protected getMainWorker
getMainWorker(): MessagePort
Returns the main worker.
+
Inherited from AbstractWorker.addTaskFunction
Defined in src/worker/abstract-worker.ts:179
Protected getMainWorker
getMainWorker(): MessagePort
Returns the main worker.
 
Returns MessagePort
Reference to the main worker.
 Throws
https://nodejs.org/api/errors.html#class-error If the main worker is not set.
-
Inherited from AbstractWorker.getMainWorker
Defined in src/worker/abstract-worker.ts:451
Protected handleError
handleError(error): string
Handles an error and convert it to a string so it can be sent back to the main worker.
-
Parameters
error: string | Error
The error raised by the worker.
+
Inherited from AbstractWorker.getMainWorker
Defined in src/worker/abstract-worker.ts:451
Protected handleError
handleError(error): string
Handles an error and convert it to a string so it can be sent back to the main worker.
+
Parameters
error: string | ErrorThe error raised by the worker.
 
Returns string
The error message.
-
Overrides AbstractWorker.handleError
Defined in src/worker/thread-worker.ts:97
Protected handleKillMessage
handleKillMessage(message): void
Handles a kill message sent by the main worker.
-
Parameters
message: MessageValue<Data, unknown>
Returns void
Overrides AbstractWorker.handleKillMessage
Defined in src/worker/thread-worker.ts:72
Protected handleReadyMessage
handleReadyMessage(message): void
Handles the ready message sent by the main worker.
-
Parameters
message: MessageValue<Data, unknown>
The ready message.
-
Returns void
Overrides AbstractWorker.handleReadyMessage
Defined in src/worker/thread-worker.ts:49
Protected handleTaskFunctionOperationMessage
handleTaskFunctionOperationMessage(message): void
Parameters
message: MessageValue<Data, unknown>
Returns void
Inherited from AbstractWorker.handleTaskFunctionOperationMessage
Defined in src/worker/abstract-worker.ts:324
hasTaskFunction
hasTaskFunction(name): TaskFunctionOperationResult
Checks if the worker has a task function with the given name.
-
Parameters
name: string
The name of the task function to check.
+
Overrides AbstractWorker.handleError
Defined in src/worker/thread-worker.ts:97
Protected handleKillMessage
handleKillMessage(message): void
Handles a kill message sent by the main worker.
+
Parameters
message: MessageValue<Data, unknown>
Returns void
Overrides AbstractWorker.handleKillMessage
Defined in src/worker/thread-worker.ts:72
Protected handleReadyMessage
handleReadyMessage(message): void
Handles the ready message sent by the main worker.
+
Parameters
message: MessageValue<Data, unknown>The ready message.
+
Returns void
Overrides AbstractWorker.handleReadyMessage
Defined in src/worker/thread-worker.ts:49
Protected handleTaskFunctionOperationMessage
handleTaskFunctionOperationMessage(message): void
Parameters
message: MessageValue<Data, unknown>
Returns void
Inherited from AbstractWorker.handleTaskFunctionOperationMessage
Defined in src/worker/abstract-worker.ts:324
hasTaskFunction
hasTaskFunction(name): TaskFunctionOperationResult
Checks if the worker has a task function with the given name.
+
Parameters
name: stringThe name of the task function to check.
 
Returns TaskFunctionOperationResult
Whether the worker has a task function with the given name or not.
-
Inherited from AbstractWorker.hasTaskFunction
Defined in src/worker/abstract-worker.ts:162
listTaskFunctionNames
listTaskFunctionNames(): string[]
Lists the names of the worker's task functions.
+
Inherited from AbstractWorker.hasTaskFunction
Defined in src/worker/abstract-worker.ts:162
listTaskFunctionNames
listTaskFunctionNames(): string[]
Lists the names of the worker's task functions.
 
Returns string[]
The names of the worker's task functions.
-
Inherited from AbstractWorker.listTaskFunctionNames
Defined in src/worker/abstract-worker.ts:243
Protected messageListener
messageListener(message): void
Worker message listener.
-
Parameters
message: MessageValue<Data, unknown>
The received message.
-
Returns void
Inherited from AbstractWorker.messageListener
Defined in src/worker/abstract-worker.ts:304
removeTaskFunction
removeTaskFunction(name): TaskFunctionOperationResult
Removes a task function from the worker.
-
Parameters
name: string
The name of the task function to remove.
+
Inherited from AbstractWorker.listTaskFunctionNames
Defined in src/worker/abstract-worker.ts:243
Protected messageListener
messageListener(message): void
Worker message listener.
+
Parameters
message: MessageValue<Data, unknown>The received message.
+
Returns void
Inherited from AbstractWorker.messageListener
Defined in src/worker/abstract-worker.ts:304
removeTaskFunction
removeTaskFunction(name): TaskFunctionOperationResult
Removes a task function from the worker.
+
Parameters
name: stringThe name of the task function to remove.
 
Returns TaskFunctionOperationResult
Whether the task function existed and was removed or not.
-
Inherited from AbstractWorker.removeTaskFunction
Defined in src/worker/abstract-worker.ts:214
Protected Readonly run
run(task): void
Runs the given task.
-
Parameters
task: Task<Data>
The task to execute.
-
Returns void
Inherited from AbstractWorker.run
Defined in src/worker/abstract-worker.ts:491
Protected Readonly runAsync
runAsync(fn, task): void
Runs the given task function asynchronously.
-
Parameters
fn: TaskAsyncFunction<Data, Response>
Task function that will be executed.
-
task: Task<Data>
Input data for the task function.
-
Returns void
Inherited from AbstractWorker.runAsync
Defined in src/worker/abstract-worker.ts:555
Protected Readonly runSync
runSync(fn, task): void
Runs the given task function synchronously.
-
Parameters
fn: TaskSyncFunction<Data, Response>
Task function that will be executed.
-
task: Task<Data>
Input data for the task function.
-
Returns void
Inherited from AbstractWorker.runSync
Defined in src/worker/abstract-worker.ts:520
Protected sendTaskFunctionNamesToMainWorker
sendTaskFunctionNamesToMainWorker(): void
Sends task function names to the main worker.
-
Returns void
Inherited from AbstractWorker.sendTaskFunctionNamesToMainWorker
Defined in src/worker/abstract-worker.ts:470
Protected Readonly sendToMainWorker
sendToMainWorker(message): void
Sends a message to main worker.
-
Parameters
message: MessageValue<Response, unknown>
The response message.
-
Returns void
Overrides AbstractWorker.sendToMainWorker
Defined in src/worker/thread-worker.ts:84
setDefaultTaskFunction
setDefaultTaskFunction(name): TaskFunctionOperationResult
Sets the default task function to use in the worker.
-
Parameters
name: string
The name of the task function to use as default task function.
+
Inherited from AbstractWorker.removeTaskFunction
Defined in src/worker/abstract-worker.ts:214
Protected Readonly run
run(task): void
Runs the given task.
+
Parameters
task: Task<Data>The task to execute.
+
Returns void
Inherited from AbstractWorker.run
Defined in src/worker/abstract-worker.ts:491
Protected Readonly runAsync
runAsync(fn, task): void
Runs the given task function asynchronously.
+
Parameters
fn: TaskAsyncFunction<Data, Response>Task function that will be executed.
+
task: Task<Data>Input data for the task function.
+
Returns void
Inherited from AbstractWorker.runAsync
Defined in src/worker/abstract-worker.ts:555
Protected Readonly runSync
runSync(fn, task): void
Runs the given task function synchronously.
+
Parameters
fn: TaskSyncFunction<Data, Response>Task function that will be executed.
+
task: Task<Data>Input data for the task function.
+
Returns void
Inherited from AbstractWorker.runSync
Defined in src/worker/abstract-worker.ts:520
Protected sendTaskFunctionNamesToMainWorker
sendTaskFunctionNamesToMainWorker(): void
Sends task function names to the main worker.
+
Returns void
Inherited from AbstractWorker.sendTaskFunctionNamesToMainWorker
Defined in src/worker/abstract-worker.ts:470
Protected Readonly sendToMainWorker
sendToMainWorker(message): void
Sends a message to main worker.
+
Parameters
message: MessageValue<Response, unknown>The response message.
+
Returns void
Overrides AbstractWorker.sendToMainWorker
Defined in src/worker/thread-worker.ts:84
setDefaultTaskFunction
setDefaultTaskFunction(name): TaskFunctionOperationResult
Sets the default task function to use in the worker.
+
Parameters
name: stringThe name of the task function to use as default task function.
 
Returns TaskFunctionOperationResult
Whether the default task function was set or not.
-
Inherited from AbstractWorker.setDefaultTaskFunction
Defined in src/worker/abstract-worker.ts:270
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
constructor
activeInterval
isMain
lastTaskTimestamp
opts
port
statistics
taskFunctions
id
addTaskFunction
getMainWorker
handleError
handleKillMessage
handleReadyMessage
handleTaskFunctionOperationMessage
hasTaskFunction
listTaskFunctionNames
messageListener
removeTaskFunction
run
runAsync
runSync
sendTaskFunctionNamesToMainWorker
sendToMainWorker
setDefaultTaskFunction
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+
Inherited from AbstractWorker.setDefaultTaskFunction
Defined in src/worker/abstract-worker.ts:270
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
constructor
activeInterval
isMain
lastTaskTimestamp
opts
port
statistics
taskFunctions
id
addTaskFunction
getMainWorker
handleError
handleKillMessage
handleReadyMessage
handleTaskFunctionOperationMessage
hasTaskFunction
listTaskFunctionNames
messageListener
removeTaskFunction
run
runAsync
runSync
sendTaskFunctionNamesToMainWorker
sendToMainWorker
setDefaultTaskFunction
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html
index fdd70a7e..4759457a 100644
--- a/docs/classes/WorkerChoiceStrategyContext.html
+++ b/docs/classes/WorkerChoiceStrategyContext.html
@@ -1,46 +1,46 @@
-WorkerChoiceStrategyContext | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerChoiceStrategyContext
Class WorkerChoiceStrategyContext<Worker, Data, Response>
The worker choice strategy context.
-
 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.
-
 Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:27
 Index
Constructors
constructor
-
Properties
retries
-retriesCount
-workerChoiceStrategies
-workerChoiceStrategy
-
Methods
execute
-executeStrategy
-getStrategyPolicy
-getTaskStatisticsRequirements
-remove
-setOptions
-setWorkerChoiceStrategy
-update
-
Constructors
constructor
new WorkerChoiceStrategyContext<Worker, Data, Response>(pool, workerChoiceStrategy?, opts?): WorkerChoiceStrategyContext<Worker, Data, Response>
Worker choice strategy context constructor.
-
Type Parameters
Worker extends IWorker
Data = unknown
Response = unknown
Parameters
pool: IPool<Worker, Data, Response>
The pool instance.
-
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN
The worker choice strategy.
-
Optional opts: WorkerChoiceStrategyOptions
The worker choice strategy options.
-
Returns WorkerChoiceStrategyContext<Worker, Data, Response>
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:57
Properties
Private Readonly retries
retries: number
The maximum number of worker choice strategy execution retries.
-
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:48
retriesCount
retriesCount: number
The number of worker choice strategy execution retries.
-
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:35
Private Readonly workerChoiceStrategies
workerChoiceStrategies: Map<"ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>
The worker choice strategy instances registered in the context.
-
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:40
Private workerChoiceStrategy
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN
The worker choice strategy.
-
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:59
Methods
execute
execute(): number
Executes the worker choice strategy in the context algorithm.
+WorkerChoiceStrategyContext | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerChoiceStrategyContext
Class WorkerChoiceStrategyContext<Worker, Data, Response>
The worker choice strategy context.
+
 Type Parameters
Worker extends IWorkerType of worker.
+
Data = unknownType of data sent to the worker. This can only be structured-cloneable data.
+
Response = unknownType of execution response. This can only be structured-cloneable data.
+
 Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:27
 Index
Constructors
constructor
+
Properties
retries
+retriesCount
+workerChoiceStrategies
+workerChoiceStrategy
+
Methods
execute
+executeStrategy
+getStrategyPolicy
+getTaskStatisticsRequirements
+remove
+setOptions
+setWorkerChoiceStrategy
+update
+
Constructors
constructor
new WorkerChoiceStrategyContext<Worker, Data, Response>(pool, workerChoiceStrategy?, opts?): WorkerChoiceStrategyContext<Worker, Data, Response>
Worker choice strategy context constructor.
+
Type Parameters
Worker extends IWorker
Data = unknown
Response = unknown
Parameters
pool: IPool<Worker, Data, Response>The pool instance.
+
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBINThe worker choice strategy.
+
Optional opts: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+
Returns WorkerChoiceStrategyContext<Worker, Data, Response>
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:57
Properties
Private Readonly retries
retries: number
The maximum number of worker choice strategy execution retries.
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:48
retriesCount
retriesCount: number
The number of worker choice strategy execution retries.
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:35
Private Readonly workerChoiceStrategies
workerChoiceStrategies: Map<"ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>
The worker choice strategy instances registered in the context.
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:40
Private workerChoiceStrategy
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN
The worker choice strategy.
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:59
Methods
execute
execute(): number
Executes the worker choice strategy in the context algorithm.
 
Returns number
The key of the worker node.
 Throws
https://nodejs.org/api/errors.html#class-error If after computed retries the worker node key is null or undefined.
-
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:177
Private executeStrategy
executeStrategy(workerChoiceStrategy): number
Executes the given worker choice strategy.
-
Parameters
workerChoiceStrategy: IWorkerChoiceStrategy
The worker choice strategy.
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:177
Private executeStrategy
executeStrategy(workerChoiceStrategy): number
Executes the given worker choice strategy.
+
Parameters
workerChoiceStrategy: IWorkerChoiceStrategyThe worker choice strategy.
 
Returns number
The key of the worker node.
 Throws
https://nodejs.org/api/errors.html#class-error If after computed retries the worker node key is null or undefined.
-
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:191
getStrategyPolicy
getStrategyPolicy(): StrategyPolicy
Gets the strategy policy in the context.
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:191
getStrategyPolicy
getStrategyPolicy(): StrategyPolicy
Gets the strategy policy in the context.
 
Returns StrategyPolicy
The strategy policy.
-
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:128
getTaskStatisticsRequirements
getTaskStatisticsRequirements(): TaskStatisticsRequirements
Gets the worker choice strategy in the context task statistics requirements.
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:128
getTaskStatisticsRequirements
getTaskStatisticsRequirements(): TaskStatisticsRequirements
Gets the worker choice strategy in the context task statistics requirements.
 
Returns TaskStatisticsRequirements
The task statistics requirements.
-
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:139
remove
remove(workerNodeKey): boolean
Removes the worker node key from the worker choice strategy in the context.
-
Parameters
workerNodeKey: number
The worker node key.
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:139
remove
remove(workerNodeKey): boolean
Removes the worker node key from the worker choice strategy in the context.
+
Parameters
workerNodeKey: numberThe worker node key.
 
Returns boolean
true if the removal is successful, false otherwise.
-
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:217
setOptions
setOptions(opts): void
Sets the worker choice strategies in the context options.
-
Parameters
opts: undefined | WorkerChoiceStrategyOptions
The worker choice strategy options.
-
Returns void
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:229
setWorkerChoiceStrategy
setWorkerChoiceStrategy(workerChoiceStrategy): void
Sets the worker choice strategy to use in the context.
-
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
The worker choice strategy to set.
-
Returns void
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:150
update
update(workerNodeKey): boolean
Updates the worker node key in the worker choice strategy in the context internals.
-
Parameters
workerNodeKey: number
Returns boolean
true if the update is successful, false otherwise.
-
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:164
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
constructor
retries
retriesCount
workerChoiceStrategies
workerChoiceStrategy
execute
executeStrategy
getStrategyPolicy
getTaskStatisticsRequirements
remove
setOptions
setWorkerChoiceStrategy
update
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:217
setOptions
setOptions(opts): void
Sets the worker choice strategies in the context options.
+
Parameters
opts: undefined | WorkerChoiceStrategyOptionsThe worker choice strategy options.
+
Returns void
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:229
setWorkerChoiceStrategy
setWorkerChoiceStrategy(workerChoiceStrategy): void
Sets the worker choice strategy to use in the context.
+
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"The worker choice strategy to set.
+
Returns void
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:150
update
update(workerNodeKey): boolean
Updates the worker node key in the worker choice strategy in the context internals.
+
Parameters
workerNodeKey: number
Returns boolean
true if the update is successful, false otherwise.
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:164
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
constructor
retries
retriesCount
workerChoiceStrategies
workerChoiceStrategy
execute
executeStrategy
getStrategyPolicy
getTaskStatisticsRequirements
remove
setOptions
setWorkerChoiceStrategy
update
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/functions/availableParallelism.html b/docs/functions/availableParallelism.html
index 2a69950f..68ed10d9 100644
--- a/docs/functions/availableParallelism.html
+++ b/docs/functions/availableParallelism.html
@@ -1,4 +1,4 @@
-availableParallelism | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
availableParallelism
Function availableParallelism
availableParallelism(): number
Returns safe host OS optimized estimate of the default amount of parallelism a pool should use.
+availableParallelism | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
availableParallelism
Function availableParallelism
availableParallelism(): number
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.
-
Defined in src/utils.ts:23
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+
Defined in src/utils.ts:23
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/hierarchy.html b/docs/hierarchy.html
index 2abdd358..5129cc42 100644
--- a/docs/hierarchy.html
+++ b/docs/hierarchy.html
@@ -1 +1 @@
-poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier - v3.1.21
Class Hierarchy
AbstractWorkerClusterWorker
ThreadWorker
IPoolAbstractPoolFixedClusterPoolDynamicClusterPool
FixedThreadPoolDynamicThreadPool
TaskMessageValue
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier - v3.1.21
Class Hierarchy
AbstractWorkerClusterWorker
ThreadWorker
IPoolAbstractPoolFixedClusterPoolDynamicClusterPool
FixedThreadPoolDynamicThreadPool
TaskMessageValue
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/index.html b/docs/index.html
index 0a5579dc..d1f4f8bc 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1,67 +1,67 @@
-poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier - v3.1.21
Index
Classes
AbstractPool
-AbstractWorker
-CircularArray
-ClusterWorker
-Deque
-DynamicClusterPool
-DynamicThreadPool
-FixedClusterPool
-FixedThreadPool
-ThreadWorker
-WorkerChoiceStrategyContext
-
Interfaces
EventLoopUtilizationMeasurementStatistics
-ILinkedListNode
-IPool
-IWorker
-IWorkerChoiceStrategy
-IWorkerNode
-MeasurementOptions
-MeasurementStatistics
-MeasurementStatisticsRequirements
-MessageValue
-PoolInfo
-PoolOptions
-PromiseResponseWrapper
-StrategyData
-StrategyPolicy
-Task
-TaskFunctionOperationResult
-TaskPerformance
-TaskStatistics
-TaskStatisticsRequirements
-TasksQueueOptions
-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
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier - v3.1.21
Index
Classes
AbstractPool
+AbstractWorker
+CircularArray
+ClusterWorker
+Deque
+DynamicClusterPool
+DynamicThreadPool
+FixedClusterPool
+FixedThreadPool
+ThreadWorker
+WorkerChoiceStrategyContext
+
Interfaces
EventLoopUtilizationMeasurementStatistics
+ILinkedListNode
+IPool
+IWorker
+IWorkerChoiceStrategy
+IWorkerNode
+MeasurementOptions
+MeasurementStatistics
+MeasurementStatisticsRequirements
+MessageValue
+PoolInfo
+PoolOptions
+PromiseResponseWrapper
+StrategyData
+StrategyPolicy
+Task
+TaskFunctionOperationResult
+TaskPerformance
+TaskStatistics
+TaskStatisticsRequirements
+TasksQueueOptions
+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
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html b/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html
index 2a52fea2..b04d38a3 100644
--- a/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html
+++ b/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html
@@ -1,5 +1,5 @@
-EventLoopUtilizationMeasurementStatistics | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
EventLoopUtilizationMeasurementStatistics
Interface EventLoopUtilizationMeasurementStatisticsInternal 
Event loop utilization measurement statistics.
-
interface EventLoopUtilizationMeasurementStatistics { 
Â Â Â Â active: MeasurementStatistics; 
Â Â Â Â idle: MeasurementStatistics; 
Â Â Â Â utilization?: number; 
}
Defined in src/pools/worker.ts:91
 Index
Properties
active
-idle
-utilization?
-
Properties
Readonly active
active: MeasurementStatistics
Defined in src/pools/worker.ts:93
Readonly idle
idle: MeasurementStatistics
Defined in src/pools/worker.ts:92
Optional utilization
utilization?: number
Defined in src/pools/worker.ts:94
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
active
idle
utilization
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+EventLoopUtilizationMeasurementStatistics | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
EventLoopUtilizationMeasurementStatistics
Interface EventLoopUtilizationMeasurementStatisticsInternal 
Event loop utilization measurement statistics.
+
interface EventLoopUtilizationMeasurementStatistics { 
Â Â Â Â active: MeasurementStatistics; 
Â Â Â Â idle: MeasurementStatistics; 
Â Â Â Â utilization?: number; 
}
Defined in src/pools/worker.ts:91
 Index
Properties
active
+idle
+utilization?
+
Properties
Readonly active
active: MeasurementStatistics
Defined in src/pools/worker.ts:93
Readonly idle
idle: MeasurementStatistics
Defined in src/pools/worker.ts:92
Optional utilization
utilization?: number
Defined in src/pools/worker.ts:94
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
active
idle
utilization
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/ILinkedListNode.html b/docs/interfaces/ILinkedListNode.html
index c704b080..36967f26 100644
--- a/docs/interfaces/ILinkedListNode.html
+++ b/docs/interfaces/ILinkedListNode.html
@@ -1,6 +1,6 @@
-ILinkedListNode | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
ILinkedListNode
Interface ILinkedListNode<T>Internal 
Linked list node interface.
-
interface ILinkedListNode<T> { 
Â Â Â Â data: T; 
Â Â Â Â next?: ILinkedListNode<T>; 
Â Â Â Â prev?: ILinkedListNode<T>; 
}
 Type Parameters
T
Type of linked list node data.
-
 Defined in src/deque.ts:9
 Index
Properties
data
-next?
-prev?
-
Properties
data
data: T
Defined in src/deque.ts:10
Optional next
next?: ILinkedListNode<T>
Defined in src/deque.ts:11
Optional prev
prev?: ILinkedListNode<T>
Defined in src/deque.ts:12
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
data
next
prev
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+ILinkedListNode | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
ILinkedListNode
Interface ILinkedListNode<T>Internal 
Linked list node interface.
+
interface ILinkedListNode<T> { 
Â Â Â Â data: T; 
Â Â Â Â next?: ILinkedListNode<T>; 
Â Â Â Â prev?: ILinkedListNode<T>; 
}
 Type Parameters
TType of linked list node data.
+
 Defined in src/deque.ts:9
 Index
Properties
data
+next?
+prev?
+
Properties
data
data: T
Defined in src/deque.ts:10
Optional next
next?: ILinkedListNode<T>
Defined in src/deque.ts:11
Optional prev
prev?: ILinkedListNode<T>
Defined in src/deque.ts:12
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
data
next
prev
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html
index 551e2459..615fc4f1 100644
--- a/docs/interfaces/IPool.html
+++ b/docs/interfaces/IPool.html
@@ -1,39 +1,31 @@
-IPool | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
IPool
Interface IPool<Worker, Data, Response>
Contract definition for a poolifier pool.
-
interface IPool<Worker, Data, Response> { 
Â Â Â Â addTaskFunction: ((name, fn) => Promise<boolean>); 
Â Â Â Â destroy: (() => Promise<void>); 
Â Â Â Â emitter?: EventEmitterAsyncResource; 
Â Â Â Â enableTasksQueue: ((enable, tasksQueueOptions?) => void); 
Â Â Â Â execute: ((data?, name?, transferList?) => Promise<Response>); 
Â Â Â Â hasTaskFunction: ((name) => boolean); 
Â Â Â Â info: PoolInfo; 
Â Â Â Â listTaskFunctionNames: (() => string[]); 
Â Â Â Â removeTaskFunction: ((name) => Promise<boolean>); 
Â Â Â Â setDefaultTaskFunction: ((name) => Promise<boolean>); 
Â Â Â Â setTasksQueueOptions: ((tasksQueueOptions) => void); 
Â Â Â Â setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void); 
Â Â Â Â setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void); 
Â Â Â Â 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
AbstractPool
Defined in src/pools/pool.ts:230
 Index
Properties
addTaskFunction
-destroy
-emitter?
-enableTasksQueue
-execute
-hasTaskFunction
-info
-listTaskFunctionNames
-removeTaskFunction
-setDefaultTaskFunction
-setTasksQueueOptions
-setWorkerChoiceStrategy
-setWorkerChoiceStrategyOptions
-start
-workerNodes
-
Properties
Readonly addTaskFunction
addTaskFunction: ((name, fn) => Promise<boolean>)
Adds a task function to this pool.
+IPool | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
IPool
Interface IPool<Worker, Data, Response>
Contract definition for a poolifier pool.
+
interface IPool<Worker, Data, Response> { 
Â Â Â Â addTaskFunction: ((name, fn) => Promise<boolean>); 
Â Â Â Â destroy: (() => Promise<void>); 
Â Â Â Â emitter?: EventEmitterAsyncResource; 
Â Â Â Â enableTasksQueue: ((enable, tasksQueueOptions?) => void); 
Â Â Â Â execute: ((data?, name?, transferList?) => Promise<Response>); 
Â Â Â Â hasTaskFunction: ((name) => boolean); 
Â Â Â Â info: PoolInfo; 
Â Â Â Â listTaskFunctionNames: (() => string[]); 
Â Â Â Â removeTaskFunction: ((name) => Promise<boolean>); 
Â Â Â Â setDefaultTaskFunction: ((name) => Promise<boolean>); 
Â Â Â Â setTasksQueueOptions: ((tasksQueueOptions) => void); 
Â Â Â Â setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void); 
Â Â Â Â setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void); 
Â Â Â Â start: (() => void); 
Â Â Â Â workerNodes: IWorkerNode<Worker, Data>[]; 
}
 Type Parameters
Worker extends IWorkerType of worker which manages this pool.
+
Data = unknownType of data sent to the worker. This can only be structured-cloneable data.
+
Response = unknownType of execution response. This can only be structured-cloneable data.
+
 Implemented by
AbstractPool
Defined in src/pools/pool.ts:230
 Index
Properties
addTaskFunction
+destroy
+emitter?
+enableTasksQueue
+execute
+hasTaskFunction
+info
+listTaskFunctionNames
+removeTaskFunction
+setDefaultTaskFunction
+setTasksQueueOptions
+setWorkerChoiceStrategy
+setWorkerChoiceStrategyOptions
+start
+workerNodes
+
Properties
Readonly addTaskFunction
addTaskFunction: ((name, fn) => 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
(name, fn): Promise<boolean>
Adds a task function to this pool.
-If a task function with the same name already exists, it will be overwritten.
-
Parameters
name: string
The name of the task function.
-
fn: TaskFunction<Data, Response>
The task function.
-
Returns Promise<boolean>
true if the task function was added, false otherwise.
-Throws
https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.
-Throws
https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.
-
Param: name
The name of the task function.
-Param: fn
The task function.
-Returns
true if the task function was added, false otherwise.
+
Type declaration
(name, fn): Promise<boolean>
Parameters
name: stringThe name of the task function.
+
fn: TaskFunction<Data, Response>The task function.
+
Returns Promise<boolean>
Returns
true if the task function was added, false otherwise.
 Throws
https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.
 Throws
https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.
-
Defined in src/pools/pool.ts:299
Readonly destroy
destroy: (() => Promise<void>)
Terminates all workers in this pool.
-
Type declaration
(): Promise<void>
Terminates all workers in this pool.
-
Returns Promise<void>
Defined in src/pools/pool.ts:281
Optional Readonly emitter
emitter?: EventEmitterAsyncResource
Event emitter integrated with async resource on which events can be listened to.
+
Defined in src/pools/pool.ts:299
Readonly destroy
destroy: (() => Promise<void>)
Terminates all workers in this pool.
+
Type declaration
(): Promise<void>
Returns Promise<void>
Defined in src/pools/pool.ts:281
Optional Readonly emitter
emitter?: EventEmitterAsyncResource
Event emitter integrated with async resource on which events can be listened to.
 The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.
 Events that can currently be listened to:
 
@@ -46,60 +38,33 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
 'taskError': Emitted when an error occurs while executing a task.
 'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
 

-
Defined in src/pools/pool.ts:260
Readonly enableTasksQueue
enableTasksQueue: ((enable, tasksQueueOptions?) => void)
Enables/disables the worker node tasks queue in this pool.
-
Type declaration
(enable, tasksQueueOptions?): void
Enables/disables the worker node tasks queue in this pool.
-
Parameters
enable: boolean
Whether to enable or disable the worker node tasks queue.
-
Optional tasksQueueOptions: TasksQueueOptions
The worker node tasks queue options.
-
Returns void
Param: enable
Whether to enable or disable the worker node tasks queue.
-Param: tasksQueueOptions
The worker node tasks queue options.
-
Defined in src/pools/pool.ts:347
Readonly execute
execute: ((data?, name?, transferList?) => Promise<Response>)
Executes the specified function in the worker constructor with the task data input parameter.
-
Type declaration
(data?, name?, transferList?): Promise<Response>
Executes the specified function in the worker constructor with the task data input parameter.
-
Parameters
Optional data: Data
The optional task input data for the specified task function. This can only be structured-cloneable data.
-
Optional name: string
The optional name of the task function to execute. If not specified, the default task function will be executed.
-
Optional transferList: TransferListItem[]
An 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 that will be fulfilled when the task is completed.
-
Param: data
The optional task input data for the specified task function. This can only be structured-cloneable data.
-Param: name
The optional name of the task function to execute. If not specified, the default task function will be executed.
-Param: transferList
An 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 that will be fulfilled when the task is completed.
-
Defined in src/pools/pool.ts:269
Readonly hasTaskFunction
hasTaskFunction: ((name) => boolean)
Whether the specified task function exists in this pool.
-
Type declaration
(name): boolean
Whether the specified task function exists in this pool.
-
Parameters
name: string
The name of the task function.
-
Returns boolean
true if the task function exists, false otherwise.
-
Param: name
The name of the task function.
-Returns
true if the task function exists, false otherwise.
-
Defined in src/pools/pool.ts:288
Readonly info
info: PoolInfo
Pool information.
-
Defined in src/pools/pool.ts:238
Readonly listTaskFunctionNames
listTaskFunctionNames: (() => string[])
Lists the names of task function available in this pool.
-
Type declaration
(): string[]
Lists the names of task function available in this pool.
-
Returns string[]
The names of task function available in this pool.
-
Returns
The names of task function available in this pool.
-
Defined in src/pools/pool.ts:315
Readonly removeTaskFunction
removeTaskFunction: ((name) => Promise<boolean>)
Removes a task function from this pool.
-
Type declaration
(name): Promise<boolean>
Removes a task function from this pool.
-
Parameters
name: string
The name of the task function.
-
Returns Promise<boolean>
true if the task function was removed, false otherwise.
-
Param: name
The name of the task function.
-Returns
true if the task function was removed, false otherwise.
-
Defined in src/pools/pool.ts:309
Readonly setDefaultTaskFunction
setDefaultTaskFunction: ((name) => Promise<boolean>)
Sets the default task function in this pool.
-
Type declaration
(name): Promise<boolean>
Sets the default task function in this pool.
-
Parameters
name: string
The name of the task function.
-
Returns Promise<boolean>
true if the default task function was set, false otherwise.
-
Param: name
The name of the task function.
-Returns
true if the default task function was set, false otherwise.
-
Defined in src/pools/pool.ts:322
Readonly setTasksQueueOptions
setTasksQueueOptions: ((tasksQueueOptions) => void)
Sets the worker node tasks queue options in this pool.
-
Type declaration
(tasksQueueOptions): void
Sets the worker node tasks queue options in this pool.
-
Parameters
tasksQueueOptions: TasksQueueOptions
The worker node tasks queue options.
-
Returns void
Param: tasksQueueOptions
The worker node tasks queue options.
-
Defined in src/pools/pool.ts:356
Readonly setWorkerChoiceStrategy
setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
Sets the worker choice strategy in this pool.
-
Type declaration
(workerChoiceStrategy, workerChoiceStrategyOptions?): void
Sets the worker choice strategy in this pool.
-
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
The worker choice strategy.
-
Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
The worker choice strategy options.
-
Returns void
Param: workerChoiceStrategy
The worker choice strategy.
-Param: workerChoiceStrategyOptions
The worker choice strategy options.
-
Defined in src/pools/pool.ts:329
Readonly setWorkerChoiceStrategyOptions
setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
Sets the worker choice strategy options in this pool.
-
Type declaration
(workerChoiceStrategyOptions): void
Sets the worker choice strategy options in this pool.
-
Parameters
workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
The worker choice strategy options.
-
Returns void
Param: workerChoiceStrategyOptions
The worker choice strategy options.
-
Defined in src/pools/pool.ts:338
Readonly start
start: (() => void)
Starts the minimum number of workers in this pool.
-
Type declaration
(): void
Starts the minimum number of workers in this pool.
-
Returns void
Defined in src/pools/pool.ts:277
Readonly Internal workerNodes
workerNodes: IWorkerNode<Worker, Data>[]
Pool worker nodes.
-
Defined in src/pools/pool.ts:244
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
addTaskFunction
destroy
emitter
enableTasksQueue
execute
hasTaskFunction
info
listTaskFunctionNames
removeTaskFunction
setDefaultTaskFunction
setTasksQueueOptions
setWorkerChoiceStrategy
setWorkerChoiceStrategyOptions
start
workerNodes
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+
Defined in src/pools/pool.ts:260
Readonly enableTasksQueue
enableTasksQueue: ((enable, tasksQueueOptions?) => void)
Enables/disables the worker node tasks queue in this pool.
+
Type declaration
(enable, tasksQueueOptions?): void
Parameters
enable: booleanWhether to enable or disable the worker node tasks queue.
+
Optional tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
+
Returns void
Defined in src/pools/pool.ts:347
Readonly execute
execute: ((data?, name?, transferList?) => Promise<Response>)
Executes the specified function in the worker constructor with the task data input parameter.
+
Type declaration
(data?, name?, transferList?): Promise<Response>
Parameters
Optional data: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
+
Optional name: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
+
Optional transferList: TransferListItem[]An 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>
Returns
Promise that will be fulfilled when the task is completed.
+
Defined in src/pools/pool.ts:269
Readonly hasTaskFunction
hasTaskFunction: ((name) => boolean)
Whether the specified task function exists in this pool.
+
Type declaration
(name): boolean
Parameters
name: stringThe name of the task function.
+
Returns boolean
Returns
true if the task function exists, false otherwise.
+
Defined in src/pools/pool.ts:288
Readonly info
info: PoolInfo
Pool information.
+
Defined in src/pools/pool.ts:238
Readonly listTaskFunctionNames
listTaskFunctionNames: (() => string[])
Lists the names of task function available in this pool.
+
Type declaration
(): string[]
Returns string[]
Returns
The names of task function available in this pool.
+
Defined in src/pools/pool.ts:315
Readonly removeTaskFunction
removeTaskFunction: ((name) => Promise<boolean>)
Removes a task function from this pool.
+
Type declaration
(name): Promise<boolean>
Parameters
name: stringThe name of the task function.
+
Returns Promise<boolean>
Returns
true if the task function was removed, false otherwise.
+
Defined in src/pools/pool.ts:309
Readonly setDefaultTaskFunction
setDefaultTaskFunction: ((name) => Promise<boolean>)
Sets the default task function in this pool.
+
Type declaration
(name): Promise<boolean>
Parameters
name: stringThe name of the task function.
+
Returns Promise<boolean>
Returns
true if the default task function was set, false otherwise.
+
Defined in src/pools/pool.ts:322
Readonly setTasksQueueOptions
setTasksQueueOptions: ((tasksQueueOptions) => void)
Sets the worker node tasks queue options in this pool.
+
Type declaration
(tasksQueueOptions): void
Parameters
tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
+
Returns void
Defined in src/pools/pool.ts:356
Readonly setWorkerChoiceStrategy
setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
Sets the worker choice strategy in this pool.
+
Type declaration
(workerChoiceStrategy, workerChoiceStrategyOptions?): void
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"The worker choice strategy.
+
Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+
Returns void
Defined in src/pools/pool.ts:329
Readonly setWorkerChoiceStrategyOptions
setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
Sets the worker choice strategy options in this pool.
+
Type declaration
(workerChoiceStrategyOptions): void
Parameters
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+
Returns void
Defined in src/pools/pool.ts:338
Readonly start
start: (() => void)
Starts the minimum number of workers in this pool.
+
Type declaration
(): void
Returns void
Defined in src/pools/pool.ts:277
Readonly Internal workerNodes
workerNodes: IWorkerNode<Worker, Data>[]
Pool worker nodes.
+
Defined in src/pools/pool.ts:244
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
addTaskFunction
destroy
emitter
enableTasksQueue
execute
hasTaskFunction
info
listTaskFunctionNames
removeTaskFunction
setDefaultTaskFunction
setTasksQueueOptions
setWorkerChoiceStrategy
setWorkerChoiceStrategyOptions
start
workerNodes
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html
index 3e1f4eb6..d8cef72b 100644
--- a/docs/interfaces/IWorker.html
+++ b/docs/interfaces/IWorker.html
@@ -1,112 +1,99 @@
-IWorker | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
IWorker
Interface IWorker
Worker interface.
-
interface IWorker { 
Â Â Â Â disconnect?: (() => void); 
Â Â Â Â id?: number; 
Â Â Â Â kill?: ((signal?) => void); 
Â Â Â Â on: ((event, handler) => this); 
Â Â Â Â once: ((event, handler) => this); 
Â Â Â Â terminate?: (() => Promise<number>); 
Â Â Â Â threadId?: number; 
Â Â Â Â unref?: (() => void); 
Â Â Â Â [captureRejectionSymbol]?(error, event, ...args): void; 
Â Â Â Â addListener(eventName, listener): this; 
Â Â Â Â emit(eventName, ...args): boolean; 
Â Â Â Â eventNames(): (string | symbol)[]; 
Â Â Â Â getMaxListeners(): number; 
Â Â Â Â listenerCount(eventName, listener?): number; 
Â Â Â Â listeners(eventName): Function[]; 
Â Â Â Â off(eventName, listener): this; 
Â Â Â Â prependListener(eventName, listener): this; 
Â Â Â Â prependOnceListener(eventName, listener): this; 
Â Â Â Â rawListeners(eventName): Function[]; 
Â Â Â Â removeAllListeners(event?): this; 
Â Â Â Â removeListener(eventName, listener): this; 
Â Â Â Â setMaxListeners(n): this; 
}
Hierarchy
EventEmitterIWorker
Defined in src/pools/worker.ts:215
 Index
Properties
disconnect?
-id?
-kill?
-on
-once
-terminate?
-threadId?
-unref?
-
Methods
[captureRejectionSymbol]?
-addListener
-emit
-eventNames
-getMaxListeners
-listenerCount
-listeners
-off
-prependListener
-prependOnceListener
-rawListeners
-removeAllListeners
-removeListener
-setMaxListeners
-
Properties
Optional Readonly disconnect
disconnect?: (() => void)
Cluster worker disconnect.
-
Type declaration
(): void
Cluster worker disconnect.
-
Returns void
Defined in src/pools/worker.ts:252
Optional Readonly id
id?: number
Cluster worker id.
-
Defined in src/pools/worker.ts:219
Optional Readonly kill
kill?: ((signal?) => void)
Cluster worker kill.
-
Type declaration
(signal?): void
Cluster worker kill.
-
Parameters
Optional signal: string
Returns void
Defined in src/pools/worker.ts:256
Readonly on
on: ((event, handler) => this)
Registers an event handler.
-
Type declaration
(event, handler): this
Registers an event handler.
-
Parameters
event: string
The event.
-
handler: EventHandler<IWorker>
The event handler.
-
Returns this
Param: event
The event.
-Param: handler
The event handler.
-
Overrides EventEmitter.on
Defined in src/pools/worker.ts:230
Readonly once
once: ((event, handler) => this)
Registers once an event handler.
-
Type declaration
(event, handler): this
Registers once an event handler.
-
Parameters
event: string
The event.
-
handler: EventHandler<IWorker>
The event handler.
-
Returns this
Param: event
The event.
-Param: handler
The event handler.
-
Overrides EventEmitter.once
Defined in src/pools/worker.ts:237
Optional Readonly terminate
terminate?: (() => Promise<number>)
Stop all JavaScript execution in the worker thread as soon as possible.
+IWorker | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
IWorker
Interface IWorker
Worker interface.
+
interface IWorker { 
Â Â Â Â disconnect?: (() => void); 
Â Â Â Â id?: number; 
Â Â Â Â kill?: ((signal?) => void); 
Â Â Â Â on: ((event, handler) => this); 
Â Â Â Â once: ((event, handler) => this); 
Â Â Â Â terminate?: (() => Promise<number>); 
Â Â Â Â threadId?: number; 
Â Â Â Â unref?: (() => void); 
Â Â Â Â [captureRejectionSymbol]?<K>(error, event, ...args): void; 
Â Â Â Â addListener<K>(eventName, listener): this; 
Â Â Â Â emit<K>(eventName, ...args): boolean; 
Â Â Â Â eventNames(): (string | symbol)[]; 
Â Â Â Â getMaxListeners(): number; 
Â Â Â Â listenerCount<K>(eventName, listener?): number; 
Â Â Â Â listeners<K>(eventName): Function[]; 
Â Â Â Â off<K>(eventName, listener): this; 
Â Â Â Â prependListener<K>(eventName, listener): this; 
Â Â Â Â prependOnceListener<K>(eventName, listener): this; 
Â Â Â Â rawListeners<K>(eventName): Function[]; 
Â Â Â Â removeAllListeners(event?): this; 
Â Â Â Â removeListener<K>(eventName, listener): this; 
Â Â Â Â setMaxListeners(n): this; 
}
Hierarchy
EventEmitterIWorker
Defined in src/pools/worker.ts:215
 Index
Properties
disconnect?
+id?
+kill?
+on
+once
+terminate?
+threadId?
+unref?
+
Methods
[captureRejectionSymbol]?
+addListener
+emit
+eventNames
+getMaxListeners
+listenerCount
+listeners
+off
+prependListener
+prependOnceListener
+rawListeners
+removeAllListeners
+removeListener
+setMaxListeners
+
Properties
Optional Readonly disconnect
disconnect?: (() => void)
Cluster worker disconnect.
+
Type declaration
(): void
Returns void
Defined in src/pools/worker.ts:252
Optional Readonly id
id?: number
Cluster worker id.
+
Defined in src/pools/worker.ts:219
Optional Readonly kill
kill?: ((signal?) => void)
Cluster worker kill.
+
Type declaration
(signal?): void
Parameters
Optional signal: string
Returns void
Defined in src/pools/worker.ts:256
Readonly on
on: ((event, handler) => this)
Registers an event handler.
+
Type declaration
(event, handler): this
Parameters
event: stringThe event.
+
handler: EventHandler<IWorker>The event handler.
+
Returns this
Overrides EventEmitter.on
Defined in src/pools/worker.ts:230
Readonly once
once: ((event, handler) => this)
Registers once an event handler.
+
Type declaration
(event, handler): this
Parameters
event: stringThe event.
+
handler: EventHandler<IWorker>The event handler.
+
Returns this
Overrides EventEmitter.once
Defined in src/pools/worker.ts:237
Optional Readonly terminate
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.
-
Type declaration
(): 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.
-
Returns Promise<number>
Defined in src/pools/worker.ts:248
Optional Readonly threadId
threadId?: number
Worker thread worker id.
-
Defined in src/pools/worker.ts:223
Optional Readonly unref
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.
-
Type declaration
(): void
Calling unref() on a worker allows the thread to exit if this is the only
+
Type declaration
(): Promise<number>
Returns Promise<number>
Defined in src/pools/worker.ts:248
Optional Readonly threadId
threadId?: number
Worker thread worker id.
+
Defined in src/pools/worker.ts:223
Optional Readonly unref
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.
-
Returns void
Since
v10.5.0
-
Since
v10.5.0
-
Defined in src/pools/worker.ts:243
Methods
Optional [captureRejectionSymbol]
[captureRejectionSymbol](error, event, ...args): void
Parameters
error: Error
event: string
Rest ...args: any[]
Returns void
Inherited from EventEmitter.[captureRejectionSymbol]
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:112
addListener
addListener(eventName, listener): this
Alias for emitter.on(eventName, listener).
-
Parameters
eventName: string | symbol
listener: ((...args) => void)
(...args): void
Parameters
Rest ...args: any[]
Returns void
Returns this
Since
v0.1.26
-
Inherited from EventEmitter.addListener
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:545
emit
emit(eventName, ...args): boolean
Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments
+
Type declaration
(): void
Returns void
Since
v10.5.0
+
Defined in src/pools/worker.ts:243
Methods
Optional [captureRejectionSymbol]
[captureRejectionSymbol]<K>(error, event, ...args): void
Type Parameters
K
Parameters
error: Error
event: string | symbol
Rest ...args: AnyRest
Returns void
Inherited from EventEmitter.[captureRejectionSymbol]
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:129
addListener
addListener<K>(eventName, listener): this
Alias for emitter.on(eventName, listener).
+
Type Parameters
K
Parameters
eventName: string | symbol
listener: ((...args) => void)(...args): void
Parameters
Rest ...args: any[]
Returns void
Returns this
Since
v0.1.26
+
Inherited from EventEmitter.addListener
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:562
emit
emit<K>(eventName, ...args): boolean
Synchronously calls each of the listeners registered for the event namedeventName, 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
 
-
Parameters
eventName: string | symbol
Rest ...args: any[]
Returns boolean
Since
v0.1.26
-
Inherited from EventEmitter.emit
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:807
eventNames
eventNames(): (string | symbol)[]
Returns an array listing the events for which the emitter has registered
+
Type Parameters
K
Parameters
eventName: string | symbol
Rest ...args: AnyRest
Returns boolean
Since
v0.1.26
+
Inherited from EventEmitter.emit
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:824
eventNames
eventNames(): (string | symbol)[]
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)[]
Since
v6.0.0
-
Inherited from EventEmitter.eventNames
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:870
getMaxListeners
getMaxListeners(): number
Returns the current max listener value for the EventEmitter which is either
+
Inherited from EventEmitter.eventNames
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:887
getMaxListeners
getMaxListeners(): number
Returns the current max listener value for the EventEmitter which is either
 set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.
 
Returns number
Since
v1.0.0
-
Inherited from EventEmitter.getMaxListeners
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:722
listenerCount
listenerCount(eventName, listener?): number
Returns the number of listeners listening for the event named eventName.
+
Inherited from EventEmitter.getMaxListeners
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:739
listenerCount
listenerCount<K>(eventName, listener?): number
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.
-
Parameters
eventName: string | symbol
The name of the event being listened for
-
Optional listener: Function
The event handler function
+
Type Parameters
K
Parameters
eventName: string | symbolThe name of the event being listened for
+
Optional listener: FunctionThe event handler function
 
Returns number
Since
v3.2.0
-
Inherited from EventEmitter.listenerCount
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:816
listeners
listeners(eventName): Function[]
Returns a copy of the array of listeners for the event named eventName.
+
Inherited from EventEmitter.listenerCount
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:833
listeners
listeners<K>(eventName): Function[]
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] ]
 
-
Parameters
eventName: string | symbol
Returns Function[]
Since
v0.1.26
-
Inherited from EventEmitter.listeners
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:735
off
off(eventName, listener): this
Alias for emitter.removeListener().
-
Parameters
eventName: string | symbol
listener: ((...args) => void)
(...args): void
Parameters
Rest ...args: any[]
Returns void
Returns this
Since
v10.0.0
-
Inherited from EventEmitter.off
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:695
prependListener
prependListener(eventName, listener): this
Adds the listener function to the beginning of the listeners array for the
+
Type Parameters
K
Parameters
eventName: string | symbol
Returns Function[]
Since
v0.1.26
+
Inherited from EventEmitter.listeners
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:752
off
off<K>(eventName, listener): this
Alias for emitter.removeListener().
+
Type Parameters
K
Parameters
eventName: string | symbol
listener: ((...args) => void)(...args): void
Parameters
Rest ...args: any[]
Returns void
Returns this
Since
v10.0.0
+
Inherited from EventEmitter.off
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:712
prependListener
prependListener<K>(eventName, listener): this
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 eventNameand 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.
-
Parameters
eventName: string | symbol
The name of the event.
-
listener: ((...args) => void)
The callback function
-
(...args): void
Parameters
Rest ...args: any[]
Returns void
Returns this
Since
v6.0.0
-
Inherited from EventEmitter.prependListener
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:834
prependOnceListener
prependOnceListener(eventName, listener): this
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 | symbolThe name of the event.
+
listener: ((...args) => void)The callback function
+
(...args): void
Parameters
Rest ...args: any[]
Returns void
Returns this
Since
v6.0.0
+
Inherited from EventEmitter.prependListener
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:851
prependOnceListener
prependOnceListener<K>(eventName, listener): this
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.
-
Parameters
eventName: string | symbol
The name of the event.
-
listener: ((...args) => void)
The callback function
-
(...args): void
Parameters
Rest ...args: any[]
Returns void
Returns this
Since
v6.0.0
-
Inherited from EventEmitter.prependOnceListener
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:850
rawListeners
rawListeners(eventName): Function[]
Returns a copy of the array of listeners for the event named eventName,
+
Type Parameters
K
Parameters
eventName: string | symbolThe name of the event.
+
listener: ((...args) => void)The callback function
+
(...args): void
Parameters
Rest ...args: any[]
Returns void
Returns this
Since
v6.0.0
+
Inherited from EventEmitter.prependOnceListener
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:867
rawListeners
rawListeners<K>(eventName): Function[]
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');
 
-
Parameters
eventName: string | symbol
Returns Function[]
Since
v9.4.0
-
Inherited from EventEmitter.rawListeners
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:766
removeAllListeners
removeAllListeners(event?): this
Removes all listeners, or those of the specified eventName.
+
Type Parameters
K
Parameters
eventName: string | symbol
Returns Function[]
Since
v9.4.0
+
Inherited from EventEmitter.rawListeners
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:783
removeAllListeners
removeAllListeners(event?): this
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
Optional event: string | symbol
Returns this
Since
v0.1.26
-
Inherited from EventEmitter.removeAllListeners
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:706
removeListener
removeListener(eventName, listener): this
Removes the specified listener from the listener array for the event namedeventName.
+
Parameters
Optional event: string | symbol
Returns this
Since
v0.1.26
+
Inherited from EventEmitter.removeAllListeners
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:723
removeListener
removeListener<K>(eventName, listener): this
Removes the specified listener from the listener array for the event namedeventName.
 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
@@ -129,11 +116,11 @@ recently added instance. In the example the once('ping')lis
 
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.
-
Parameters
eventName: string | symbol
listener: ((...args) => void)
(...args): void
Parameters
Rest ...args: any[]
Returns void
Returns this
Since
v0.1.26
-
Inherited from EventEmitter.removeListener
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:690
setMaxListeners
setMaxListeners(n): this
By default EventEmitters will print a warning if more than 10 listeners are
+
Type Parameters
K
Parameters
eventName: string | symbol
listener: ((...args) => void)(...args): void
Parameters
Rest ...args: any[]
Returns void
Returns this
Since
v0.1.26
+
Inherited from EventEmitter.removeListener
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:707
setMaxListeners
setMaxListeners(n): this
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 toInfinity (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
Since
v0.3.5
-
Inherited from EventEmitter.setMaxListeners
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:716
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
disconnect
id
kill
on
once
terminate
threadId
unref
[captureRejectionSymbol]
addListener
emit
eventNames
getMaxListeners
listenerCount
listeners
off
prependListener
prependOnceListener
rawListeners
removeAllListeners
removeListener
setMaxListeners
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+Parameters
n: number
Returns this
Since
v0.3.5
+
Inherited from EventEmitter.setMaxListeners
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:733
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
disconnect
id
kill
on
once
terminate
threadId
unref
[captureRejectionSymbol]
addListener
emit
eventNames
getMaxListeners
listenerCount
listeners
off
prependListener
prependOnceListener
rawListeners
removeAllListeners
removeListener
setMaxListeners
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html
index 6bc84d0e..aa2ba76f 100644
--- a/docs/interfaces/IWorkerChoiceStrategy.html
+++ b/docs/interfaces/IWorkerChoiceStrategy.html
@@ -1,39 +1,25 @@
-IWorkerChoiceStrategy | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
IWorkerChoiceStrategy
Interface IWorkerChoiceStrategyInternal 
Worker choice strategy interface.
-
interface IWorkerChoiceStrategy { 
Â Â Â Â choose: (() => undefined | number); 
Â Â Â Â remove: ((workerNodeKey) => boolean); 
Â Â Â Â reset: (() => boolean); 
Â Â Â Â setOptions: ((opts) => void); 
Â Â Â Â strategyPolicy: StrategyPolicy; 
Â Â Â Â taskStatisticsRequirements: TaskStatisticsRequirements; 
Â Â Â Â update: ((workerNodeKey) => boolean); 
}
Defined in src/pools/selection-strategies/selection-strategies-types.ts:162
 Index
Properties
choose
-remove
-reset
-setOptions
-strategyPolicy
-taskStatisticsRequirements
-update
-
Properties
Readonly choose
choose: (() => undefined | number)
Chooses a worker node in the pool and returns its key.
+IWorkerChoiceStrategy | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
IWorkerChoiceStrategy
Interface IWorkerChoiceStrategyInternal 
Worker choice strategy interface.
+
interface IWorkerChoiceStrategy { 
Â Â Â Â choose: (() => undefined | number); 
Â Â Â Â remove: ((workerNodeKey) => boolean); 
Â Â Â Â reset: (() => boolean); 
Â Â Â Â setOptions: ((opts) => void); 
Â Â Â Â strategyPolicy: StrategyPolicy; 
Â Â Â Â taskStatisticsRequirements: TaskStatisticsRequirements; 
Â Â Â Â update: ((workerNodeKey) => boolean); 
}
Defined in src/pools/selection-strategies/selection-strategies-types.ts:162
 Index
Properties
choose
+remove
+reset
+setOptions
+strategyPolicy
+taskStatisticsRequirements
+update
+
Properties
Readonly choose
choose: (() => undefined | number)
Chooses a worker node in the pool and returns its key.
 If no worker nodes are not eligible, undefined is returned.
 If undefined is returned, the caller retry.
-
Type declaration
(): undefined | number
Chooses a worker node in the pool and returns its key.
-If no worker nodes are not eligible, undefined is returned.
-If undefined is returned, the caller retry.
-
Returns undefined | number
The worker node key or undefined.
-
Returns
The worker node key or undefined.
-
Defined in src/pools/selection-strategies/selection-strategies-types.ts:191
Readonly remove
remove: ((workerNodeKey) => boolean)
Removes the worker node key from strategy internals.
-
Type declaration
(workerNodeKey): boolean
Removes the worker node key from strategy internals.
-
Parameters
workerNodeKey: number
The worker node key.
-
Returns boolean
true if the worker node key is removed, false otherwise.
-
Param: workerNodeKey
The worker node key.
-Returns
true if the worker node key is removed, false otherwise.
-
Defined in src/pools/selection-strategies/selection-strategies-types.ts:198
Readonly reset
reset: (() => boolean)
Resets strategy internals.
-
Type declaration
(): boolean
Resets strategy internals.
-
Returns boolean
true if the reset is successful, false otherwise.
-
Returns
true if the reset is successful, false otherwise.
-
Defined in src/pools/selection-strategies/selection-strategies-types.ts:176
Readonly setOptions
setOptions: ((opts) => void)
Sets the worker choice strategy options.
-
Type declaration
(opts): void
Sets the worker choice strategy options.
-
Parameters
opts: undefined | WorkerChoiceStrategyOptions
The worker choice strategy options.
-
Returns void
Param: opts
The worker choice strategy options.
-
Defined in src/pools/selection-strategies/selection-strategies-types.ts:204
Readonly strategyPolicy
strategyPolicy: StrategyPolicy
Strategy policy.
-
Defined in src/pools/selection-strategies/selection-strategies-types.ts:166
Readonly taskStatisticsRequirements
taskStatisticsRequirements: TaskStatisticsRequirements
Tasks statistics requirements.
-
Defined in src/pools/selection-strategies/selection-strategies-types.ts:170
Readonly update
update: ((workerNodeKey) => boolean)
Updates the worker node key strategy internals.
-This is called after a task has been executed on a worker node.
-
Type declaration
(workerNodeKey): boolean
Updates the worker node key strategy internals.
+
Type declaration
(): undefined | number
Returns undefined | number
Returns
The worker node key or undefined.
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:191
Readonly remove
remove: ((workerNodeKey) => boolean)
Removes the worker node key from strategy internals.
+
Type declaration
(workerNodeKey): boolean
Parameters
workerNodeKey: numberThe worker node key.
+
Returns boolean
Returns
true if the worker node key is removed, false otherwise.
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:198
Readonly reset
reset: (() => boolean)
Resets strategy internals.
+
Type declaration
(): boolean
Returns boolean
Returns
true if the reset is successful, false otherwise.
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:176
Readonly setOptions
setOptions: ((opts) => void)
Sets the worker choice strategy options.
+
Type declaration
(opts): void
Parameters
opts: undefined | WorkerChoiceStrategyOptionsThe worker choice strategy options.
+
Returns void
Defined in src/pools/selection-strategies/selection-strategies-types.ts:204
Readonly strategyPolicy
strategyPolicy: StrategyPolicy
Strategy policy.
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:166
Readonly taskStatisticsRequirements
taskStatisticsRequirements: TaskStatisticsRequirements
Tasks statistics requirements.
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:170
Readonly update
update: ((workerNodeKey) => boolean)
Updates the worker node key strategy internals.
 This is called after a task has been executed on a worker node.
-
Parameters
workerNodeKey: number
Returns boolean
true if the update is successful, false otherwise.
-
Returns
true if the update is successful, false otherwise.
-
Defined in src/pools/selection-strategies/selection-strategies-types.ts:183
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
choose
remove
reset
setOptions
strategyPolicy
taskStatisticsRequirements
update
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+Type declaration
(workerNodeKey): boolean
Parameters
workerNodeKey: number
Returns boolean
Returns
true if the update is successful, false otherwise.
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:183
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
choose
remove
reset
setOptions
strategyPolicy
taskStatisticsRequirements
update
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html
index 04b816a5..6f7eacda 100644
--- a/docs/interfaces/IWorkerNode.html
+++ b/docs/interfaces/IWorkerNode.html
@@ -1,136 +1,107 @@
-IWorkerNode | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
IWorkerNode
Interface IWorkerNode<Worker, Data>Internal 
Worker node interface.
-
interface IWorkerNode<Worker, Data> { 
Â Â Â Â clearTasksQueue: (() => void); 
Â Â Â Â deleteTaskFunctionWorkerUsage: ((name) => boolean); 
Â Â Â Â dequeueTask: (() => undefined | Task<Data>); 
Â Â Â Â enqueueTask: ((task) => number); 
Â Â Â Â getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage); 
Â Â Â Â hasBackPressure: (() => boolean); 
Â Â Â Â info: WorkerInfo; 
Â Â Â Â messageChannel?: MessageChannel; 
Â Â Â Â popTask: (() => undefined | Task<Data>); 
Â Â Â Â registerOnceWorkerEventHandler: ((event, handler) => void); 
Â Â Â Â registerWorkerEventHandler: ((event, handler) => void); 
Â Â Â Â resetUsage: (() => void); 
Â Â Â Â strategyData?: StrategyData; 
Â Â Â Â tasksQueueBackPressureSize: number; 
Â Â Â Â tasksQueueSize: (() => number); 
Â Â Â Â terminate: (() => Promise<void>); 
Â Â Â Â unshiftTask: ((task) => number); 
Â Â Â Â usage: WorkerUsage; 
Â Â Â Â worker: Worker; 
Â Â Â Â [captureRejectionSymbol]?(error, event, ...args): void; 
Â Â Â Â addListener(eventName, listener): this; 
Â Â Â Â emit(eventName, ...args): boolean; 
Â Â Â Â eventNames(): (string | symbol)[]; 
Â Â Â Â getMaxListeners(): number; 
Â Â Â Â listenerCount(eventName, listener?): number; 
Â Â Â Â listeners(eventName): Function[]; 
Â Â Â Â off(eventName, listener): this; 
Â Â Â Â on(eventName, listener): this; 
Â Â Â Â once(eventName, listener): this; 
Â Â Â Â prependListener(eventName, listener): this; 
Â Â Â Â prependOnceListener(eventName, listener): this; 
Â Â Â Â rawListeners(eventName): Function[]; 
Â Â Â Â removeAllListeners(event?): this; 
Â Â Â Â removeListener(eventName, listener): this; 
Â Â Â Â setMaxListeners(n): 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
EventEmitterIWorkerNode
Defined in src/pools/worker.ts:277
 Index
Properties
clearTasksQueue
-deleteTaskFunctionWorkerUsage
-dequeueTask
-enqueueTask
-getTaskFunctionWorkerUsage
-hasBackPressure
-info
-messageChannel?
-popTask
-registerOnceWorkerEventHandler
-registerWorkerEventHandler
-resetUsage
-strategyData?
-tasksQueueBackPressureSize
-tasksQueueSize
-terminate
-unshiftTask
-usage
-worker
-
Methods
[captureRejectionSymbol]?
-addListener
-emit
-eventNames
-getMaxListeners
-listenerCount
-listeners
-off
-on
-once
-prependListener
-prependOnceListener
-rawListeners
-removeAllListeners
-removeListener
-setMaxListeners
-
Properties
Readonly clearTasksQueue
clearTasksQueue: (() => void)
Clears tasks queue.
-
Type declaration
(): void
Clears tasks queue.
-
Returns void
Defined in src/pools/worker.ts:340
Readonly deleteTaskFunctionWorkerUsage
deleteTaskFunctionWorkerUsage: ((name) => boolean)
Deletes task function worker usage statistics.
-
Type declaration
(name): boolean
Deletes task function worker usage statistics.
-
Parameters
name: string
The task function name.
-
Returns boolean
true if the task function worker usage statistics were deleted, false otherwise.
-
Param: name
The task function name.
-Returns
true if the task function worker usage statistics were deleted, false otherwise.
-
Defined in src/pools/worker.ts:388
Readonly dequeueTask
dequeueTask: (() => undefined | Task<Data>)
Dequeue task.
-
Type declaration
(): undefined | Task<Data>
Dequeue task.
-
Returns undefined | Task<Data>
The dequeued task.
-
Returns
The dequeued task.
-
Defined in src/pools/worker.ts:330
Readonly enqueueTask
enqueueTask: ((task) => number)
Enqueue task.
-
Type declaration
(task): number
Enqueue task.
-
Parameters
task: Task<Data>
The task to queue.
-
Returns number
The tasks queue size.
-
Param: task
The task to queue.
-Returns
The tasks queue size.
-
Defined in src/pools/worker.ts:317
Readonly getTaskFunctionWorkerUsage
getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)
Gets task function worker usage statistics.
-
Type declaration
(name): undefined | WorkerUsage
Gets task function worker usage statistics.
-
Parameters
name: string
The task function name.
-
Returns undefined | WorkerUsage
The task function worker usage statistics if the task function worker usage statistics are initialized, undefined otherwise.
-
Param: name
The task function name.
-Returns
The task function worker usage statistics if the task function worker usage statistics are initialized, undefined otherwise.
-
Defined in src/pools/worker.ts:381
Readonly hasBackPressure
hasBackPressure: (() => boolean)
Whether the worker node has back pressure (i.e. its tasks queue is full).
-
Type declaration
(): boolean
Whether the worker node has back pressure (i.e. its tasks queue is full).
-
Returns boolean
true if the worker node has back pressure, false otherwise.
-
Returns
true if the worker node has back pressure, false otherwise.
-
Defined in src/pools/worker.ts:346
Readonly info
info: WorkerInfo
Worker info.
-
Defined in src/pools/worker.ts:286
Optional Readonly messageChannel
messageChannel?: MessageChannel
Message channel (worker thread only).
-
Defined in src/pools/worker.ts:299
Readonly popTask
popTask: (() => undefined | Task<Data>)
Pops a task from the tasks queue.
-
Type declaration
(): undefined | Task<Data>
Pops a task from the tasks queue.
-
Returns undefined | Task<Data>
The popped task.
-
Returns
The popped task.
-
Defined in src/pools/worker.ts:336
Readonly registerOnceWorkerEventHandler
registerOnceWorkerEventHandler: ((event, handler) => void)
Registers once a worker event handler.
-
Type declaration
(event, handler): void
Registers once a worker event handler.
-
Parameters
event: string
The event.
-
handler: EventHandler<Worker>
The event handler.
-
Returns void
Param: event
The event.
-Param: handler
The event handler.
-
Defined in src/pools/worker.ts:371
Readonly registerWorkerEventHandler
registerWorkerEventHandler: ((event, handler) => void)
Registers a worker event handler.
-
Type declaration
(event, handler): void
Registers a worker event handler.
-
Parameters
event: string
The event.
-
handler: EventHandler<Worker>
The event handler.
-
Returns void
Param: event
The event.
-Param: handler
The event handler.
-
Defined in src/pools/worker.ts:361
Readonly resetUsage
resetUsage: (() => void)
Resets usage statistics.
-
Type declaration
(): void
Resets usage statistics.
-
Returns void
Defined in src/pools/worker.ts:350
Optional strategyData
strategyData?: StrategyData
Worker choice strategy data.
+IWorkerNode | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
IWorkerNode
Interface IWorkerNode<Worker, Data>Internal 
Worker node interface.
+
interface IWorkerNode<Worker, Data> { 
Â Â Â Â clearTasksQueue: (() => void); 
Â Â Â Â deleteTaskFunctionWorkerUsage: ((name) => boolean); 
Â Â Â Â dequeueTask: (() => undefined | Task<Data>); 
Â Â Â Â enqueueTask: ((task) => number); 
Â Â Â Â getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage); 
Â Â Â Â hasBackPressure: (() => boolean); 
Â Â Â Â info: WorkerInfo; 
Â Â Â Â messageChannel?: MessageChannel; 
Â Â Â Â popTask: (() => undefined | Task<Data>); 
Â Â Â Â registerOnceWorkerEventHandler: ((event, handler) => void); 
Â Â Â Â registerWorkerEventHandler: ((event, handler) => void); 
Â Â Â Â resetUsage: (() => void); 
Â Â Â Â strategyData?: StrategyData; 
Â Â Â Â tasksQueueBackPressureSize: number; 
Â Â Â Â tasksQueueSize: (() => number); 
Â Â Â Â terminate: (() => Promise<void>); 
Â Â Â Â unshiftTask: ((task) => number); 
Â Â Â Â usage: WorkerUsage; 
Â Â Â Â worker: Worker; 
Â Â Â Â [captureRejectionSymbol]?<K>(error, event, ...args): void; 
Â Â Â Â addListener<K>(eventName, listener): this; 
Â Â Â Â emit<K>(eventName, ...args): boolean; 
Â Â Â Â eventNames(): (string | symbol)[]; 
Â Â Â Â getMaxListeners(): number; 
Â Â Â Â listenerCount<K>(eventName, listener?): number; 
Â Â Â Â listeners<K>(eventName): Function[]; 
Â Â Â Â off<K>(eventName, listener): this; 
Â Â Â Â on<K>(eventName, listener): this; 
Â Â Â Â once<K>(eventName, listener): this; 
Â Â Â Â prependListener<K>(eventName, listener): this; 
Â Â Â Â prependOnceListener<K>(eventName, listener): this; 
Â Â Â Â rawListeners<K>(eventName): Function[]; 
Â Â Â Â removeAllListeners(event?): this; 
Â Â Â Â removeListener<K>(eventName, listener): this; 
Â Â Â Â setMaxListeners(n): this; 
}
 Type Parameters
Worker extends IWorkerType of worker.
+
Data = unknownType of data sent to the worker. This can only be structured-cloneable data.
+
 Hierarchy
EventEmitterIWorkerNode
Defined in src/pools/worker.ts:277
 Index
Properties
clearTasksQueue
+deleteTaskFunctionWorkerUsage
+dequeueTask
+enqueueTask
+getTaskFunctionWorkerUsage
+hasBackPressure
+info
+messageChannel?
+popTask
+registerOnceWorkerEventHandler
+registerWorkerEventHandler
+resetUsage
+strategyData?
+tasksQueueBackPressureSize
+tasksQueueSize
+terminate
+unshiftTask
+usage
+worker
+
Methods
[captureRejectionSymbol]?
+addListener
+emit
+eventNames
+getMaxListeners
+listenerCount
+listeners
+off
+on
+once
+prependListener
+prependOnceListener
+rawListeners
+removeAllListeners
+removeListener
+setMaxListeners
+
Properties
Readonly clearTasksQueue
clearTasksQueue: (() => void)
Clears tasks queue.
+
Type declaration
(): void
Returns void
Defined in src/pools/worker.ts:340
Readonly deleteTaskFunctionWorkerUsage
deleteTaskFunctionWorkerUsage: ((name) => boolean)
Deletes task function worker usage statistics.
+
Type declaration
(name): boolean
Parameters
name: stringThe task function name.
+
Returns boolean
Returns
true if the task function worker usage statistics were deleted, false otherwise.
+
Defined in src/pools/worker.ts:388
Readonly dequeueTask
dequeueTask: (() => undefined | Task<Data>)
Dequeue task.
+
Type declaration
(): undefined | Task<Data>
Returns undefined | Task<Data>
Returns
The dequeued task.
+
Defined in src/pools/worker.ts:330
Readonly enqueueTask
enqueueTask: ((task) => number)
Enqueue task.
+
Type declaration
(task): number
Parameters
task: Task<Data>The task to queue.
+
Returns number
Returns
The tasks queue size.
+
Defined in src/pools/worker.ts:317
Readonly getTaskFunctionWorkerUsage
getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)
Gets task function worker usage statistics.
+
Type declaration
(name): undefined | WorkerUsage
Parameters
name: stringThe task function name.
+
Returns undefined | WorkerUsage
Returns
The task function worker usage statistics if the task function worker usage statistics are initialized, undefined otherwise.
+
Defined in src/pools/worker.ts:381
Readonly hasBackPressure
hasBackPressure: (() => boolean)
Whether the worker node has back pressure (i.e. its tasks queue is full).
+
Type declaration
(): boolean
Returns boolean
Returns
true if the worker node has back pressure, false otherwise.
+
Defined in src/pools/worker.ts:346
Readonly info
info: WorkerInfo
Worker info.
+
Defined in src/pools/worker.ts:286
Optional Readonly messageChannel
messageChannel?: MessageChannel
Message channel (worker thread only).
+
Defined in src/pools/worker.ts:299
Readonly popTask
popTask: (() => undefined | Task<Data>)
Pops a task from the tasks queue.
+
Type declaration
(): undefined | Task<Data>
Returns undefined | Task<Data>
Returns
The popped task.
+
Defined in src/pools/worker.ts:336
Readonly registerOnceWorkerEventHandler
registerOnceWorkerEventHandler: ((event, handler) => void)
Registers once a worker event handler.
+
Type declaration
(event, handler): void
Parameters
event: stringThe event.
+
handler: EventHandler<Worker>The event handler.
+
Returns void
Defined in src/pools/worker.ts:371
Readonly registerWorkerEventHandler
registerWorkerEventHandler: ((event, handler) => void)
Registers a worker event handler.
+
Type declaration
(event, handler): void
Parameters
event: stringThe event.
+
handler: EventHandler<Worker>The event handler.
+
Returns void
Defined in src/pools/worker.ts:361
Readonly resetUsage
resetUsage: (() => void)
Resets usage statistics.
+
Type declaration
(): void
Returns void
Defined in src/pools/worker.ts:350
Optional strategyData
strategyData?: StrategyData
Worker choice strategy data.
 This is used to store data that are specific to the worker choice strategy.
-
Defined in src/pools/worker.ts:295
tasksQueueBackPressureSize
tasksQueueBackPressureSize: number
Tasks queue back pressure size.
+
Defined in src/pools/worker.ts:295
tasksQueueBackPressureSize
tasksQueueBackPressureSize: number
Tasks queue back pressure size.
 This is the number of tasks that can be enqueued before the worker node has back pressure.
-
Defined in src/pools/worker.ts:304
Readonly tasksQueueSize
tasksQueueSize: (() => number)
Tasks queue size.
-
Type declaration
(): number
Tasks queue size.
-
Returns number
The tasks queue size.
-
Returns
The tasks queue size.
-
Defined in src/pools/worker.ts:310
Readonly terminate
terminate: (() => Promise<void>)
Terminates the worker node.
-
Type declaration
(): Promise<void>
Terminates the worker node.
-
Returns Promise<void>
Defined in src/pools/worker.ts:354
Readonly unshiftTask
unshiftTask: ((task) => number)
Prepends a task to the tasks queue.
-
Type declaration
(task): number
Prepends a task to the tasks queue.
-
Parameters
task: Task<Data>
The task to prepend.
-
Returns number
The tasks queue size.
-
Param: task
The task to prepend.
-Returns
The tasks queue size.
-
Defined in src/pools/worker.ts:324
Readonly usage
usage: WorkerUsage
Worker usage statistics.
-
Defined in src/pools/worker.ts:290
Readonly worker
worker: Worker
Worker.
-
Defined in src/pools/worker.ts:282
Methods
Optional [captureRejectionSymbol]
[captureRejectionSymbol](error, event, ...args): void
Parameters
error: Error
event: string
Rest ...args: any[]
Returns void
Inherited from EventEmitter.[captureRejectionSymbol]
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:112
addListener
addListener(eventName, listener): this
Alias for emitter.on(eventName, listener).
-
Parameters
eventName: string | symbol
listener: ((...args) => void)
(...args): void
Parameters
Rest ...args: any[]
Returns void
Returns this
Since
v0.1.26
-
Inherited from EventEmitter.addListener
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:545
emit
emit(eventName, ...args): boolean
Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments
+
Defined in src/pools/worker.ts:304
Readonly tasksQueueSize
tasksQueueSize: (() => number)
Tasks queue size.
+
Type declaration
(): number
Returns number
Returns
The tasks queue size.
+
Defined in src/pools/worker.ts:310
Readonly terminate
terminate: (() => Promise<void>)
Terminates the worker node.
+
Type declaration
(): Promise<void>
Returns Promise<void>
Defined in src/pools/worker.ts:354
Readonly unshiftTask
unshiftTask: ((task) => number)
Prepends a task to the tasks queue.
+
Type declaration
(task): number
Parameters
task: Task<Data>The task to prepend.
+
Returns number
Returns
The tasks queue size.
+
Defined in src/pools/worker.ts:324
Readonly usage
usage: WorkerUsage
Worker usage statistics.
+
Defined in src/pools/worker.ts:290
Readonly worker
worker: Worker
Worker.
+
Defined in src/pools/worker.ts:282
Methods
Optional [captureRejectionSymbol]
[captureRejectionSymbol]<K>(error, event, ...args): void
Type Parameters
K
Parameters
error: Error
event: string | symbol
Rest ...args: AnyRest
Returns void
Inherited from EventEmitter.[captureRejectionSymbol]
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:129
addListener
addListener<K>(eventName, listener): this
Alias for emitter.on(eventName, listener).
+
Type Parameters
K
Parameters
eventName: string | symbol
listener: ((...args) => void)(...args): void
Parameters
Rest ...args: any[]
Returns void
Returns this
Since
v0.1.26
+
Inherited from EventEmitter.addListener
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:562
emit
emit<K>(eventName, ...args): boolean
Synchronously calls each of the listeners registered for the event namedeventName, 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
 
-
Parameters
eventName: string | symbol
Rest ...args: any[]
Returns boolean
Since
v0.1.26
-
Inherited from EventEmitter.emit
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:807
eventNames
eventNames(): (string | symbol)[]
Returns an array listing the events for which the emitter has registered
+
Type Parameters
K
Parameters
eventName: string | symbol
Rest ...args: AnyRest
Returns boolean
Since
v0.1.26
+
Inherited from EventEmitter.emit
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:824
eventNames
eventNames(): (string | symbol)[]
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)[]
Since
v6.0.0
-
Inherited from EventEmitter.eventNames
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:870
getMaxListeners
getMaxListeners(): number
Returns the current max listener value for the EventEmitter which is either
+
Inherited from EventEmitter.eventNames
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:887
getMaxListeners
getMaxListeners(): number
Returns the current max listener value for the EventEmitter which is either
 set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.
 
Returns number
Since
v1.0.0
-
Inherited from EventEmitter.getMaxListeners
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:722
listenerCount
listenerCount(eventName, listener?): number
Returns the number of listeners listening for the event named eventName.
+
Inherited from EventEmitter.getMaxListeners
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:739
listenerCount
listenerCount<K>(eventName, listener?): number
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.
-
Parameters
eventName: string | symbol
The name of the event being listened for
-
Optional listener: Function
The event handler function
+
Type Parameters
K
Parameters
eventName: string | symbolThe name of the event being listened for
+
Optional listener: FunctionThe event handler function
 
Returns number
Since
v3.2.0
-
Inherited from EventEmitter.listenerCount
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:816
listeners
listeners(eventName): Function[]
Returns a copy of the array of listeners for the event named eventName.
+
Inherited from EventEmitter.listenerCount
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:833
listeners
listeners<K>(eventName): Function[]
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] ]
 
-
Parameters
eventName: string | symbol
Returns Function[]
Since
v0.1.26
-
Inherited from EventEmitter.listeners
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:735
off
off(eventName, listener): this
Alias for emitter.removeListener().
-
Parameters
eventName: string | symbol
listener: ((...args) => void)
(...args): void
Parameters
Rest ...args: any[]
Returns void
Returns this
Since
v10.0.0
-
Inherited from EventEmitter.off
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:695
on
on(eventName, listener): this
Adds the listener function to the end of the listeners array for the
+
Type Parameters
K
Parameters
eventName: string | symbol
Returns Function[]
Since
v0.1.26
+
Inherited from EventEmitter.listeners
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:752
off
off<K>(eventName, listener): this
Alias for emitter.removeListener().
+
Type Parameters
K
Parameters
eventName: string | symbol
listener: ((...args) => void)(...args): void
Parameters
Rest ...args: any[]
Returns void
Returns this
Since
v10.0.0
+
Inherited from EventEmitter.off
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:712
on
on<K>(eventName, listener): this
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 eventNameand listener will result in the listener being added, and called, multiple
 times.
@@ -141,10 +112,10 @@ times.
 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
 
-
Parameters
eventName: string | symbol
The name of the event.
-
listener: ((...args) => void)
The callback function
-
(...args): void
Parameters
Rest ...args: any[]
Returns void
Returns this
Since
v0.1.101
-
Inherited from EventEmitter.on
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:577
once
once(eventName, listener): this
Adds a one-timelistener function for the event named eventName. The
+
Type Parameters
K
Parameters
eventName: string | symbolThe name of the event.
+
listener: ((...args) => void)The callback function
+
(...args): void
Parameters
Rest ...args: any[]
Returns void
Returns this
Since
v0.1.101
+
Inherited from EventEmitter.on
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:594
once
once<K>(eventName, listener): this
Adds a one-timelistener 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!');
});
 
@@ -153,39 +124,39 @@ next time eventName is triggered, this listener is removed and then
 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
 
-
Parameters
eventName: string | symbol
The name of the event.
-
listener: ((...args) => void)
The callback function
-
(...args): void
Parameters
Rest ...args: any[]
Returns void
Returns this
Since
v0.3.0
-
Inherited from EventEmitter.once
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:607
prependListener
prependListener(eventName, listener): this
Adds the listener function to the beginning of the listeners array for the
+
Type Parameters
K
Parameters
eventName: string | symbolThe name of the event.
+
listener: ((...args) => void)The callback function
+
(...args): void
Parameters
Rest ...args: any[]
Returns void
Returns this
Since
v0.3.0
+
Inherited from EventEmitter.once
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:624
prependListener
prependListener<K>(eventName, listener): this
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 eventNameand 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.
-
Parameters
eventName: string | symbol
The name of the event.
-
listener: ((...args) => void)
The callback function
-
(...args): void
Parameters
Rest ...args: any[]
Returns void
Returns this
Since
v6.0.0
-
Inherited from EventEmitter.prependListener
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:834
prependOnceListener
prependOnceListener(eventName, listener): this
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 | symbolThe name of the event.
+
listener: ((...args) => void)The callback function
+
(...args): void
Parameters
Rest ...args: any[]
Returns void
Returns this
Since
v6.0.0
+
Inherited from EventEmitter.prependListener
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:851
prependOnceListener
prependOnceListener<K>(eventName, listener): this
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.
-
Parameters
eventName: string | symbol
The name of the event.
-
listener: ((...args) => void)
The callback function
-
(...args): void
Parameters
Rest ...args: any[]
Returns void
Returns this
Since
v6.0.0
-
Inherited from EventEmitter.prependOnceListener
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:850
rawListeners
rawListeners(eventName): Function[]
Returns a copy of the array of listeners for the event named eventName,
+
Type Parameters
K
Parameters
eventName: string | symbolThe name of the event.
+
listener: ((...args) => void)The callback function
+
(...args): void
Parameters
Rest ...args: any[]
Returns void
Returns this
Since
v6.0.0
+
Inherited from EventEmitter.prependOnceListener
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:867
rawListeners
rawListeners<K>(eventName): Function[]
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');
 
-
Parameters
eventName: string | symbol
Returns Function[]
Since
v9.4.0
-
Inherited from EventEmitter.rawListeners
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:766
removeAllListeners
removeAllListeners(event?): this
Removes all listeners, or those of the specified eventName.
+
Type Parameters
K
Parameters
eventName: string | symbol
Returns Function[]
Since
v9.4.0
+
Inherited from EventEmitter.rawListeners
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:783
removeAllListeners
removeAllListeners(event?): this
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
Optional event: string | symbol
Returns this
Since
v0.1.26
-
Inherited from EventEmitter.removeAllListeners
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:706
removeListener
removeListener(eventName, listener): this
Removes the specified listener from the listener array for the event namedeventName.
+
Parameters
Optional event: string | symbol
Returns this
Since
v0.1.26
+
Inherited from EventEmitter.removeAllListeners
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:723
removeListener
removeListener<K>(eventName, listener): this
Removes the specified listener from the listener array for the event namedeventName.
 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
@@ -208,11 +179,11 @@ recently added instance. In the example the once('ping')lis
 
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.
-
Parameters
eventName: string | symbol
listener: ((...args) => void)
(...args): void
Parameters
Rest ...args: any[]
Returns void
Returns this
Since
v0.1.26
-
Inherited from EventEmitter.removeListener
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:690
setMaxListeners
setMaxListeners(n): this
By default EventEmitters will print a warning if more than 10 listeners are
+
Type Parameters
K
Parameters
eventName: string | symbol
listener: ((...args) => void)(...args): void
Parameters
Rest ...args: any[]
Returns void
Returns this
Since
v0.1.26
+
Inherited from EventEmitter.removeListener
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:707
setMaxListeners
setMaxListeners(n): this
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 toInfinity (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
Since
v0.3.5
-
Inherited from EventEmitter.setMaxListeners
Defined in node_modules/.pnpm/@types+node@20.11.20/node_modules/@types/node/events.d.ts:716
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
clearTasksQueue
deleteTaskFunctionWorkerUsage
dequeueTask
enqueueTask
getTaskFunctionWorkerUsage
hasBackPressure
info
messageChannel
popTask
registerOnceWorkerEventHandler
registerWorkerEventHandler
resetUsage
strategyData
tasksQueueBackPressureSize
tasksQueueSize
terminate
unshiftTask
usage
worker
[captureRejectionSymbol]
addListener
emit
eventNames
getMaxListeners
listenerCount
listeners
off
on
once
prependListener
prependOnceListener
rawListeners
removeAllListeners
removeListener
setMaxListeners
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+
Parameters
n: number
Returns this
Since
v0.3.5
+
Inherited from EventEmitter.setMaxListeners
Defined in node_modules/.pnpm/@types+node@20.11.24/node_modules/@types/node/events.d.ts:733
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
clearTasksQueue
deleteTaskFunctionWorkerUsage
dequeueTask
enqueueTask
getTaskFunctionWorkerUsage
hasBackPressure
info
messageChannel
popTask
registerOnceWorkerEventHandler
registerWorkerEventHandler
resetUsage
strategyData
tasksQueueBackPressureSize
tasksQueueSize
terminate
unshiftTask
usage
worker
[captureRejectionSymbol]
addListener
emit
eventNames
getMaxListeners
listenerCount
listeners
off
on
once
prependListener
prependOnceListener
rawListeners
removeAllListeners
removeListener
setMaxListeners
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/MeasurementOptions.html b/docs/interfaces/MeasurementOptions.html
index 0bb3a907..7ce15033 100644
--- a/docs/interfaces/MeasurementOptions.html
+++ b/docs/interfaces/MeasurementOptions.html
@@ -1,4 +1,4 @@
-MeasurementOptions | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
MeasurementOptions
Interface MeasurementOptions
Measurement options.
-
interface MeasurementOptions { 
Â Â Â Â median: boolean; 
}
Defined in src/pools/selection-strategies/selection-strategies-types.ts:59
 Index
Properties
median
-
Properties
Readonly median
median: boolean
Set measurement median.
-
Defined in src/pools/selection-strategies/selection-strategies-types.ts:63
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
median
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+MeasurementOptions | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
MeasurementOptions
Interface MeasurementOptions
Measurement options.
+
interface MeasurementOptions { 
Â Â Â Â median: boolean; 
}
Defined in src/pools/selection-strategies/selection-strategies-types.ts:59
 Index
Properties
median
+
Properties
Readonly median
median: boolean
Set measurement median.
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:63
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
median
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/MeasurementStatistics.html b/docs/interfaces/MeasurementStatistics.html
index b1e9d5d2..0e7c96b8 100644
--- a/docs/interfaces/MeasurementStatistics.html
+++ b/docs/interfaces/MeasurementStatistics.html
@@ -1,14 +1,14 @@
-MeasurementStatistics | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
MeasurementStatistics
Interface MeasurementStatisticsInternal 
Measurement statistics.
-
interface MeasurementStatistics { 
Â Â Â Â aggregate?: number; 
Â Â Â Â average?: number; 
Â Â Â Â history: CircularArray<number>; 
Â Â Â Â maximum?: number; 
Â Â Â Â median?: number; 
Â Â Â Â minimum?: number; 
}
Defined in src/pools/worker.ts:59
 Index
Properties
aggregate?
-average?
-history
-maximum?
-median?
-minimum?
-
Properties
Optional aggregate
aggregate?: number
Measurement aggregate.
-
Defined in src/pools/worker.ts:63
Optional average
average?: number
Measurement average.
-
Defined in src/pools/worker.ts:75
Readonly history
history: CircularArray<number>
Measurement history.
-
Defined in src/pools/worker.ts:83
Optional maximum
maximum?: number
Measurement maximum.
-
Defined in src/pools/worker.ts:71
Optional median
median?: number
Measurement median.
-
Defined in src/pools/worker.ts:79
Optional minimum
minimum?: number
Measurement minimum.
-
Defined in src/pools/worker.ts:67
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
aggregate
average
history
maximum
median
minimum
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+MeasurementStatistics | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
MeasurementStatistics
Interface MeasurementStatisticsInternal 
Measurement statistics.
+
interface MeasurementStatistics { 
Â Â Â Â aggregate?: number; 
Â Â Â Â average?: number; 
Â Â Â Â history: CircularArray<number>; 
Â Â Â Â maximum?: number; 
Â Â Â Â median?: number; 
Â Â Â Â minimum?: number; 
}
Defined in src/pools/worker.ts:59
 Index
Properties
aggregate?
+average?
+history
+maximum?
+median?
+minimum?
+
Properties
Optional aggregate
aggregate?: number
Measurement aggregate.
+
Defined in src/pools/worker.ts:63
Optional average
average?: number
Measurement average.
+
Defined in src/pools/worker.ts:75
Readonly history
history: CircularArray<number>
Measurement history.
+
Defined in src/pools/worker.ts:83
Optional maximum
maximum?: number
Measurement maximum.
+
Defined in src/pools/worker.ts:71
Optional median
median?: number
Measurement median.
+
Defined in src/pools/worker.ts:79
Optional minimum
minimum?: number
Measurement minimum.
+
Defined in src/pools/worker.ts:67
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
aggregate
average
history
maximum
median
minimum
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/MeasurementStatisticsRequirements.html b/docs/interfaces/MeasurementStatisticsRequirements.html
index 566567be..e312b77e 100644
--- a/docs/interfaces/MeasurementStatisticsRequirements.html
+++ b/docs/interfaces/MeasurementStatisticsRequirements.html
@@ -1,8 +1,8 @@
-MeasurementStatisticsRequirements | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
MeasurementStatisticsRequirements
Interface MeasurementStatisticsRequirementsInternal 
Measurement statistics requirements.
-
interface MeasurementStatisticsRequirements { 
Â Â Â Â aggregate: boolean; 
Â Â Â Â average: boolean; 
Â Â Â Â median: boolean; 
}
Defined in src/pools/selection-strategies/selection-strategies-types.ts:106
 Index
Properties
aggregate
-average
-median
-
Properties
aggregate
aggregate: boolean
Requires measurement aggregate.
-
Defined in src/pools/selection-strategies/selection-strategies-types.ts:110
average
average: boolean
Requires measurement average.
-
Defined in src/pools/selection-strategies/selection-strategies-types.ts:114
median
median: boolean
Requires measurement median.
-
Defined in src/pools/selection-strategies/selection-strategies-types.ts:118
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
aggregate
average
median
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+MeasurementStatisticsRequirements | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
MeasurementStatisticsRequirements
Interface MeasurementStatisticsRequirementsInternal 
Measurement statistics requirements.
+
interface MeasurementStatisticsRequirements { 
Â Â Â Â aggregate: boolean; 
Â Â Â Â average: boolean; 
Â Â Â Â median: boolean; 
}
Defined in src/pools/selection-strategies/selection-strategies-types.ts:106
 Index
Properties
aggregate
+average
+median
+
Properties
aggregate
aggregate: boolean
Requires measurement aggregate.
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:110
average
average: boolean
Requires measurement average.
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:114
median
median: boolean
Requires measurement median.
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:118
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
aggregate
average
median
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html
index 81eafa67..42d7ac7c 100644
--- a/docs/interfaces/MessageValue.html
+++ b/docs/interfaces/MessageValue.html
@@ -1,45 +1,45 @@
-MessageValue | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
MessageValue
Interface MessageValue<Data, ErrorData>Internal 
Message object that is passed between main worker and worker.
-
interface MessageValue<Data, ErrorData> { 
Â Â Â Â checkActive?: boolean; 
Â Â Â Â data?: Data; 
Â Â Â Â kill?: true | "success" | "SOFT" | "HARD" | "failure"; 
Â Â Â Â name?: string; 
Â Â Â Â port?: MessagePort; 
Â Â Â Â ready?: boolean; 
Â Â Â Â statistics?: WorkerStatistics; 
Â Â Â Â taskFunction?: string; 
Â Â Â Â taskFunctionName?: string; 
Â Â Â Â taskFunctionNames?: string[]; 
Â Â Â Â taskFunctionOperation?: "add" | "default" | "remove"; 
Â Â Â Â taskFunctionOperationStatus?: boolean; 
Â Â Â Â taskId?: string; 
Â Â Â Â taskPerformance?: TaskPerformance; 
Â Â Â Â timestamp?: number; 
Â Â Â Â transferList?: TransferListItem[]; 
Â Â Â Â 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 full)
Task<Data>MessageValue
Defined in src/utility-types.ts:102
 Index
Properties
checkActive?
-data?
-kill?
-name?
-port?
-ready?
-statistics?
-taskFunction?
-taskFunctionName?
-taskFunctionNames?
-taskFunctionOperation?
-taskFunctionOperationStatus?
-taskId?
-taskPerformance?
-timestamp?
-transferList?
-workerError?
-workerId?
-
Properties
Optional Readonly checkActive
checkActive?: boolean
Whether the worker starts or stops its activity check.
-
Defined in src/utility-types.ts:154
Optional Readonly data
data?: Data
Task input data that will be passed to the worker.
-
Inherited from Task.data
Defined in src/utility-types.ts:80
Optional Readonly kill
kill?: true | "success" | "SOFT" | "HARD" | "failure"
Kill code.
-
Defined in src/utility-types.ts:111
Optional Readonly name
name?: string
Task name.
-
Inherited from Task.name
Defined in src/utility-types.ts:76
Optional Readonly port
port?: MessagePort
Message port.
-
Defined in src/utility-types.ts:158
Optional Readonly ready
ready?: boolean
Whether the worker is ready or not.
-
Defined in src/utility-types.ts:150
Optional Readonly statistics
statistics?: WorkerStatistics
Whether the worker computes the given statistics or not.
-
Defined in src/utility-types.ts:146
Optional Readonly taskFunction
taskFunction?: string
Task function serialized to string.
-
Defined in src/utility-types.ts:134
Optional Readonly taskFunctionName
taskFunctionName?: string
Task function name.
-
Defined in src/utility-types.ts:138
Optional Readonly taskFunctionNames
taskFunctionNames?: string[]
Task function names.
-
Defined in src/utility-types.ts:142
Optional Readonly taskFunctionOperation
taskFunctionOperation?: "add" | "default" | "remove"
Task function operation:
+MessageValue | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
MessageValue
Interface MessageValue<Data, ErrorData>Internal 
Message object that is passed between main worker and worker.
+
interface MessageValue<Data, ErrorData> { 
Â Â Â Â checkActive?: boolean; 
Â Â Â Â data?: Data; 
Â Â Â Â kill?: true | "success" | "SOFT" | "HARD" | "failure"; 
Â Â Â Â name?: string; 
Â Â Â Â port?: MessagePort; 
Â Â Â Â ready?: boolean; 
Â Â Â Â statistics?: WorkerStatistics; 
Â Â Â Â taskFunction?: string; 
Â Â Â Â taskFunctionName?: string; 
Â Â Â Â taskFunctionNames?: string[]; 
Â Â Â Â taskFunctionOperation?: "add" | "default" | "remove"; 
Â Â Â Â taskFunctionOperationStatus?: boolean; 
Â Â Â Â taskId?: string; 
Â Â Â Â taskPerformance?: TaskPerformance; 
Â Â Â Â timestamp?: number; 
Â Â Â Â transferList?: TransferListItem[]; 
Â Â Â Â workerError?: WorkerError<ErrorData>; 
Â Â Â Â workerId?: number; 
}
 Type Parameters
Data = unknownType of data sent to the worker or execution response. This can only be structured-cloneable data.
+
ErrorData = unknownType of data sent to the worker triggering an error. This can only be structured-cloneable data.
+
 Hierarchy (view full)
Task<Data>MessageValue
Defined in src/utility-types.ts:102
 Index
Properties
checkActive?
+data?
+kill?
+name?
+port?
+ready?
+statistics?
+taskFunction?
+taskFunctionName?
+taskFunctionNames?
+taskFunctionOperation?
+taskFunctionOperationStatus?
+taskId?
+taskPerformance?
+timestamp?
+transferList?
+workerError?
+workerId?
+
Properties
Optional Readonly checkActive
checkActive?: boolean
Whether the worker starts or stops its activity check.
+
Defined in src/utility-types.ts:154
Optional Readonly data
data?: Data
Task input data that will be passed to the worker.
+
Inherited from Task.data
Defined in src/utility-types.ts:80
Optional Readonly kill
kill?: true | "success" | "SOFT" | "HARD" | "failure"
Kill code.
+
Defined in src/utility-types.ts:111
Optional Readonly name
name?: string
Task name.
+
Inherited from Task.name
Defined in src/utility-types.ts:76
Optional Readonly port
port?: MessagePort
Message port.
+
Defined in src/utility-types.ts:158
Optional Readonly ready
ready?: boolean
Whether the worker is ready or not.
+
Defined in src/utility-types.ts:150
Optional Readonly statistics
statistics?: WorkerStatistics
Whether the worker computes the given statistics or not.
+
Defined in src/utility-types.ts:146
Optional Readonly taskFunction
taskFunction?: string
Task function serialized to string.
+
Defined in src/utility-types.ts:134
Optional Readonly taskFunctionName
taskFunctionName?: string
Task function name.
+
Defined in src/utility-types.ts:138
Optional Readonly taskFunctionNames
taskFunctionNames?: string[]
Task function names.
+
Defined in src/utility-types.ts:142
Optional Readonly taskFunctionOperation
taskFunctionOperation?: "add" | "default" | "remove"
Task function operation:
 
 'add' - Add a task function.
 'remove' - Remove a task function.
 'default' - Set a task function as default.
 
-
Defined in src/utility-types.ts:126
Optional Readonly taskFunctionOperationStatus
taskFunctionOperationStatus?: boolean
Whether the task function operation is successful or not.
-
Defined in src/utility-types.ts:130
Optional Readonly taskId
taskId?: string
Task UUID.
-
Inherited from Task.taskId
Defined in src/utility-types.ts:92
Optional Readonly taskPerformance
taskPerformance?: TaskPerformance
Task performance.
-
Defined in src/utility-types.ts:119
Optional Readonly timestamp
timestamp?: number
Timestamp.
-
Inherited from Task.timestamp
Defined in src/utility-types.ts:88
Optional Readonly transferList
transferList?: TransferListItem[]
Array of transferable objects.
-
Inherited from Task.transferList
Defined in src/utility-types.ts:84
Optional Readonly workerError
workerError?: WorkerError<ErrorData>
Worker error.
-
Defined in src/utility-types.ts:115
Optional Readonly workerId
workerId?: number
Worker id.
-
Defined in src/utility-types.ts:107
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
checkActive
data
kill
name
port
ready
statistics
taskFunction
taskFunctionName
taskFunctionNames
taskFunctionOperation
taskFunctionOperationStatus
taskId
taskPerformance
timestamp
transferList
workerError
workerId
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+
Defined in src/utility-types.ts:126
Optional Readonly taskFunctionOperationStatus
taskFunctionOperationStatus?: boolean
Whether the task function operation is successful or not.
+
Defined in src/utility-types.ts:130
Optional Readonly taskId
taskId?: string
Task UUID.
+
Inherited from Task.taskId
Defined in src/utility-types.ts:92
Optional Readonly taskPerformance
taskPerformance?: TaskPerformance
Task performance.
+
Defined in src/utility-types.ts:119
Optional Readonly timestamp
timestamp?: number
Timestamp.
+
Inherited from Task.timestamp
Defined in src/utility-types.ts:88
Optional Readonly transferList
transferList?: TransferListItem[]
Array of transferable objects.
+
Inherited from Task.transferList
Defined in src/utility-types.ts:84
Optional Readonly workerError
workerError?: WorkerError<ErrorData>
Worker error.
+
Defined in src/utility-types.ts:115
Optional Readonly workerId
workerId?: number
Worker id.
+
Defined in src/utility-types.ts:107
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
checkActive
data
kill
name
port
ready
statistics
taskFunction
taskFunctionName
taskFunctionNames
taskFunctionOperation
taskFunctionOperationStatus
taskId
taskPerformance
timestamp
transferList
workerError
workerId
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/PoolInfo.html b/docs/interfaces/PoolInfo.html
index 77713a1b..f1d2c78a 100644
--- a/docs/interfaces/PoolInfo.html
+++ b/docs/interfaces/PoolInfo.html
@@ -1,30 +1,30 @@
-PoolInfo | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
PoolInfo
Interface PoolInfo
Pool information.
-
interface PoolInfo { 
Â Â Â Â backPressure?: boolean; 
Â Â Â Â busyWorkerNodes: 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; 
Â Â Â Â strategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"; 
Â Â Â Â strategyRetries: number; 
Â Â Â Â type: "fixed" | "dynamic"; 
Â Â Â Â utilization?: number; 
Â Â Â Â version: string; 
Â Â Â Â waitTime?: { 
Â Â Â Â Â Â Â Â average?: number; 
Â Â Â Â Â Â Â Â maximum: number; 
Â Â Â Â Â Â Â Â median?: number; 
Â Â Â Â Â Â Â Â minimum: number; 
Â Â Â Â }; 
Â Â Â Â worker: "thread" | "cluster"; 
Â Â Â Â workerNodes: number; 
}
Defined in src/pools/pool.ts:60
 Index
Properties
backPressure?
-busyWorkerNodes
-executedTasks
-executingTasks
-failedTasks
-idleWorkerNodes
-maxQueuedTasks?
-maxSize
-minSize
-queuedTasks?
-ready
-runTime?
-started
-stealingWorkerNodes?
-stolenTasks?
-strategy
-strategyRetries
-type
-utilization?
-version
-waitTime?
-worker
-workerNodes
-
Properties
Optional Readonly backPressure
backPressure?: boolean
Defined in src/pools/pool.ts:84
Readonly busyWorkerNodes
busyWorkerNodes: number
Pool busy worker nodes.
-
Defined in src/pools/pool.ts:79
Readonly executedTasks
executedTasks: number
Defined in src/pools/pool.ts:80
Readonly executingTasks
executingTasks: number
Defined in src/pools/pool.ts:81
Readonly failedTasks
failedTasks: number
Defined in src/pools/pool.ts:86
Readonly idleWorkerNodes
idleWorkerNodes: number
Pool idle worker nodes.
-
Defined in src/pools/pool.ts:77
Optional Readonly maxQueuedTasks
maxQueuedTasks?: number
Defined in src/pools/pool.ts:83
Readonly maxSize
maxSize: number
Defined in src/pools/pool.ts:69
Readonly minSize
minSize: number
Defined in src/pools/pool.ts:68
Optional Readonly queuedTasks
queuedTasks?: number
Defined in src/pools/pool.ts:82
Readonly ready
ready: boolean
Defined in src/pools/pool.ts:65
Optional Readonly runTime
runTime?: { 
Â Â Â Â average?: number; 
Â Â Â Â maximum: number; 
Â Â Â Â median?: number; 
Â Â Â Â minimum: number; 
}
Type declaration
Optional Readonly average?: number
Readonly maximum: number
Optional Readonly median?: number
Readonly minimum: number
Defined in src/pools/pool.ts:87
Readonly started
started: boolean
Defined in src/pools/pool.ts:64
Optional Readonly stealingWorkerNodes
stealingWorkerNodes?: number
Pool stealing worker nodes.
-
Defined in src/pools/pool.ts:75
Optional Readonly stolenTasks
stolenTasks?: number
Defined in src/pools/pool.ts:85
Readonly strategy
strategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
Defined in src/pools/pool.ts:66
Readonly strategyRetries
strategyRetries: number
Defined in src/pools/pool.ts:67
Readonly type
type: "fixed" | "dynamic"
Defined in src/pools/pool.ts:62
Optional Readonly utilization
utilization?: number
Pool utilization.
-
Defined in src/pools/pool.ts:71
Readonly version
version: string
Defined in src/pools/pool.ts:61
Optional Readonly waitTime
waitTime?: { 
Â Â Â Â average?: number; 
Â Â Â Â maximum: number; 
Â Â Â Â median?: number; 
Â Â Â Â minimum: number; 
}
Type declaration
Optional Readonly average?: number
Readonly maximum: number
Optional Readonly median?: number
Readonly minimum: number
Defined in src/pools/pool.ts:93
Readonly worker
worker: "thread" | "cluster"
Defined in src/pools/pool.ts:63
Readonly workerNodes
workerNodes: number
Pool total worker nodes.
-
Defined in src/pools/pool.ts:73
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
backPressure
busyWorkerNodes
executedTasks
executingTasks
failedTasks
idleWorkerNodes
maxQueuedTasks
maxSize
minSize
queuedTasks
ready
runTime
started
stealingWorkerNodes
stolenTasks
strategy
strategyRetries
type
utilization
version
waitTime
worker
workerNodes
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+PoolInfo | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
PoolInfo
Interface PoolInfo
Pool information.
+
interface PoolInfo { 
Â Â Â Â backPressure?: boolean; 
Â Â Â Â busyWorkerNodes: 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; 
Â Â Â Â strategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"; 
Â Â Â Â strategyRetries: number; 
Â Â Â Â type: "fixed" | "dynamic"; 
Â Â Â Â utilization?: number; 
Â Â Â Â version: string; 
Â Â Â Â waitTime?: { 
Â Â Â Â Â Â Â Â average?: number; 
Â Â Â Â Â Â Â Â maximum: number; 
Â Â Â Â Â Â Â Â median?: number; 
Â Â Â Â Â Â Â Â minimum: number; 
Â Â Â Â }; 
Â Â Â Â worker: "thread" | "cluster"; 
Â Â Â Â workerNodes: number; 
}
Defined in src/pools/pool.ts:60
 Index
Properties
backPressure?
+busyWorkerNodes
+executedTasks
+executingTasks
+failedTasks
+idleWorkerNodes
+maxQueuedTasks?
+maxSize
+minSize
+queuedTasks?
+ready
+runTime?
+started
+stealingWorkerNodes?
+stolenTasks?
+strategy
+strategyRetries
+type
+utilization?
+version
+waitTime?
+worker
+workerNodes
+
Properties
Optional Readonly backPressure
backPressure?: boolean
Defined in src/pools/pool.ts:84
Readonly busyWorkerNodes
busyWorkerNodes: number
Pool busy worker nodes.
+
Defined in src/pools/pool.ts:79
Readonly executedTasks
executedTasks: number
Defined in src/pools/pool.ts:80
Readonly executingTasks
executingTasks: number
Defined in src/pools/pool.ts:81
Readonly failedTasks
failedTasks: number
Defined in src/pools/pool.ts:86
Readonly idleWorkerNodes
idleWorkerNodes: number
Pool idle worker nodes.
+
Defined in src/pools/pool.ts:77
Optional Readonly maxQueuedTasks
maxQueuedTasks?: number
Defined in src/pools/pool.ts:83
Readonly maxSize
maxSize: number
Defined in src/pools/pool.ts:69
Readonly minSize
minSize: number
Defined in src/pools/pool.ts:68
Optional Readonly queuedTasks
queuedTasks?: number
Defined in src/pools/pool.ts:82
Readonly ready
ready: boolean
Defined in src/pools/pool.ts:65
Optional Readonly runTime
runTime?: { 
Â Â Â Â average?: number; 
Â Â Â Â maximum: number; 
Â Â Â Â median?: number; 
Â Â Â Â minimum: number; 
}
Type declaration
Optional Readonly average?: number
Readonly maximum: number
Optional Readonly median?: number
Readonly minimum: number
Defined in src/pools/pool.ts:87
Readonly started
started: boolean
Defined in src/pools/pool.ts:64
Optional Readonly stealingWorkerNodes
stealingWorkerNodes?: number
Pool stealing worker nodes.
+
Defined in src/pools/pool.ts:75
Optional Readonly stolenTasks
stolenTasks?: number
Defined in src/pools/pool.ts:85
Readonly strategy
strategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
Defined in src/pools/pool.ts:66
Readonly strategyRetries
strategyRetries: number
Defined in src/pools/pool.ts:67
Readonly type
type: "fixed" | "dynamic"
Defined in src/pools/pool.ts:62
Optional Readonly utilization
utilization?: number
Pool utilization.
+
Defined in src/pools/pool.ts:71
Readonly version
version: string
Defined in src/pools/pool.ts:61
Optional Readonly waitTime
waitTime?: { 
Â Â Â Â average?: number; 
Â Â Â Â maximum: number; 
Â Â Â Â median?: number; 
Â Â Â Â minimum: number; 
}
Type declaration
Optional Readonly average?: number
Readonly maximum: number
Optional Readonly median?: number
Readonly minimum: number
Defined in src/pools/pool.ts:93
Readonly worker
worker: "thread" | "cluster"
Defined in src/pools/pool.ts:63
Readonly workerNodes
workerNodes: number
Pool total worker nodes.
+
Defined in src/pools/pool.ts:73
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
backPressure
busyWorkerNodes
executedTasks
executingTasks
failedTasks
idleWorkerNodes
maxQueuedTasks
maxSize
minSize
queuedTasks
ready
runTime
started
stealingWorkerNodes
stolenTasks
strategy
strategyRetries
type
utilization
version
waitTime
worker
workerNodes
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html
index db2f1086..ab1d70f4 100644
--- a/docs/interfaces/PoolOptions.html
+++ b/docs/interfaces/PoolOptions.html
@@ -1,46 +1,46 @@
-PoolOptions | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
PoolOptions
Interface PoolOptions<Worker>
Options for a poolifier pool.
-
interface PoolOptions<Worker> { 
Â Â Â Â 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?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"; 
Â Â Â Â workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions; 
Â Â Â Â workerOptions?: WorkerOptions; 
}
 Type Parameters
Worker extends IWorker
Type of worker.
-
 Defined in src/pools/pool.ts:142
 Index
Properties
enableEvents?
-enableTasksQueue?
-env?
-errorHandler?
-exitHandler?
-messageHandler?
-onlineHandler?
-restartWorkerOnError?
-settings?
-startWorkers?
-tasksQueueOptions?
-workerChoiceStrategy?
-workerChoiceStrategyOptions?
-workerOptions?
-
Properties
Optional enableEvents
enableEvents?: boolean
Pool events integrated with async resource emission.
+PoolOptions | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
PoolOptions
Interface PoolOptions<Worker>
Options for a poolifier pool.
+
interface PoolOptions<Worker> { 
Â Â Â Â 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?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"; 
Â Â Â Â workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions; 
Â Â Â Â workerOptions?: WorkerOptions; 
}
 Type Parameters
Worker extends IWorkerType of worker.
+
 Defined in src/pools/pool.ts:142
 Index
Properties
enableEvents?
+enableTasksQueue?
+env?
+errorHandler?
+exitHandler?
+messageHandler?
+onlineHandler?
+restartWorkerOnError?
+settings?
+startWorkers?
+tasksQueueOptions?
+workerChoiceStrategy?
+workerChoiceStrategyOptions?
+workerOptions?
+
Properties
Optional enableEvents
enableEvents?: boolean
Pool events integrated with async resource emission.
 
Default Value
true
 
-
Defined in src/pools/pool.ts:192
Optional enableTasksQueue
enableTasksQueue?: boolean
Pool worker node tasks queue.
+
Defined in src/pools/pool.ts:192
Optional enableTasksQueue
enableTasksQueue?: boolean
Pool worker node tasks queue.
 
Default Value
false
 
-
Defined in src/pools/pool.ts:198
Optional env
env?: Record<string, unknown>
Key/value pairs to add to worker process environment.
+
Defined in src/pools/pool.ts:198
Optional env
env?: Record<string, unknown>
Key/value pairs to add to worker process environment.
 
See
https://nodejs.org/api/cluster.html#cluster_cluster_fork_env
-
Defined in src/pools/pool.ts:214
Optional errorHandler
errorHandler?: ErrorHandler<Worker>
A function that will listen for error event on each worker.
+
Defined in src/pools/pool.ts:214
Optional errorHandler
errorHandler?: ErrorHandler<Worker>
A function that will listen for error event on each worker.
 
Default Value
() => {}
-
Defined in src/pools/pool.ts:160
Optional exitHandler
exitHandler?: ExitHandler<Worker>
A function that will listen for exit event on each worker.
+
Defined in src/pools/pool.ts:160
Optional exitHandler
exitHandler?: ExitHandler<Worker>
A function that will listen for exit event on each worker.
 
Default Value
() => {}
-
Defined in src/pools/pool.ts:166
Optional messageHandler
messageHandler?: MessageHandler<Worker>
A function that will listen for message event on each worker.
+
Defined in src/pools/pool.ts:166
Optional messageHandler
messageHandler?: MessageHandler<Worker>
A function that will listen for message event on each worker.
 
Default Value
() => {}
-
Defined in src/pools/pool.ts:154
Optional onlineHandler
onlineHandler?: OnlineHandler<Worker>
A function that will listen for online event on each worker.
+
Defined in src/pools/pool.ts:154
Optional onlineHandler
onlineHandler?: OnlineHandler<Worker>
A function that will listen for online event on each worker.
 
Default Value
() => {}
-
Defined in src/pools/pool.ts:148
Optional restartWorkerOnError
restartWorkerOnError?: boolean
Restart worker on error.
-
Defined in src/pools/pool.ts:186
Optional settings
settings?: ClusterSettings
Cluster settings.
+
Defined in src/pools/pool.ts:148
Optional restartWorkerOnError
restartWorkerOnError?: boolean
Restart worker on error.
+
Defined in src/pools/pool.ts:186
Optional settings
settings?: ClusterSettings
Cluster settings.
 
See
https://nodejs.org/api/cluster.html#cluster_cluster_settings
-
Defined in src/pools/pool.ts:220
Optional startWorkers
startWorkers?: boolean
Whether to start the minimum number of workers at pool initialization.
+
Defined in src/pools/pool.ts:220
Optional startWorkers
startWorkers?: boolean
Whether to start the minimum number of workers at pool initialization.
 
Default Value
true
 
-
Defined in src/pools/pool.ts:172
Optional tasksQueueOptions
tasksQueueOptions?: TasksQueueOptions
Pool worker node tasks queue options.
-
Defined in src/pools/pool.ts:202
Optional workerChoiceStrategy
workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
The worker choice strategy to use in this pool.
+
Defined in src/pools/pool.ts:172
Optional tasksQueueOptions
tasksQueueOptions?: TasksQueueOptions
Pool worker node tasks queue options.
+
Defined in src/pools/pool.ts:202
Optional workerChoiceStrategy
workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
The worker choice strategy to use in this pool.
 
Default Value
WorkerChoiceStrategies.ROUND_ROBIN
 
-
Defined in src/pools/pool.ts:178
Optional workerChoiceStrategyOptions
workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
The worker choice strategy options.
-
Defined in src/pools/pool.ts:182
Optional workerOptions
workerOptions?: WorkerOptions
Worker options.
+
Defined in src/pools/pool.ts:178
Optional workerChoiceStrategyOptions
workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
The worker choice strategy options.
+
Defined in src/pools/pool.ts:182
Optional workerOptions
workerOptions?: WorkerOptions
Worker options.
 
See
https://nodejs.org/api/worker_threads.html#new-workerfilename-options
-
Defined in src/pools/pool.ts:208
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
enableEvents
enableTasksQueue
env
errorHandler
exitHandler
messageHandler
onlineHandler
restartWorkerOnError
settings
startWorkers
tasksQueueOptions
workerChoiceStrategy
workerChoiceStrategyOptions
workerOptions
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+
Defined in src/pools/pool.ts:208
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
enableEvents
enableTasksQueue
env
errorHandler
exitHandler
messageHandler
onlineHandler
restartWorkerOnError
settings
startWorkers
tasksQueueOptions
workerChoiceStrategy
workerChoiceStrategyOptions
workerOptions
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/PromiseResponseWrapper.html b/docs/interfaces/PromiseResponseWrapper.html
index c78d21b7..609d4538 100644
--- a/docs/interfaces/PromiseResponseWrapper.html
+++ b/docs/interfaces/PromiseResponseWrapper.html
@@ -1,13 +1,11 @@
-PromiseResponseWrapper | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
PromiseResponseWrapper
Interface PromiseResponseWrapper<Response>Internal 
An object holding the task execution response promise resolve/reject callbacks.
-
interface PromiseResponseWrapper<Response> { 
Â Â Â Â asyncResource?: AsyncResource; 
Â Â Â Â reject: ((reason?) => void); 
Â Â Â Â resolve: ((value) => void); 
Â Â Â Â workerNodeKey: number; 
}
 Type Parameters
Response = unknown
Type of execution response. This can only be structured-cloneable data.
-
 Defined in src/utility-types.ts:167
 Index
Properties
asyncResource?
-reject
-resolve
-workerNodeKey
-
Properties
Optional Readonly asyncResource
asyncResource?: AsyncResource
The asynchronous resource used to track the task execution.
-
Defined in src/utility-types.ts:183
Readonly reject
reject: ((reason?) => void)
Reject callback to reject the promise.
-
Type declaration
(reason?): void
Reject callback to reject the promise.
-
Parameters
Optional reason: unknown
Returns void
Defined in src/utility-types.ts:175
Readonly resolve
resolve: ((value) => void)
Resolve callback to fulfill the promise.
-
Type declaration
(value): void
Resolve callback to fulfill the promise.
-
Parameters
value: Response | PromiseLike<Response>
Returns void
Defined in src/utility-types.ts:171
Readonly workerNodeKey
workerNodeKey: number
The worker node key executing the task.
-
Defined in src/utility-types.ts:179
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
asyncResource
reject
resolve
workerNodeKey
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+PromiseResponseWrapper | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
PromiseResponseWrapper
Interface PromiseResponseWrapper<Response>Internal 
An object holding the task execution response promise resolve/reject callbacks.
+
interface PromiseResponseWrapper<Response> { 
Â Â Â Â asyncResource?: AsyncResource; 
Â Â Â Â reject: ((reason?) => void); 
Â Â Â Â resolve: ((value) => void); 
Â Â Â Â workerNodeKey: number; 
}
 Type Parameters
Response = unknownType of execution response. This can only be structured-cloneable data.
+
 Defined in src/utility-types.ts:167
 Index
Properties
asyncResource?
+reject
+resolve
+workerNodeKey
+
Properties
Optional Readonly asyncResource
asyncResource?: AsyncResource
The asynchronous resource used to track the task execution.
+
Defined in src/utility-types.ts:183
Readonly reject
reject: ((reason?) => void)
Reject callback to reject the promise.
+
Type declaration
(reason?): void
Parameters
Optional reason: unknown
Returns void
Defined in src/utility-types.ts:175
Readonly resolve
resolve: ((value) => void)
Resolve callback to fulfill the promise.
+
Type declaration
(value): void
Parameters
value: Response | PromiseLike<Response>
Returns void
Defined in src/utility-types.ts:171
Readonly workerNodeKey
workerNodeKey: number
The worker node key executing the task.
+
Defined in src/utility-types.ts:179
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
asyncResource
reject
resolve
workerNodeKey
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/StrategyData.html b/docs/interfaces/StrategyData.html
index e4bd13b4..5e0615e9 100644
--- a/docs/interfaces/StrategyData.html
+++ b/docs/interfaces/StrategyData.html
@@ -1,3 +1,3 @@
-StrategyData | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
StrategyData
Interface StrategyDataInternal 
Worker choice strategy data.
-
interface StrategyData { 
Â Â Â Â virtualTaskEndTimestamp?: number; 
}
Defined in src/pools/worker.ts:208
 Index
Properties
virtualTaskEndTimestamp?
-
Properties
Optional virtualTaskEndTimestamp
virtualTaskEndTimestamp?: number
Defined in src/pools/worker.ts:209
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
virtualTaskEndTimestamp
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+StrategyData | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
StrategyData
Interface StrategyDataInternal 
Worker choice strategy data.
+
interface StrategyData { 
Â Â Â Â virtualTaskEndTimestamp?: number; 
}
Defined in src/pools/worker.ts:208
 Index
Properties
virtualTaskEndTimestamp?
+
Properties
Optional virtualTaskEndTimestamp
virtualTaskEndTimestamp?: number
Defined in src/pools/worker.ts:209
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
virtualTaskEndTimestamp
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/StrategyPolicy.html b/docs/interfaces/StrategyPolicy.html
index 98f9fadf..4e13fe1a 100644
--- a/docs/interfaces/StrategyPolicy.html
+++ b/docs/interfaces/StrategyPolicy.html
@@ -1,6 +1,6 @@
-StrategyPolicy | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
StrategyPolicy
Interface StrategyPolicyInternal 
Strategy policy.
-
interface StrategyPolicy { 
Â Â Â Â dynamicWorkerReady: boolean; 
Â Â Â Â dynamicWorkerUsage: boolean; 
}
Defined in src/pools/selection-strategies/selection-strategies-types.ts:146
 Index
Properties
dynamicWorkerReady
-dynamicWorkerUsage
-
Properties
Readonly dynamicWorkerReady
dynamicWorkerReady: boolean
Expects the newly created dynamic worker to be flagged as ready.
-
Defined in src/pools/selection-strategies/selection-strategies-types.ts:154
Readonly dynamicWorkerUsage
dynamicWorkerUsage: boolean
Expects tasks execution on the newly created dynamic worker.
-
Defined in src/pools/selection-strategies/selection-strategies-types.ts:150
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
dynamicWorkerReady
dynamicWorkerUsage
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+StrategyPolicy | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
StrategyPolicy
Interface StrategyPolicyInternal 
Strategy policy.
+
interface StrategyPolicy { 
Â Â Â Â dynamicWorkerReady: boolean; 
Â Â Â Â dynamicWorkerUsage: boolean; 
}
Defined in src/pools/selection-strategies/selection-strategies-types.ts:146
 Index
Properties
dynamicWorkerReady
+dynamicWorkerUsage
+
Properties
Readonly dynamicWorkerReady
dynamicWorkerReady: boolean
Expects the newly created dynamic worker to be flagged as ready.
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:154
Readonly dynamicWorkerUsage
dynamicWorkerUsage: boolean
Expects tasks execution on the newly created dynamic worker.
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:150
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
dynamicWorkerReady
dynamicWorkerUsage
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/Task.html b/docs/interfaces/Task.html
index 5da3b49a..204a7b8b 100644
--- a/docs/interfaces/Task.html
+++ b/docs/interfaces/Task.html
@@ -1,13 +1,13 @@
-Task | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
Task
Interface Task<Data>Internal 
Message object that is passed as a task between main worker and worker.
-
interface Task<Data> { 
Â Â Â Â data?: Data; 
Â Â Â Â name?: string; 
Â Â Â Â taskId?: string; 
Â Â Â Â timestamp?: number; 
Â Â Â Â transferList?: TransferListItem[]; 
}
 Type Parameters
Data = unknown
Type of data sent to the worker. This can only be structured-cloneable data.
-
 Hierarchy (view full)
TaskMessageValue
Defined in src/utility-types.ts:72
 Index
Properties
data?
-name?
-taskId?
-timestamp?
-transferList?
-
Properties
Optional Readonly data
data?: Data
Task input data that will be passed to the worker.
-
Defined in src/utility-types.ts:80
Optional Readonly name
name?: string
Task name.
-
Defined in src/utility-types.ts:76
Optional Readonly taskId
taskId?: string
Task UUID.
-
Defined in src/utility-types.ts:92
Optional Readonly timestamp
timestamp?: number
Timestamp.
-
Defined in src/utility-types.ts:88
Optional Readonly transferList
transferList?: TransferListItem[]
Array of transferable objects.
-
Defined in src/utility-types.ts:84
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
data
name
taskId
timestamp
transferList
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+Task | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
Task
Interface Task<Data>Internal 
Message object that is passed as a task between main worker and worker.
+
interface Task<Data> { 
Â Â Â Â data?: Data; 
Â Â Â Â name?: string; 
Â Â Â Â taskId?: string; 
Â Â Â Â timestamp?: number; 
Â Â Â Â transferList?: TransferListItem[]; 
}
 Type Parameters
Data = unknownType of data sent to the worker. This can only be structured-cloneable data.
+
 Hierarchy (view full)
TaskMessageValue
Defined in src/utility-types.ts:72
 Index
Properties
data?
+name?
+taskId?
+timestamp?
+transferList?
+
Properties
Optional Readonly data
data?: Data
Task input data that will be passed to the worker.
+
Defined in src/utility-types.ts:80
Optional Readonly name
name?: string
Task name.
+
Defined in src/utility-types.ts:76
Optional Readonly taskId
taskId?: string
Task UUID.
+
Defined in src/utility-types.ts:92
Optional Readonly timestamp
timestamp?: number
Timestamp.
+
Defined in src/utility-types.ts:88
Optional Readonly transferList
transferList?: TransferListItem[]
Array of transferable objects.
+
Defined in src/utility-types.ts:84
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
data
name
taskId
timestamp
transferList
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/TaskFunctionOperationResult.html b/docs/interfaces/TaskFunctionOperationResult.html
index d7a0830c..f73f7567 100644
--- a/docs/interfaces/TaskFunctionOperationResult.html
+++ b/docs/interfaces/TaskFunctionOperationResult.html
@@ -1,4 +1,4 @@
-TaskFunctionOperationResult | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
TaskFunctionOperationResult
Interface TaskFunctionOperationResult
Task function operation result.
-
interface TaskFunctionOperationResult { 
Â Â Â Â error?: Error; 
Â Â Â Â status: boolean; 
}
Defined in src/worker/task-functions.ts:54
 Index
Properties
error?
-status
-
Properties
Optional error
error?: Error
Defined in src/worker/task-functions.ts:56
status
status: boolean
Defined in src/worker/task-functions.ts:55
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
error
status
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+TaskFunctionOperationResult | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
TaskFunctionOperationResult
Interface TaskFunctionOperationResult
Task function operation result.
+
interface TaskFunctionOperationResult { 
Â Â Â Â error?: Error; 
Â Â Â Â status: boolean; 
}
Defined in src/worker/task-functions.ts:54
 Index
Properties
error?
+status
+
Properties
Optional error
error?: Error
Defined in src/worker/task-functions.ts:56
status
status: boolean
Defined in src/worker/task-functions.ts:55
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
error
status
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/TaskPerformance.html b/docs/interfaces/TaskPerformance.html
index d6d208ac..8c4ddef1 100644
--- a/docs/interfaces/TaskPerformance.html
+++ b/docs/interfaces/TaskPerformance.html
@@ -1,10 +1,10 @@
-TaskPerformance | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
TaskPerformance
Interface TaskPerformanceInternal 
Task performance.
-
interface TaskPerformance { 
Â Â Â Â elu?: EventLoopUtilization; 
Â Â Â Â name: string; 
Â Â Â Â runTime?: number; 
Â Â Â Â timestamp: number; 
}
Defined in src/utility-types.ts:31
 Index
Properties
elu?
-name
-runTime?
-timestamp
-
Properties
Optional Readonly elu
elu?: EventLoopUtilization
Task event loop utilization.
-
Defined in src/utility-types.ts:47
Readonly name
name: string
Task name.
-
Defined in src/utility-types.ts:35
Optional Readonly runTime
runTime?: number
Task runtime.
-
Defined in src/utility-types.ts:43
Readonly timestamp
timestamp: number
Task performance timestamp.
-
Defined in src/utility-types.ts:39
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
elu
name
runTime
timestamp
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+TaskPerformance | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
TaskPerformance
Interface TaskPerformanceInternal 
Task performance.
+
interface TaskPerformance { 
Â Â Â Â elu?: EventLoopUtilization; 
Â Â Â Â name: string; 
Â Â Â Â runTime?: number; 
Â Â Â Â timestamp: number; 
}
Defined in src/utility-types.ts:31
 Index
Properties
elu?
+name
+runTime?
+timestamp
+
Properties
Optional Readonly elu
elu?: EventLoopUtilization
Task event loop utilization.
+
Defined in src/utility-types.ts:47
Readonly name
name: string
Task name.
+
Defined in src/utility-types.ts:35
Optional Readonly runTime
runTime?: number
Task runtime.
+
Defined in src/utility-types.ts:43
Readonly timestamp
timestamp: number
Task performance timestamp.
+
Defined in src/utility-types.ts:39
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
elu
name
runTime
timestamp
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/TaskStatistics.html b/docs/interfaces/TaskStatistics.html
index 23d7c4df..b46420b6 100644
--- a/docs/interfaces/TaskStatistics.html
+++ b/docs/interfaces/TaskStatistics.html
@@ -1,16 +1,16 @@
-TaskStatistics | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
TaskStatistics
Interface TaskStatisticsInternal 
Task statistics.
-
interface TaskStatistics { 
Â Â Â Â executed: number; 
Â Â Â Â executing: number; 
Â Â Â Â failed: number; 
Â Â Â Â maxQueued?: number; 
Â Â Â Â queued: number; 
Â Â Â Â sequentiallyStolen: number; 
Â Â Â Â stolen: number; 
}
Defined in src/pools/worker.ts:102
 Index
Properties
executed
-executing
-failed
-maxQueued?
-queued
-sequentiallyStolen
-stolen
-
Properties
executed
executed: number
Number of executed tasks.
-
Defined in src/pools/worker.ts:106
executing
executing: number
Number of executing tasks.
-
Defined in src/pools/worker.ts:110
failed
failed: number
Number of failed tasks.
-
Defined in src/pools/worker.ts:130
Optional Readonly maxQueued
maxQueued?: number
Maximum number of queued tasks.
-
Defined in src/pools/worker.ts:118
Readonly queued
queued: number
Number of queued tasks.
-
Defined in src/pools/worker.ts:114
sequentiallyStolen
sequentiallyStolen: number
Number of sequentially stolen tasks.
-
Defined in src/pools/worker.ts:122
stolen
stolen: number
Number of stolen tasks.
-
Defined in src/pools/worker.ts:126
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
executed
executing
failed
maxQueued
queued
sequentiallyStolen
stolen
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+TaskStatistics | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
TaskStatistics
Interface TaskStatisticsInternal 
Task statistics.
+
interface TaskStatistics { 
Â Â Â Â executed: number; 
Â Â Â Â executing: number; 
Â Â Â Â failed: number; 
Â Â Â Â maxQueued?: number; 
Â Â Â Â queued: number; 
Â Â Â Â sequentiallyStolen: number; 
Â Â Â Â stolen: number; 
}
Defined in src/pools/worker.ts:102
 Index
Properties
executed
+executing
+failed
+maxQueued?
+queued
+sequentiallyStolen
+stolen
+
Properties
executed
executed: number
Number of executed tasks.
+
Defined in src/pools/worker.ts:106
executing
executing: number
Number of executing tasks.
+
Defined in src/pools/worker.ts:110
failed
failed: number
Number of failed tasks.
+
Defined in src/pools/worker.ts:130
Optional Readonly maxQueued
maxQueued?: number
Maximum number of queued tasks.
+
Defined in src/pools/worker.ts:118
Readonly queued
queued: number
Number of queued tasks.
+
Defined in src/pools/worker.ts:114
sequentiallyStolen
sequentiallyStolen: number
Number of sequentially stolen tasks.
+
Defined in src/pools/worker.ts:122
stolen
stolen: number
Number of stolen tasks.
+
Defined in src/pools/worker.ts:126
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
executed
executing
failed
maxQueued
queued
sequentiallyStolen
stolen
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/TaskStatisticsRequirements.html b/docs/interfaces/TaskStatisticsRequirements.html
index fd5b409d..e99b4dd9 100644
--- a/docs/interfaces/TaskStatisticsRequirements.html
+++ b/docs/interfaces/TaskStatisticsRequirements.html
@@ -1,8 +1,8 @@
-TaskStatisticsRequirements | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
TaskStatisticsRequirements
Interface TaskStatisticsRequirementsInternal 
Pool worker node worker usage statistics requirements.
-
interface TaskStatisticsRequirements { 
Â Â Â Â elu: MeasurementStatisticsRequirements; 
Â Â Â Â runTime: MeasurementStatisticsRequirements; 
Â Â Â Â waitTime: MeasurementStatisticsRequirements; 
}
Defined in src/pools/selection-strategies/selection-strategies-types.ts:126
 Index
Properties
elu
-runTime
-waitTime
-
Properties
Readonly elu
elu: MeasurementStatisticsRequirements
Tasks event loop utilization requirements.
-
Defined in src/pools/selection-strategies/selection-strategies-types.ts:138
Readonly runTime
runTime: MeasurementStatisticsRequirements
Tasks runtime requirements.
-
Defined in src/pools/selection-strategies/selection-strategies-types.ts:130
Readonly waitTime
waitTime: MeasurementStatisticsRequirements
Tasks wait time requirements.
-
Defined in src/pools/selection-strategies/selection-strategies-types.ts:134
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
elu
runTime
waitTime
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+TaskStatisticsRequirements | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
TaskStatisticsRequirements
Interface TaskStatisticsRequirementsInternal 
Pool worker node worker usage statistics requirements.
+
interface TaskStatisticsRequirements { 
Â Â Â Â elu: MeasurementStatisticsRequirements; 
Â Â Â Â runTime: MeasurementStatisticsRequirements; 
Â Â Â Â waitTime: MeasurementStatisticsRequirements; 
}
Defined in src/pools/selection-strategies/selection-strategies-types.ts:126
 Index
Properties
elu
+runTime
+waitTime
+
Properties
Readonly elu
elu: MeasurementStatisticsRequirements
Tasks event loop utilization requirements.
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:138
Readonly runTime
runTime: MeasurementStatisticsRequirements
Tasks runtime requirements.
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:130
Readonly waitTime
waitTime: MeasurementStatisticsRequirements
Tasks wait time requirements.
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:134
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
elu
runTime
waitTime
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/TasksQueueOptions.html b/docs/interfaces/TasksQueueOptions.html
index 277fa62d..791cfdc8 100644
--- a/docs/interfaces/TasksQueueOptions.html
+++ b/docs/interfaces/TasksQueueOptions.html
@@ -1,22 +1,22 @@
-TasksQueueOptions | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
TasksQueueOptions
Interface TasksQueueOptions
Worker node tasks queue options.
-
interface TasksQueueOptions { 
Â Â Â Â concurrency?: number; 
Â Â Â Â size?: number; 
Â Â Â Â taskStealing?: boolean; 
Â Â Â Â tasksFinishedTimeout?: number; 
Â Â Â Â tasksStealingOnBackPressure?: boolean; 
}
Defined in src/pools/pool.ts:104
 Index
Properties
concurrency?
-size?
-taskStealing?
-tasksFinishedTimeout?
-tasksStealingOnBackPressure?
-
Properties
Optional Readonly concurrency
concurrency?: number
Maximum number of tasks that can be executed concurrently on a worker node.
+TasksQueueOptions | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
TasksQueueOptions
Interface TasksQueueOptions
Worker node tasks queue options.
+
interface TasksQueueOptions { 
Â Â Â Â concurrency?: number; 
Â Â Â Â size?: number; 
Â Â Â Â taskStealing?: boolean; 
Â Â Â Â tasksFinishedTimeout?: number; 
Â Â Â Â tasksStealingOnBackPressure?: boolean; 
}
Defined in src/pools/pool.ts:104
 Index
Properties
concurrency?
+size?
+taskStealing?
+tasksFinishedTimeout?
+tasksStealingOnBackPressure?
+
Properties
Optional Readonly concurrency
concurrency?: number
Maximum number of tasks that can be executed concurrently on a worker node.
 
Default Value
1
 
-
Defined in src/pools/pool.ts:116
Optional Readonly size
size?: number
Maximum tasks queue size per worker node flagging it as back pressured.
+
Defined in src/pools/pool.ts:116
Optional Readonly size
size?: number
Maximum tasks queue size per worker node flagging it as back pressured.
 
Default Value
(pool maximum size)^2
 
-
Defined in src/pools/pool.ts:110
Optional Readonly taskStealing
taskStealing?: boolean
Whether to enable task stealing on idle.
+
Defined in src/pools/pool.ts:110
Optional Readonly taskStealing
taskStealing?: boolean
Whether to enable task stealing on idle.
 
Default Value
true
 
-
Defined in src/pools/pool.ts:122
Optional Readonly tasksFinishedTimeout
tasksFinishedTimeout?: number
Queued tasks finished timeout in milliseconds at worker node termination.
+
Defined in src/pools/pool.ts:122
Optional Readonly tasksFinishedTimeout
tasksFinishedTimeout?: number
Queued tasks finished timeout in milliseconds at worker node termination.
 
Default Value
2000
 
-
Defined in src/pools/pool.ts:134
Optional Readonly tasksStealingOnBackPressure
tasksStealingOnBackPressure?: boolean
Whether to enable tasks stealing under back pressure.
+
Defined in src/pools/pool.ts:134
Optional Readonly tasksStealingOnBackPressure
tasksStealingOnBackPressure?: boolean
Whether to enable tasks stealing under back pressure.
 
Default Value
true
 
-
Defined in src/pools/pool.ts:128
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
concurrency
size
taskStealing
tasksFinishedTimeout
tasksStealingOnBackPressure
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+
Defined in src/pools/pool.ts:128
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
concurrency
size
taskStealing
tasksFinishedTimeout
tasksStealingOnBackPressure
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/WorkerChoiceStrategyOptions.html b/docs/interfaces/WorkerChoiceStrategyOptions.html
index d65c7acc..341e208f 100644
--- a/docs/interfaces/WorkerChoiceStrategyOptions.html
+++ b/docs/interfaces/WorkerChoiceStrategyOptions.html
@@ -1,21 +1,21 @@
-WorkerChoiceStrategyOptions | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerChoiceStrategyOptions
Interface WorkerChoiceStrategyOptions
Worker choice strategy options.
-
interface WorkerChoiceStrategyOptions { 
Â Â Â Â elu?: MeasurementOptions; 
Â Â Â Â measurement?: "runTime" | "waitTime" | "elu"; 
Â Â Â Â runTime?: MeasurementOptions; 
Â Â Â Â waitTime?: MeasurementOptions; 
Â Â Â Â weights?: Record<number, number>; 
}
Defined in src/pools/selection-strategies/selection-strategies-types.ts:69
 Index
Properties
elu?
-measurement?
-runTime?
-waitTime?
-weights?
-
Properties
Optional Readonly elu
elu?: MeasurementOptions
Event loop utilization options.
+WorkerChoiceStrategyOptions | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerChoiceStrategyOptions
Interface WorkerChoiceStrategyOptions
Worker choice strategy options.
+
interface WorkerChoiceStrategyOptions { 
Â Â Â Â elu?: MeasurementOptions; 
Â Â Â Â measurement?: "runTime" | "waitTime" | "elu"; 
Â Â Â Â runTime?: MeasurementOptions; 
Â Â Â Â waitTime?: MeasurementOptions; 
Â Â Â Â weights?: Record<number, number>; 
}
Defined in src/pools/selection-strategies/selection-strategies-types.ts:69
 Index
Properties
elu?
+measurement?
+runTime?
+waitTime?
+weights?
+
Properties
Optional Readonly elu
elu?: MeasurementOptions
Event loop utilization options.
 
Default Value
{ median: false }
 
-
Defined in src/pools/selection-strategies/selection-strategies-types.ts:91
Optional Readonly measurement
measurement?: "runTime" | "waitTime" | "elu"
Measurement to use in worker choice strategy supporting it.
-
Defined in src/pools/selection-strategies/selection-strategies-types.ts:73
Optional Readonly runTime
runTime?: MeasurementOptions
Runtime options.
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:91
Optional Readonly measurement
measurement?: "runTime" | "waitTime" | "elu"
Measurement to use in worker choice strategy supporting it.
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:73
Optional Readonly runTime
runTime?: MeasurementOptions
Runtime options.
 
Default Value
{ median: false }
 
-
Defined in src/pools/selection-strategies/selection-strategies-types.ts:79
Optional Readonly waitTime
waitTime?: MeasurementOptions
Wait time options.
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:79
Optional Readonly waitTime
waitTime?: MeasurementOptions
Wait time options.
 
Default Value
{ median: false }
 
-
Defined in src/pools/selection-strategies/selection-strategies-types.ts:85
Optional weights
weights?: Record<number, number>
Worker weights to use for weighted round robin worker selection strategies.
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:85
Optional weights
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.
 
Default Value
Weights computed automatically given the CPU performance.
 
-
Defined in src/pools/selection-strategies/selection-strategies-types.ts:98
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
elu
measurement
runTime
waitTime
weights
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:98
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
elu
measurement
runTime
waitTime
weights
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/WorkerError.html b/docs/interfaces/WorkerError.html
index 73c5ebe8..460fdc6b 100644
--- a/docs/interfaces/WorkerError.html
+++ b/docs/interfaces/WorkerError.html
@@ -1,9 +1,9 @@
-WorkerError | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerError
Interface WorkerError<Data>
Worker error.
-
interface WorkerError<Data> { 
Â Â Â Â data?: Data; 
Â Â Â Â message: string; 
Â Â Â Â name: string; 
}
 Type Parameters
Data = unknown
Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
-
 Defined in src/utility-types.ts:11
 Index
Properties
data?
-message
-name
-
Properties
Optional Readonly data
data?: Data
Data triggering the error.
-
Defined in src/utility-types.ts:23
Readonly message
message: string
Error message.
-
Defined in src/utility-types.ts:19
Readonly name
name: string
Task function name triggering the error.
-
Defined in src/utility-types.ts:15
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
data
message
name
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+WorkerError | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerError
Interface WorkerError<Data>
Worker error.
+
interface WorkerError<Data> { 
Â Â Â Â data?: Data; 
Â Â Â Â message: string; 
Â Â Â Â name: string; 
}
 Type Parameters
Data = unknownType of data sent to the worker triggering an error. This can only be structured-cloneable data.
+
 Defined in src/utility-types.ts:11
 Index
Properties
data?
+message
+name
+
Properties
Optional Readonly data
data?: Data
Data triggering the error.
+
Defined in src/utility-types.ts:23
Readonly message
message: string
Error message.
+
Defined in src/utility-types.ts:19
Readonly name
name: string
Task function name triggering the error.
+
Defined in src/utility-types.ts:15
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
data
message
name
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/WorkerInfo.html b/docs/interfaces/WorkerInfo.html
index 713922b7..89c14ddb 100644
--- a/docs/interfaces/WorkerInfo.html
+++ b/docs/interfaces/WorkerInfo.html
@@ -1,15 +1,15 @@
-WorkerInfo | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerInfo
Interface WorkerInfoInternal 
Worker information.
-
interface WorkerInfo { 
Â Â Â Â dynamic: boolean; 
Â Â Â Â id: undefined | number; 
Â Â Â Â ready: boolean; 
Â Â Â Â stealing: boolean; 
Â Â Â Â taskFunctionNames?: string[]; 
Â Â Â Â type: "thread" | "cluster"; 
}
Defined in src/pools/worker.ts:151
 Index
Properties
dynamic
-id
-ready
-stealing
-taskFunctionNames?
-type
-
Properties
dynamic
dynamic: boolean
Dynamic flag.
-
Defined in src/pools/worker.ts:163
Readonly id
id: undefined | number
Worker id.
-
Defined in src/pools/worker.ts:155
ready
ready: boolean
Ready flag.
-
Defined in src/pools/worker.ts:167
stealing
stealing: boolean
Stealing flag.
+WorkerInfo | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerInfo
Interface WorkerInfoInternal 
Worker information.
+
interface WorkerInfo { 
Â Â Â Â dynamic: boolean; 
Â Â Â Â id: undefined | number; 
Â Â Â Â ready: boolean; 
Â Â Â Â stealing: boolean; 
Â Â Â Â taskFunctionNames?: string[]; 
Â Â Â Â type: "thread" | "cluster"; 
}
Defined in src/pools/worker.ts:151
 Index
Properties
dynamic
+id
+ready
+stealing
+taskFunctionNames?
+type
+
Properties
dynamic
dynamic: boolean
Dynamic flag.
+
Defined in src/pools/worker.ts:163
Readonly id
id: undefined | number
Worker id.
+
Defined in src/pools/worker.ts:155
ready
ready: boolean
Ready flag.
+
Defined in src/pools/worker.ts:167
stealing
stealing: boolean
Stealing flag.
 This flag is set to true when worker node is stealing tasks from another worker node.
-
Defined in src/pools/worker.ts:172
Optional taskFunctionNames
taskFunctionNames?: string[]
Task function names.
-
Defined in src/pools/worker.ts:176
Readonly type
type: "thread" | "cluster"
Worker type.
-
Defined in src/pools/worker.ts:159
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
dynamic
id
ready
stealing
taskFunctionNames
type
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+
Defined in src/pools/worker.ts:172
Optional taskFunctionNames
taskFunctionNames?: string[]
Task function names.
+
Defined in src/pools/worker.ts:176
Readonly type
type: "thread" | "cluster"
Worker type.
+
Defined in src/pools/worker.ts:159
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
dynamic
id
ready
stealing
taskFunctionNames
type
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/WorkerNodeEventDetail.html b/docs/interfaces/WorkerNodeEventDetail.html
index e5e861cf..75ef72e6 100644
--- a/docs/interfaces/WorkerNodeEventDetail.html
+++ b/docs/interfaces/WorkerNodeEventDetail.html
@@ -1,4 +1,4 @@
-WorkerNodeEventDetail | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerNodeEventDetail
Interface WorkerNodeEventDetailInternal 
Worker node event detail.
-
interface WorkerNodeEventDetail { 
Â Â Â Â workerId?: number; 
Â Â Â Â workerNodeKey?: number; 
}
Defined in src/pools/worker.ts:396
 Index
Properties
workerId?
-workerNodeKey?
-
Properties
Optional workerId
workerId?: number
Defined in src/pools/worker.ts:397
Optional workerNodeKey
workerNodeKey?: number
Defined in src/pools/worker.ts:398
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
workerId
workerNodeKey
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+WorkerNodeEventDetail | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerNodeEventDetail
Interface WorkerNodeEventDetailInternal 
Worker node event detail.
+
interface WorkerNodeEventDetail { 
Â Â Â Â workerId?: number; 
Â Â Â Â workerNodeKey?: number; 
}
Defined in src/pools/worker.ts:396
 Index
Properties
workerId?
+workerNodeKey?
+
Properties
Optional workerId
workerId?: number
Defined in src/pools/worker.ts:397
Optional workerNodeKey
workerNodeKey?: number
Defined in src/pools/worker.ts:398
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
workerId
workerNodeKey
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/WorkerNodeOptions.html b/docs/interfaces/WorkerNodeOptions.html
index db51f2b5..d76a2ec2 100644
--- a/docs/interfaces/WorkerNodeOptions.html
+++ b/docs/interfaces/WorkerNodeOptions.html
@@ -1,5 +1,5 @@
-WorkerNodeOptions | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerNodeOptions
Interface WorkerNodeOptionsInternal 
Worker node options.
-
interface WorkerNodeOptions { 
Â Â Â Â env?: Record<string, unknown>; 
Â Â Â Â tasksQueueBackPressureSize: undefined | number; 
Â Â Â Â workerOptions?: WorkerOptions; 
}
Defined in src/pools/worker.ts:264
 Index
Properties
env?
-tasksQueueBackPressureSize
-workerOptions?
-
Properties
Optional env
env?: Record<string, unknown>
Defined in src/pools/worker.ts:266
tasksQueueBackPressureSize
tasksQueueBackPressureSize: undefined | number
Defined in src/pools/worker.ts:267
Optional workerOptions
workerOptions?: WorkerOptions
Defined in src/pools/worker.ts:265
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
env
tasksQueueBackPressureSize
workerOptions
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+WorkerNodeOptions | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerNodeOptions
Interface WorkerNodeOptionsInternal 
Worker node options.
+
interface WorkerNodeOptions { 
Â Â Â Â env?: Record<string, unknown>; 
Â Â Â Â tasksQueueBackPressureSize: undefined | number; 
Â Â Â Â workerOptions?: WorkerOptions; 
}
Defined in src/pools/worker.ts:264
 Index
Properties
env?
+tasksQueueBackPressureSize
+workerOptions?
+
Properties
Optional env
env?: Record<string, unknown>
Defined in src/pools/worker.ts:266
tasksQueueBackPressureSize
tasksQueueBackPressureSize: undefined | number
Defined in src/pools/worker.ts:267
Optional workerOptions
workerOptions?: WorkerOptions
Defined in src/pools/worker.ts:265
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
env
tasksQueueBackPressureSize
workerOptions
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html
index f991109f..2a2b5a86 100644
--- a/docs/interfaces/WorkerOptions.html
+++ b/docs/interfaces/WorkerOptions.html
@@ -1,8 +1,8 @@
-WorkerOptions | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerOptions
Interface WorkerOptions
Options for workers.
-
interface WorkerOptions { 
Â Â Â Â killBehavior?: "SOFT" | "HARD"; 
Â Â Â Â killHandler?: KillHandler; 
Â Â Â Â maxInactiveTime?: number; 
}
Defined in src/worker/worker-options.ts:28
 Index
Properties
killBehavior?
-killHandler?
-maxInactiveTime?
-
Properties
Optional killBehavior
killBehavior?: "SOFT" | "HARD"
killBehavior dictates if your worker will be deleted in case a task is active on it.
+WorkerOptions | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerOptions
Interface WorkerOptions
Options for workers.
+
interface WorkerOptions { 
Â Â Â Â killBehavior?: "SOFT" | "HARD"; 
Â Â Â Â killHandler?: KillHandler; 
Â Â Â Â maxInactiveTime?: number; 
}
Defined in src/worker/worker-options.ts:28
 Index
Properties
killBehavior?
+killHandler?
+maxInactiveTime?
+
Properties
Optional killBehavior
killBehavior?: "SOFT" | "HARD"
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 a task is still executing or queued, then the worker won't be deleted.
 HARD: If currentTime - lastActiveTime is greater than maxInactiveTime but a task is still executing or queued, then the worker will be deleted.
@@ -10,9 +10,9 @@
 This option only apply to the newly created workers.
 
Default Value
KillBehaviors.SOFT
 
-
Defined in src/worker/worker-options.ts:39
Optional killHandler
killHandler?: KillHandler
The function to call when a worker is killed.
+
Defined in src/worker/worker-options.ts:39
Optional killHandler
killHandler?: KillHandler
The function to call when a worker is killed.
 
Default Value
() => {}
-
Defined in src/worker/worker-options.ts:58
Optional maxInactiveTime
maxInactiveTime?: number
Maximum waiting time in milliseconds for tasks on newly created workers. It must be greater or equal than 5.
+
Defined in src/worker/worker-options.ts:58
Optional maxInactiveTime
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.
 
@@ -22,4 +22,4 @@ when this timeout expires your tasks is interrupted before completion and remove
 
 
Default Value
60000
 
-
Defined in src/worker/worker-options.ts:52
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
killBehavior
killHandler
maxInactiveTime
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+
Defined in src/worker/worker-options.ts:52
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
killBehavior
killHandler
maxInactiveTime
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/WorkerStatistics.html b/docs/interfaces/WorkerStatistics.html
index c4086705..112cf598 100644
--- a/docs/interfaces/WorkerStatistics.html
+++ b/docs/interfaces/WorkerStatistics.html
@@ -1,6 +1,6 @@
-WorkerStatistics | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerStatistics
Interface WorkerStatisticsInternal 
Worker task performance statistics computation settings.
-
interface WorkerStatistics { 
Â Â Â Â elu: boolean; 
Â Â Â Â runTime: boolean; 
}
Defined in src/utility-types.ts:55
 Index
Properties
elu
-runTime
-
Properties
Readonly elu
elu: boolean
Whether the worker computes the task event loop utilization (ELU) or not.
-
Defined in src/utility-types.ts:63
Readonly runTime
runTime: boolean
Whether the worker computes the task runtime or not.
-
Defined in src/utility-types.ts:59
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
elu
runTime
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+WorkerStatistics | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerStatistics
Interface WorkerStatisticsInternal 
Worker task performance statistics computation settings.
+
interface WorkerStatistics { 
Â Â Â Â elu: boolean; 
Â Â Â Â runTime: boolean; 
}
Defined in src/utility-types.ts:55
 Index
Properties
elu
+runTime
+
Properties
Readonly elu
elu: boolean
Whether the worker computes the task event loop utilization (ELU) or not.
+
Defined in src/utility-types.ts:63
Readonly runTime
runTime: boolean
Whether the worker computes the task runtime or not.
+
Defined in src/utility-types.ts:59
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
elu
runTime
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/interfaces/WorkerUsage.html b/docs/interfaces/WorkerUsage.html
index 5c045a83..d6093e6f 100644
--- a/docs/interfaces/WorkerUsage.html
+++ b/docs/interfaces/WorkerUsage.html
@@ -1,10 +1,10 @@
-WorkerUsage | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerUsage
Interface WorkerUsageInternal 
Worker usage statistics.
-
interface WorkerUsage { 
Â Â Â Â elu: EventLoopUtilizationMeasurementStatistics; 
Â Â Â Â runTime: MeasurementStatistics; 
Â Â Â Â tasks: TaskStatistics; 
Â Â Â Â waitTime: MeasurementStatistics; 
}
Defined in src/pools/worker.ts:184
 Index
Properties
elu
-runTime
-tasks
-waitTime
-
Properties
Readonly elu
elu: EventLoopUtilizationMeasurementStatistics
Tasks event loop utilization statistics.
-
Defined in src/pools/worker.ts:200
Readonly runTime
runTime: MeasurementStatistics
Tasks runtime statistics.
-
Defined in src/pools/worker.ts:192
Readonly tasks
tasks: TaskStatistics
Tasks statistics.
-
Defined in src/pools/worker.ts:188
Readonly waitTime
waitTime: MeasurementStatistics
Tasks wait time statistics.
-
Defined in src/pools/worker.ts:196
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
elu
runTime
tasks
waitTime
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+WorkerUsage | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerUsage
Interface WorkerUsageInternal 
Worker usage statistics.
+
interface WorkerUsage { 
Â Â Â Â elu: EventLoopUtilizationMeasurementStatistics; 
Â Â Â Â runTime: MeasurementStatistics; 
Â Â Â Â tasks: TaskStatistics; 
Â Â Â Â waitTime: MeasurementStatistics; 
}
Defined in src/pools/worker.ts:184
 Index
Properties
elu
+runTime
+tasks
+waitTime
+
Properties
Readonly elu
elu: EventLoopUtilizationMeasurementStatistics
Tasks event loop utilization statistics.
+
Defined in src/pools/worker.ts:200
Readonly runTime
runTime: MeasurementStatistics
Tasks runtime statistics.
+
Defined in src/pools/worker.ts:192
Readonly tasks
tasks: TaskStatistics
Tasks statistics.
+
Defined in src/pools/worker.ts:188
Readonly waitTime
waitTime: MeasurementStatistics
Tasks wait time statistics.
+
Defined in src/pools/worker.ts:196
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
On This Page
elu
runTime
tasks
waitTime
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/types/ClusterPoolOptions.html b/docs/types/ClusterPoolOptions.html
index 034225a9..49a9a613 100644
--- a/docs/types/ClusterPoolOptions.html
+++ b/docs/types/ClusterPoolOptions.html
@@ -1,2 +1,2 @@
-ClusterPoolOptions | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
ClusterPoolOptions
Type alias ClusterPoolOptions
ClusterPoolOptions: PoolOptions<Worker>
Options for a poolifier cluster pool.
-
Defined in src/pools/cluster/fixed.ts:10
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+ClusterPoolOptions | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
ClusterPoolOptions
Type alias ClusterPoolOptions
ClusterPoolOptions: PoolOptions<Worker>
Options for a poolifier cluster pool.
+
Defined in src/pools/cluster/fixed.ts:10
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/types/ErrorHandler.html b/docs/types/ErrorHandler.html
index 175a6302..89a523e4 100644
--- a/docs/types/ErrorHandler.html
+++ b/docs/types/ErrorHandler.html
@@ -1,3 +1,3 @@
-ErrorHandler | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
ErrorHandler
Type alias ErrorHandler<Worker>
ErrorHandler<Worker>: ((this, error) => void)
Callback invoked if the worker raised an error.
-
Type Parameters
Worker extends IWorker
Type of worker.
-
Type declaration
(this, error): void
Parameters
this: Worker
error: Error
Returns void
Defined in src/pools/worker.ts:28
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+ErrorHandler | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
ErrorHandler
Type alias ErrorHandler<Worker>
ErrorHandler<Worker>: ((this, error) => void)
Callback invoked if the worker raised an error.
+
Type Parameters
Worker extends IWorkerType of worker.
+
Type declaration
(this, error): void
Parameters
this: Worker
error: Error
Returns void
Defined in src/pools/worker.ts:28
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/types/EventHandler.html b/docs/types/EventHandler.html
index 63664a24..ec02bb04 100644
--- a/docs/types/EventHandler.html
+++ b/docs/types/EventHandler.html
@@ -1,3 +1,3 @@
-EventHandler | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
EventHandler
Type alias EventHandler<Worker>
EventHandler<Worker>: OnlineHandler<Worker> | MessageHandler<Worker> | ErrorHandler<Worker> | ExitHandler<Worker>
Worker event handler.
-
Type Parameters
Worker extends IWorker
Type of worker.
-
Defined in src/pools/worker.ts:48
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+EventHandler | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
EventHandler
Type alias EventHandler<Worker>
EventHandler<Worker>: OnlineHandler<Worker> | MessageHandler<Worker> | ErrorHandler<Worker> | ExitHandler<Worker>
Worker event handler.
+
Type Parameters
Worker extends IWorkerType of worker.
+
Defined in src/pools/worker.ts:48
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/types/ExitHandler.html b/docs/types/ExitHandler.html
index 4dc21b6e..dd56f1ac 100644
--- a/docs/types/ExitHandler.html
+++ b/docs/types/ExitHandler.html
@@ -1,3 +1,3 @@
-ExitHandler | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
ExitHandler
Type alias ExitHandler<Worker>
ExitHandler<Worker>: ((this, exitCode) => void)
Callback invoked when the worker exits successfully.
-
Type Parameters
Worker extends IWorker
Type of worker.
-
Type declaration
(this, exitCode): void
Parameters
this: Worker
exitCode: number
Returns void
Defined in src/pools/worker.ts:38
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+ExitHandler | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
ExitHandler
Type alias ExitHandler<Worker>
ExitHandler<Worker>: ((this, exitCode) => void)
Callback invoked when the worker exits successfully.
+
Type Parameters
Worker extends IWorkerType of worker.
+
Type declaration
(this, exitCode): void
Parameters
this: Worker
exitCode: number
Returns void
Defined in src/pools/worker.ts:38
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/types/KillBehavior.html b/docs/types/KillBehavior.html
index 294d509f..9d0ee4ef 100644
--- a/docs/types/KillBehavior.html
+++ b/docs/types/KillBehavior.html
@@ -1,2 +1,2 @@
-KillBehavior | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
KillBehavior
Type alias KillBehavior
KillBehavior: keyof typeof KillBehaviors
Kill behavior.
-
Defined in src/worker/worker-options.ts:18
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+KillBehavior | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
KillBehavior
Type alias KillBehavior
KillBehavior: keyof typeof KillBehaviors
Kill behavior.
+
Defined in src/worker/worker-options.ts:18
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/types/KillHandler.html b/docs/types/KillHandler.html
index 0f716990..24dd5985 100644
--- a/docs/types/KillHandler.html
+++ b/docs/types/KillHandler.html
@@ -1,2 +1,2 @@
-KillHandler | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
KillHandler
Type alias KillHandler
KillHandler: (() => void | Promise<void>)
Handler called when a worker is killed.
-
Type declaration
(): void | Promise<void>
Returns void | Promise<void>
Defined in src/worker/worker-options.ts:23
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+KillHandler | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
KillHandler
Type alias KillHandler
KillHandler: (() => void | Promise<void>)
Handler called when a worker is killed.
+
Type declaration
(): void | Promise<void>
Returns void | Promise<void>
Defined in src/worker/worker-options.ts:23
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/types/Measurement.html b/docs/types/Measurement.html
index bf3fcf5b..94cf9528 100644
--- a/docs/types/Measurement.html
+++ b/docs/types/Measurement.html
@@ -1,2 +1,2 @@
-Measurement | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
Measurement
Type alias Measurement
Measurement: keyof typeof Measurements
Measurement.
-
Defined in src/pools/selection-strategies/selection-strategies-types.ts:54
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+Measurement | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
Measurement
Type alias Measurement
Measurement: keyof typeof Measurements
Measurement.
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:54
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/types/MessageHandler.html b/docs/types/MessageHandler.html
index a7d8dee3..9554845e 100644
--- a/docs/types/MessageHandler.html
+++ b/docs/types/MessageHandler.html
@@ -1,3 +1,3 @@
-MessageHandler | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
MessageHandler
Type alias MessageHandler<Worker>
MessageHandler<Worker>: ((this, message) => void)
Callback invoked if the worker has received a message.
-
Type Parameters
Worker extends IWorker
Type of worker.
-
Type declaration
(this, message): void
Parameters
this: Worker
message: unknown
Returns void
Defined in src/pools/worker.ts:18
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+MessageHandler | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
MessageHandler
Type alias MessageHandler<Worker>
MessageHandler<Worker>: ((this, message) => void)
Callback invoked if the worker has received a message.
+
Type Parameters
Worker extends IWorkerType of worker.
+
Type declaration
(this, message): void
Parameters
this: Worker
message: unknown
Returns void
Defined in src/pools/worker.ts:18
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/types/OnlineHandler.html b/docs/types/OnlineHandler.html
index 9e1f73a0..dff8affe 100644
--- a/docs/types/OnlineHandler.html
+++ b/docs/types/OnlineHandler.html
@@ -1,3 +1,3 @@
-OnlineHandler | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
OnlineHandler
Type alias OnlineHandler<Worker>
OnlineHandler<Worker>: ((this) => void)
Callback invoked when the worker has started successfully.
-
Type Parameters
Worker extends IWorker
Type of worker.
-
Type declaration
(this): void
Parameters
this: Worker
Returns void
Defined in src/pools/worker.ts:11
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+OnlineHandler | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
OnlineHandler
Type alias OnlineHandler<Worker>
OnlineHandler<Worker>: ((this) => void)
Callback invoked when the worker has started successfully.
+
Type Parameters
Worker extends IWorkerType of worker.
+
Type declaration
(this): void
Parameters
this: Worker
Returns void
Defined in src/pools/worker.ts:11
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/types/PoolEvent.html b/docs/types/PoolEvent.html
index 34f91a9e..8bb22d1f 100644
--- a/docs/types/PoolEvent.html
+++ b/docs/types/PoolEvent.html
@@ -1,2 +1,2 @@
-PoolEvent | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
PoolEvent
Type alias PoolEvent
PoolEvent: keyof typeof PoolEvents
Pool event.
-
Defined in src/pools/pool.ts:55
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+PoolEvent | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
PoolEvent
Type alias PoolEvent
PoolEvent: keyof typeof PoolEvents
Pool event.
+
Defined in src/pools/pool.ts:55
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/types/PoolType.html b/docs/types/PoolType.html
index 48f56d53..4bc34bfc 100644
--- a/docs/types/PoolType.html
+++ b/docs/types/PoolType.html
@@ -1,2 +1,2 @@
-PoolType | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
PoolType
Type alias PoolType
PoolType: keyof typeof PoolTypes
Pool type.
-
Defined in src/pools/pool.ts:36
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+PoolType | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
PoolType
Type alias PoolType
PoolType: keyof typeof PoolTypes
Pool type.
+
Defined in src/pools/pool.ts:36
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/types/TaskAsyncFunction.html b/docs/types/TaskAsyncFunction.html
index aa36d707..d5130c2c 100644
--- a/docs/types/TaskAsyncFunction.html
+++ b/docs/types/TaskAsyncFunction.html
@@ -1,6 +1,6 @@
-TaskAsyncFunction | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
TaskAsyncFunction
Type alias TaskAsyncFunction<Data, Response>
TaskAsyncFunction<Data, Response>: ((data?) => Promise<Response>)
Task asynchronous function that can be executed.
+TaskAsyncFunction | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
TaskAsyncFunction
Type alias TaskAsyncFunction<Data, Response>
TaskAsyncFunction<Data, Response>: ((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?): Promise<Response>
Parameters
Optional data: Data
Data sent to the worker.
-
Returns Promise<Response>
Defined in src/worker/task-functions.ts:22
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+
Type Parameters
Data = unknownType of data sent to the worker. This can only be structured-cloneable data.
+
Response = unknownType of execution response. This can only be structured-cloneable data.
+
Type declaration
(data?): Promise<Response>
Parameters
Optional data: DataData sent to the worker.
+
Returns Promise<Response>
Defined in src/worker/task-functions.ts:22
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/types/TaskFunction.html b/docs/types/TaskFunction.html
index fb14e913..d2003340 100644
--- a/docs/types/TaskFunction.html
+++ b/docs/types/TaskFunction.html
@@ -1,5 +1,5 @@
-TaskFunction | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
TaskFunction
Type alias TaskFunction<Data, Response>
TaskFunction<Data, Response>: TaskSyncFunction<Data, Response> | TaskAsyncFunction<Data, Response>
Task function that can be executed.
+TaskFunction | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
TaskFunction
Type alias TaskFunction<Data, Response>
TaskFunction<Data, Response>: TaskSyncFunction<Data, Response> | TaskAsyncFunction<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.
-
Defined in src/worker/task-functions.ts:33
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+
Type Parameters
Data = unknownType of data sent to the worker. This can only be structured-cloneable data.
+
Response = unknownType of execution response. This can only be structured-cloneable data.
+
Defined in src/worker/task-functions.ts:33
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/types/TaskFunctions.html b/docs/types/TaskFunctions.html
index 80ff8084..b8f1ff17 100644
--- a/docs/types/TaskFunctions.html
+++ b/docs/types/TaskFunctions.html
@@ -1,7 +1,7 @@
-TaskFunctions | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
TaskFunctions
Type alias TaskFunctions<Data, Response>
TaskFunctions<Data, Response>: Record<string, TaskFunction<Data, Response>>
Tasks functions that can be executed.
+TaskFunctions | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
TaskFunctions
Type alias TaskFunctions<Data, Response>
TaskFunctions<Data, Response>: Record<string, TaskFunction<Data, Response>>
Tasks functions that can be executed.
 This object can contain synchronous or asynchronous functions.
 The key is the name of the function.
 The value is the function itself.
-
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.
-
Defined in src/worker/task-functions.ts:46
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+
Type Parameters
Data = unknownType of data sent to the worker. This can only be structured-cloneable data.
+
Response = unknownType of execution response. This can only be structured-cloneable data.
+
Defined in src/worker/task-functions.ts:46
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/types/TaskSyncFunction.html b/docs/types/TaskSyncFunction.html
index 00903d93..4f4f82a6 100644
--- a/docs/types/TaskSyncFunction.html
+++ b/docs/types/TaskSyncFunction.html
@@ -1,5 +1,5 @@
-TaskSyncFunction | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
TaskSyncFunction
Type alias TaskSyncFunction<Data, Response>
TaskSyncFunction<Data, Response>: ((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?): Response
Parameters
Optional data: Data
Data sent to the worker.
-
Returns Response
Defined in src/worker/task-functions.ts:9
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+TaskSyncFunction | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
TaskSyncFunction
Type alias TaskSyncFunction<Data, Response>
TaskSyncFunction<Data, Response>: ((data?) => Response)
Task synchronous function that can be executed.
+
Type Parameters
Data = unknownType of data sent to the worker. This can only be structured-cloneable data.
+
Response = unknownType of execution response. This can only be structured-cloneable data.
+
Type declaration
(data?): Response
Parameters
Optional data: DataData sent to the worker.
+
Returns Response
Defined in src/worker/task-functions.ts:9
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/types/ThreadPoolOptions.html b/docs/types/ThreadPoolOptions.html
index 3c3abe75..68c0c848 100644
--- a/docs/types/ThreadPoolOptions.html
+++ b/docs/types/ThreadPoolOptions.html
@@ -1,2 +1,2 @@
-ThreadPoolOptions | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
ThreadPoolOptions
Type alias ThreadPoolOptions
ThreadPoolOptions: PoolOptions<Worker>
Options for a poolifier thread pool.
-
Defined in src/pools/thread/fixed.ts:14
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+ThreadPoolOptions | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
ThreadPoolOptions
Type alias ThreadPoolOptions
ThreadPoolOptions: PoolOptions<Worker>
Options for a poolifier thread pool.
+
Defined in src/pools/thread/fixed.ts:14
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/types/WorkerChoiceStrategy.html b/docs/types/WorkerChoiceStrategy.html
index 8956dc6f..ee0563c0 100644
--- a/docs/types/WorkerChoiceStrategy.html
+++ b/docs/types/WorkerChoiceStrategy.html
@@ -1,2 +1,2 @@
-WorkerChoiceStrategy | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerChoiceStrategy
Type alias WorkerChoiceStrategy
WorkerChoiceStrategy: keyof typeof WorkerChoiceStrategies
Worker choice strategy.
-
Defined in src/pools/selection-strategies/selection-strategies-types.ts:40
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+WorkerChoiceStrategy | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerChoiceStrategy
Type alias WorkerChoiceStrategy
WorkerChoiceStrategy: keyof typeof WorkerChoiceStrategies
Worker choice strategy.
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:40
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/types/WorkerType.html b/docs/types/WorkerType.html
index 477b1a92..854ccbf2 100644
--- a/docs/types/WorkerType.html
+++ b/docs/types/WorkerType.html
@@ -1,2 +1,2 @@
-WorkerType | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerType
Type alias WorkerType
WorkerType: keyof typeof WorkerTypes
Worker type.
-
Defined in src/pools/worker.ts:144
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+WorkerType | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerType
Type alias WorkerType
WorkerType: keyof typeof WorkerTypes
Worker type.
+
Defined in src/pools/worker.ts:144
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/types/Writable.html b/docs/types/Writable.html
index d378e3a6..0c3289e7 100644
--- a/docs/types/Writable.html
+++ b/docs/types/Writable.html
@@ -1 +1 @@
-Writable | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
Writable
Type alias Writable<T>
Writable<T>: {
Â Â Â Â -readonly [P in keyof T]: T[P]
}
Type Parameters
T
Defined in src/utility-types.ts:186
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+Writable | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
Writable
Type alias Writable<T>
Writable<T>: {
Â Â Â Â -readonly [P in keyof T]: T[P]
}
Type Parameters
T
Defined in src/utility-types.ts:186
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/variables/KillBehaviors.html b/docs/variables/KillBehaviors.html
index 7bf7a9f7..54dc6d70 100644
--- a/docs/variables/KillBehaviors.html
+++ b/docs/variables/KillBehaviors.html
@@ -1,4 +1,4 @@
-KillBehaviors | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
KillBehaviors
Variable KillBehaviorsConst 
KillBehaviors: Readonly<{ 
Â Â Â Â HARD: "HARD"; 
Â Â Â Â SOFT: "SOFT"; 
}> = ...
Enumeration of kill behaviors.
+KillBehaviors | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
KillBehaviors
Variable KillBehaviorsConst 
KillBehaviors: Readonly<{ 
Â Â Â Â HARD: "HARD"; 
Â Â Â Â SOFT: "SOFT"; 
}> = ...
Enumeration of kill behaviors.
 
Type declaration
Readonly HARD: "HARD"
If currentTime - lastActiveTime is greater than maxInactiveTime but a task is still executing or queued, then the worker will be deleted.
 
Readonly SOFT: "SOFT"
If currentTime - lastActiveTime is greater than maxInactiveTime but a task is still executing or queued, then the worker wont be deleted.
-
Defined in src/worker/worker-options.ts:4
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+
Defined in src/worker/worker-options.ts:4
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/variables/Measurements.html b/docs/variables/Measurements.html
index c0c656df..16c085f5 100644
--- a/docs/variables/Measurements.html
+++ b/docs/variables/Measurements.html
@@ -1,2 +1,2 @@
-Measurements | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
Measurements
Variable MeasurementsConst 
Measurements: Readonly<{ 
Â Â Â Â elu: "elu"; 
Â Â Â Â runTime: "runTime"; 
Â Â Â Â waitTime: "waitTime"; 
}> = ...
Enumeration of measurements.
-
Type declaration
Readonly elu: "elu"
Readonly runTime: "runTime"
Readonly waitTime: "waitTime"
Defined in src/pools/selection-strategies/selection-strategies-types.ts:45
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+Measurements | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
Measurements
Variable MeasurementsConst 
Measurements: Readonly<{ 
Â Â Â Â elu: "elu"; 
Â Â Â Â runTime: "runTime"; 
Â Â Â Â waitTime: "waitTime"; 
}> = ...
Enumeration of measurements.
+
Type declaration
Readonly elu: "elu"
Readonly runTime: "runTime"
Readonly waitTime: "waitTime"
Defined in src/pools/selection-strategies/selection-strategies-types.ts:45
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/variables/PoolEvents.html b/docs/variables/PoolEvents.html
index 9b1381fb..625a918f 100644
--- a/docs/variables/PoolEvents.html
+++ b/docs/variables/PoolEvents.html
@@ -1,2 +1,2 @@
-PoolEvents | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
PoolEvents
Variable PoolEventsConst 
PoolEvents: Readonly<{ 
Â Â Â Â backPressure: "backPressure"; 
Â Â Â Â busy: "busy"; 
Â Â Â Â destroy: "destroy"; 
Â Â Â Â empty: "empty"; 
Â Â Â Â error: "error"; 
Â Â Â Â full: "full"; 
Â Â Â Â ready: "ready"; 
Â Â Â Â taskError: "taskError"; 
}> = ...
Enumeration of pool events.
-
Type declaration
Readonly backPressure: "backPressure"
Readonly busy: "busy"
Readonly destroy: "destroy"
Readonly empty: "empty"
Readonly error: "error"
Readonly full: "full"
Readonly ready: "ready"
Readonly taskError: "taskError"
Defined in src/pools/pool.ts:41
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+PoolEvents | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
PoolEvents
Variable PoolEventsConst 
PoolEvents: Readonly<{ 
Â Â Â Â backPressure: "backPressure"; 
Â Â Â Â busy: "busy"; 
Â Â Â Â destroy: "destroy"; 
Â Â Â Â empty: "empty"; 
Â Â Â Â error: "error"; 
Â Â Â Â full: "full"; 
Â Â Â Â ready: "ready"; 
Â Â Â Â taskError: "taskError"; 
}> = ...
Enumeration of pool events.
+
Type declaration
Readonly backPressure: "backPressure"
Readonly busy: "busy"
Readonly destroy: "destroy"
Readonly empty: "empty"
Readonly error: "error"
Readonly full: "full"
Readonly ready: "ready"
Readonly taskError: "taskError"
Defined in src/pools/pool.ts:41
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/variables/PoolTypes.html b/docs/variables/PoolTypes.html
index 32bc69a7..d85b0e7f 100644
--- a/docs/variables/PoolTypes.html
+++ b/docs/variables/PoolTypes.html
@@ -1,4 +1,4 @@
-PoolTypes | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
PoolTypes
Variable PoolTypesConst 
PoolTypes: Readonly<{ 
Â Â Â Â dynamic: "dynamic"; 
Â Â Â Â fixed: "fixed"; 
}> = ...
Enumeration of pool types.
+PoolTypes | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
PoolTypes
Variable PoolTypesConst 
PoolTypes: Readonly<{ 
Â Â Â Â dynamic: "dynamic"; 
Â Â Â Â fixed: "fixed"; 
}> = ...
Enumeration of pool types.
 
Type declaration
Readonly dynamic: "dynamic"
Dynamic pool type.
 
Readonly fixed: "fixed"
Fixed pool type.
-
Defined in src/pools/pool.ts:22
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+
Defined in src/pools/pool.ts:22
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/variables/WorkerChoiceStrategies.html b/docs/variables/WorkerChoiceStrategies.html
index 9c975148..902e9ae1 100644
--- a/docs/variables/WorkerChoiceStrategies.html
+++ b/docs/variables/WorkerChoiceStrategies.html
@@ -1,4 +1,4 @@
-WorkerChoiceStrategies | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerChoiceStrategies
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.
+WorkerChoiceStrategies | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerChoiceStrategies
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.
 
Type declaration
Readonly FAIR_SHARE: "FAIR_SHARE"
Fair share worker selection strategy.
 
Readonly Experimental INTERLEAVED_WEIGHTED_ROUND_ROBIN: "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
Interleaved weighted round robin worker selection strategy.
 
Readonly LEAST_BUSY: "LEAST_BUSY"
Least busy worker selection strategy.
@@ -6,4 +6,4 @@
 
Readonly LEAST_USED: "LEAST_USED"
Least used worker selection strategy.
 
Readonly ROUND_ROBIN: "ROUND_ROBIN"
Round robin worker selection strategy.
 
Readonly WEIGHTED_ROUND_ROBIN: "WEIGHTED_ROUND_ROBIN"
Weighted round robin worker selection strategy.
-
Defined in src/pools/selection-strategies/selection-strategies-types.ts:4
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:4
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file
diff --git a/docs/variables/WorkerTypes.html b/docs/variables/WorkerTypes.html
index c21dd0cc..aff2814f 100644
--- a/docs/variables/WorkerTypes.html
+++ b/docs/variables/WorkerTypes.html
@@ -1,2 +1,2 @@
-WorkerTypes | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerTypes
Variable WorkerTypesConst 
WorkerTypes: Readonly<{ 
Â Â Â Â cluster: "cluster"; 
Â Â Â Â thread: "thread"; 
}> = ...
Enumeration of worker types.
-
Type declaration
Readonly cluster: "cluster"
Readonly thread: "thread"
Defined in src/pools/worker.ts:136
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21AbstractPool
AbstractWorker
CircularArray
ClusterWorker
Deque
DynamicClusterPool
DynamicThreadPool
FixedClusterPool
FixedThreadPool
ThreadWorker
WorkerChoiceStrategyContext
EventLoopUtilizationMeasurementStatistics
ILinkedListNode
IPool
IWorker
IWorkerChoiceStrategy
IWorkerNode
MeasurementOptions
MeasurementStatistics
MeasurementStatisticsRequirements
MessageValue
Loading...
Generated using TypeDoc

\ No newline at end of file
+WorkerTypes | poolifier - v3.1.21
Preparing search index...
The search index is not available
poolifier - v3.1.21
poolifier
WorkerTypes
Variable WorkerTypesConst 
WorkerTypes: Readonly<{ 
Â Â Â Â cluster: "cluster"; 
Â Â Â Â thread: "thread"; 
}> = ...
Enumeration of worker types.
+
Type declaration
Readonly cluster: "cluster"
Readonly thread: "thread"
Defined in src/pools/worker.ts:136
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
poolifier - v3.1.21Loading...
Generated using TypeDoc

\ No newline at end of file

Class AbstractPool<Worker, Data, Response>Abstract

Type Parameters

Worker extends IWorker

Data = unknown

Response = unknown

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Worker extends IWorker

Data = unknown

Response = unknown

Parameters

minimumNumberOfWorkers: number

filePath: string

opts: PoolOptions<Worker>

Optional maximumNumberOfWorkers: number

Returns AbstractPool<Worker, Data, Response>

Properties

Private destroying

Optional emitter

Class AbstractPool<Worker, Data, Response>Abstract

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AbstractPool<Worker, Data, Response>

Properties

Private destroying

Optional emitter

Protected Readonly filePath

Protected Optional Readonly maximumNumberOfWorkers

Protected Readonly minimumNumberOfWorkers

Protected Readonly opts

Protected promiseResponseMap

Protected Readonly filePath

Protected Optional Readonly maximumNumberOfWorkers

Protected Readonly minimumNumberOfWorkers

Protected Readonly opts

Protected promiseResponseMap

Private readyEventEmitted

Private Readonly startTimestamp

Private started

Private starting

Private Readonly taskFunctions

Private readyEventEmitted

Private Readonly startTimestamp

Private started

Private starting

Private Readonly taskFunctions

Protected Optional workerChoiceStrategyContext

Readonly Internal workerNodes

Accessors

Protected Abstract busy

Protected Optional workerChoiceStrategyContext

Readonly Internal workerNodes

Accessors

Protected Abstract busy

Returns boolean

Protected empty

Returns boolean

Protected full

Returns boolean

Protected empty

Returns boolean

Protected full

Class AbstractPool<Worker, Data, Response>`Abstract`

`Optional` maximumNumberOfWorkers: number

`Private` destroying

`Optional` emitter

Class AbstractPool<Worker, Data, Response>`Abstract`

`Private` destroying

`Optional` emitter

`Protected` `Readonly` filePath

`Protected` `Optional` `Readonly` maximumNumberOfWorkers

`Protected` `Readonly` minimumNumberOfWorkers

`Protected` `Readonly` opts

`Protected` promiseResponseMap

`Protected` `Readonly` filePath

`Protected` `Optional` `Readonly` maximumNumberOfWorkers

`Protected` `Readonly` minimumNumberOfWorkers

`Protected` `Readonly` opts

`Protected` promiseResponseMap

`Private` readyEventEmitted

`Private` `Readonly` startTimestamp

`Private` started

`Private` starting

`Private` `Readonly` taskFunctions

`Private` readyEventEmitted

`Private` `Readonly` startTimestamp

`Private` started

`Private` starting

`Private` `Readonly` taskFunctions

`Protected` `Optional` workerChoiceStrategyContext

`Readonly` `Internal` workerNodes

`Accessors`

`Protected` `Abstract` busy

`Protected` `Optional` workerChoiceStrategyContext

`Readonly` `Internal` workerNodes

`Accessors`

`Protected` `Abstract` busy

`Protected` empty

`Protected` full

`Protected` empty

`Protected` full

`Private` ready

`Protected` `Abstract` type

`Private` ready

`Protected` `Abstract` type

`Private` utilization

`Private` utilization

`Protected` `Abstract` worker

`Methods`

`Private` addWorkerNode

`Protected` `Abstract` worker

`Methods`

`Private` addWorkerNode

`Protected` afterTaskExecutionHook

`Protected` afterTaskExecutionHook

`Protected` afterWorkerNodeSetup

`Protected` afterWorkerNodeSetup

`Protected` beforeTaskExecutionHook

`Protected` beforeTaskExecutionHook

`Private` buildTasksQueueOptions

`Private` cannotStealTask

`Protected` `Abstract` checkAndEmitDynamicWorkerCreationEvents