1 <!DOCTYPE html
><html class=
"default" lang=
"en"><head><meta charSet=
"utf-8"/><meta http-equiv=
"x-ua-compatible" content=
"IE=edge"/><title>IPool | poolifier - v3.1
.29</title><meta name=
"description" content=
"Documentation for poolifier"/><meta name=
"viewport" content=
"width=device-width, initial-scale=1"/><link rel=
"stylesheet" href=
"../assets/style.css"/><link rel=
"stylesheet" href=
"../assets/highlight.css"/><script defer
src=
"../assets/main.js"></script><script async
src=
"../assets/icons.js" id=
"tsd-icons-script"></script><script async
src=
"../assets/search.js" id=
"tsd-search-script"></script><script async
src=
"../assets/navigation.js" id=
"tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem(
"tsd-theme") ||
"os";document.body.style.
display=
"none";setTimeout(() =
> app?app.showPage():document.body.style.removeProperty(
"display"),
500)
</script><header class=
"tsd-page-toolbar"><div class=
"tsd-toolbar-contents container"><div class=
"table-cell" id=
"tsd-search" data-base=
".."><div class=
"field"><label for=
"tsd-search-field" class=
"tsd-widget tsd-toolbar-icon search no-caption"><svg width=
"16" height=
"16" viewBox=
"0 0 16 16" fill=
"none"><use href=
"../assets/icons.svg#icon-search"></use></svg></label><input type=
"text" id=
"tsd-search-field" aria-label=
"Search"/></div><div class=
"field"><div id=
"tsd-toolbar-links"></div></div><ul class=
"results"><li class=
"state loading">Preparing search index...
</li><li class=
"state failure">The search index is not available
</li></ul><a href=
"../index.html" class=
"title">poolifier - v3.1
.29</a></div><div class=
"table-cell" id=
"tsd-widgets"><a href=
"#" class=
"tsd-widget tsd-toolbar-icon menu no-caption" data-toggle=
"menu" aria-label=
"Menu"><svg width=
"16" height=
"16" viewBox=
"0 0 16 16" fill=
"none"><use href=
"../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class=
"container container-main"><div class=
"col-content"><div class=
"tsd-page-title"><ul class=
"tsd-breadcrumb"><li><a href=
"../index.html">poolifier
</a></li><li><a href=
"IPool.html">IPool
</a></li></ul><h1>Interface IPool
<Worker, Data, Response
></h1></div><section class=
"tsd-panel tsd-comment"><div class=
"tsd-comment tsd-typography"><p>Contract definition for a poolifier pool.
</p>
2 </div><div class=
"tsd-comment tsd-typography"></div></section><div class=
"tsd-signature"><span class=
"tsd-signature-keyword">interface
</span><span class=
"tsd-kind-interface">IPool
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"IPool.html#Worker">Worker
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"IPool.html#Data">Data
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"IPool.html#Response">Response
</a><span class=
"tsd-signature-symbol">></span> <span class=
"tsd-signature-symbol">{
</span><br/><span> </span><a class=
"tsd-kind-property" href=
"IPool.html#addTaskFunction">addTaskFunction
</a><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">name
</span>,
<span class=
"tsd-kind-parameter">fn
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">boolean
</span><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">;
</span><br/><span> </span><a class=
"tsd-kind-property" href=
"IPool.html#destroy">destroy
</a><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">void
</span><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">;
</span><br/><span> </span><a class=
"tsd-kind-property" href=
"IPool.html#emitter">emitter
</a><span class=
"tsd-signature-symbol">?:
</span><span class=
"tsd-signature-type">EventEmitterAsyncResource
</span><span class=
"tsd-signature-symbol">;
</span><br/><span> </span><a class=
"tsd-kind-property" href=
"IPool.html#enableTasksQueue">enableTasksQueue
</a><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">enable
</span>,
<span class=
"tsd-kind-parameter">tasksQueueOptions
</span><span class=
"tsd-signature-symbol">?
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">void
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">;
</span><br/><span> </span><a class=
"tsd-kind-property" href=
"IPool.html#execute">execute
</a><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">data
</span><span class=
"tsd-signature-symbol">?
</span>,
<span class=
"tsd-kind-parameter">name
</span><span class=
"tsd-signature-symbol">?
</span>,
<span class=
"tsd-kind-parameter">transferList
</span><span class=
"tsd-signature-symbol">?
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"IPool.html#Response">Response
</a><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">;
</span><br/><span> </span><a class=
"tsd-kind-property" href=
"IPool.html#hasTaskFunction">hasTaskFunction
</a><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">name
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">boolean
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">;
</span><br/><span> </span><a class=
"tsd-kind-property" href=
"IPool.html#info">info
</a><span class=
"tsd-signature-symbol">:
</span><a href=
"PoolInfo.html" class=
"tsd-signature-type tsd-kind-interface">PoolInfo
</a><span class=
"tsd-signature-symbol">;
</span><br/><span> </span><a class=
"tsd-kind-property" href=
"IPool.html#listTaskFunctionNames">listTaskFunctionNames
</a><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">string
</span><span class=
"tsd-signature-symbol">[]
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">;
</span><br/><span> </span><a class=
"tsd-kind-property" href=
"IPool.html#removeTaskFunction">removeTaskFunction
</a><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">name
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">boolean
</span><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">;
</span><br/><span> </span><a class=
"tsd-kind-property" href=
"IPool.html#setDefaultTaskFunction">setDefaultTaskFunction
</a><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">name
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">boolean
</span><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">;
</span><br/><span> </span><a class=
"tsd-kind-property" href=
"IPool.html#setTasksQueueOptions">setTasksQueueOptions
</a><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">tasksQueueOptions
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">void
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">;
</span><br/><span> </span><a class=
"tsd-kind-property" href=
"IPool.html#setWorkerChoiceStrategy">setWorkerChoiceStrategy
</a><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerChoiceStrategy
</span>,
<span class=
"tsd-kind-parameter">workerChoiceStrategyOptions
</span><span class=
"tsd-signature-symbol">?
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">void
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">;
</span><br/><span> </span><a class=
"tsd-kind-property" href=
"IPool.html#setWorkerChoiceStrategyOptions">setWorkerChoiceStrategyOptions
</a><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerChoiceStrategyOptions
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">void
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">;
</span><br/><span> </span><a class=
"tsd-kind-property" href=
"IPool.html#start">start
</a><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">void
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">;
</span><br/><span> </span><a class=
"tsd-kind-property" href=
"IPool.html#workerNodes">workerNodes
</a><span class=
"tsd-signature-symbol">:
</span><a href=
"IWorkerNode.html" class=
"tsd-signature-type tsd-kind-interface">IWorkerNode
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"IPool.html#Worker">Worker
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"IPool.html#Data">Data
</a><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol">[]
</span><span class=
"tsd-signature-symbol">;
</span><br/><span class=
"tsd-signature-symbol">}
</span></div> <section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><span><a id=
"Worker" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">Worker
</span><span class=
"tsd-signature-keyword"> extends
</span><a href=
"IWorker.html" class=
"tsd-signature-type tsd-kind-interface">IWorker
</a></span><div class=
"tsd-comment tsd-typography"><p>Type of worker which manages this pool.
</p>
3 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><a id=
"Data" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">Data
</span> =
<span class=
"tsd-signature-type">unknown
</span></span><div class=
"tsd-comment tsd-typography"><p>Type of data sent to the worker. This can only be structured-cloneable data.
</p>
4 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><a id=
"Response" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">Response
</span> =
<span class=
"tsd-signature-type">unknown
</span></span><div class=
"tsd-comment tsd-typography"><p>Type of execution response. This can only be structured-cloneable data.
</p>
5 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></section> <section class=
"tsd-panel"><h4>Implemented by
</h4><ul class=
"tsd-hierarchy"><li><a href=
"../classes/AbstractPool.html" class=
"tsd-signature-type tsd-kind-class">AbstractPool
</a></li></ul></section><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/a2568a2/src/pools/pool.ts#L243">src/pools/pool.ts:
243</a></li></ul></aside><section class=
"tsd-panel-group tsd-index-group"><section class=
"tsd-panel tsd-index-panel"><details class=
"tsd-index-content tsd-index-accordion" open
><summary class=
"tsd-accordion-summary tsd-index-summary"><h5 class=
"tsd-index-heading uppercase" role=
"button" aria-expanded=
"false" tabIndex=
"0"><svg width=
"16" height=
"16" viewBox=
"0 0 16 16" fill=
"none"><use href=
"../assets/icons.svg#icon-chevronSmall"></use></svg> Index
</h5></summary><div class=
"tsd-accordion-details"><section class=
"tsd-index-section"><h3 class=
"tsd-index-heading">Properties
</h3><div class=
"tsd-index-list"><a href=
"IPool.html#addTaskFunction" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>add
<wbr/>Task
<wbr/>Function
</span></a>
6 <a href=
"IPool.html#destroy" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>destroy
</span></a>
7 <a href=
"IPool.html#emitter" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>emitter?
</span></a>
8 <a href=
"IPool.html#enableTasksQueue" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>enable
<wbr/>Tasks
<wbr/>Queue
</span></a>
9 <a href=
"IPool.html#execute" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>execute
</span></a>
10 <a href=
"IPool.html#hasTaskFunction" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>has
<wbr/>Task
<wbr/>Function
</span></a>
11 <a href=
"IPool.html#info" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>info
</span></a>
12 <a href=
"IPool.html#listTaskFunctionNames" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>list
<wbr/>Task
<wbr/>Function
<wbr/>Names
</span></a>
13 <a href=
"IPool.html#removeTaskFunction" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>remove
<wbr/>Task
<wbr/>Function
</span></a>
14 <a href=
"IPool.html#setDefaultTaskFunction" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>set
<wbr/>Default
<wbr/>Task
<wbr/>Function
</span></a>
15 <a href=
"IPool.html#setTasksQueueOptions" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>set
<wbr/>Tasks
<wbr/>Queue
<wbr/>Options
</span></a>
16 <a href=
"IPool.html#setWorkerChoiceStrategy" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>set
<wbr/>Worker
<wbr/>Choice
<wbr/>Strategy
</span></a>
17 <a href=
"IPool.html#setWorkerChoiceStrategyOptions" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>set
<wbr/>Worker
<wbr/>Choice
<wbr/>Strategy
<wbr/>Options
</span></a>
18 <a href=
"IPool.html#start" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>start
</span></a>
19 <a href=
"IPool.html#workerNodes" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>worker
<wbr/>Nodes
</span></a>
20 </div></section></div></details></section></section><section class=
"tsd-panel-group tsd-member-group"><h2>Properties
</h2><section class=
"tsd-panel tsd-member"><a id=
"addTaskFunction" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>add
<wbr/>Task
<wbr/>Function
</span><a href=
"#addTaskFunction" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">add
<wbr/>Task
<wbr/>Function
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">name
</span>,
<span class=
"tsd-kind-parameter">fn
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">boolean
</span><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol">)
</span></div><div class=
"tsd-comment tsd-typography"><p>Adds a task function to this pool.
21 If a task function with the same name already exists, it will be overwritten.
</p>
22 </div><div class=
"tsd-type-declaration"><h4>Type declaration
</h4><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures"><li class=
"tsd-signature" id=
"addTaskFunction.__type.__type-1"><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">name
</span>,
<span class=
"tsd-kind-parameter">fn
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">boolean
</span><span class=
"tsd-signature-symbol">></span></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">name
</span>:
<span class=
"tsd-signature-type">string
</span></span><div class=
"tsd-comment tsd-typography"><p>The name of the task function.
</p>
23 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><span class=
"tsd-kind-parameter">fn
</span>:
<a href=
"../types/TaskFunction.html" class=
"tsd-signature-type tsd-kind-type-alias">TaskFunction
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"IPool.html#Data">Data
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"IPool.html#Response">Response
</a><span class=
"tsd-signature-symbol">></span></span><div class=
"tsd-comment tsd-typography"><p>The task function.
</p>
24 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">boolean
</span><span class=
"tsd-signature-symbol">></span></h4></li></ul></li></ul></div><div class=
"tsd-comment tsd-typography"><h4>Returns
</h4><p><code>true
</code> if the task function was added,
<code>false
</code> otherwise.
</p>
25 <h4>Throws
</h4><p><a href=
"https://nodejs.org/api/errors.html#class-typeerror">https://nodejs.org/api/errors.html#class-typeerror
</a> If the
<code>name
</code> parameter is not a string or an empty string.
</p>
26 <h4>Throws
</h4><p><a href=
"https://nodejs.org/api/errors.html#class-typeerror">https://nodejs.org/api/errors.html#class-typeerror
</a> If the
<code>fn
</code> parameter is not a function.
</p>
27 </div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/a2568a2/src/pools/pool.ts#L312">src/pools/pool.ts:
312</a></li></ul></aside></section><section class=
"tsd-panel tsd-member"><a id=
"destroy" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>destroy
</span><a href=
"#destroy" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">destroy
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">void
</span><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol">)
</span></div><div class=
"tsd-comment tsd-typography"><p>Terminates all workers in this pool.
</p>
28 </div><div class=
"tsd-type-declaration"><h4>Type declaration
</h4><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures"><li class=
"tsd-signature" id=
"destroy.__type-2.__type-3"><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">void
</span><span class=
"tsd-signature-symbol">></span></li><li class=
"tsd-description"><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">void
</span><span class=
"tsd-signature-symbol">></span></h4></li></ul></li></ul></div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/a2568a2/src/pools/pool.ts#L294">src/pools/pool.ts:
294</a></li></ul></aside></section><section class=
"tsd-panel tsd-member"><a id=
"emitter" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagOptional">Optional
</code> <code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>emitter
</span><a href=
"#emitter" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">emitter
</span><span class=
"tsd-signature-symbol">?:
</span> <span class=
"tsd-signature-type">EventEmitterAsyncResource
</span></div><div class=
"tsd-comment tsd-typography"><p>Pool event emitter integrated with async resource.
29 The async tracking tooling identifier is
<code>poolifier:
<PoolType
>-
<WorkerType
>-pool
</code>.
</p>
30 <p>Events that can currently be listened to:
</p>
32 <li><code>'ready
'</code>: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready. If the pool is dynamic with a minimum number of workers is set to zero, this event is emitted when at least one dynamic worker is ready.
</li>
33 <li><code>'busy
'</code>: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.
</li>
34 <li><code>'full
'</code>: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
</li>
35 <li><code>'empty
'</code>: Emitted when the pool is dynamic with a minimum number of workers set to zero and the number of workers has reached the minimum size expected.
</li>
36 <li><code>'destroy
'</code>: Emitted when the pool is destroyed.
</li>
37 <li><code>'error
'</code>: Emitted when an uncaught error occurs.
</li>
38 <li><code>'taskError
'</code>: Emitted when an error occurs while executing a task.
</li>
39 <li><code>'backPressure
'</code>: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size
>= maximum queue size).
</li>
41 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/a2568a2/src/pools/pool.ts#L273">src/pools/pool.ts:
273</a></li></ul></aside></section><section class=
"tsd-panel tsd-member"><a id=
"enableTasksQueue" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>enable
<wbr/>Tasks
<wbr/>Queue
</span><a href=
"#enableTasksQueue" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">enable
<wbr/>Tasks
<wbr/>Queue
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">enable
</span>,
<span class=
"tsd-kind-parameter">tasksQueueOptions
</span><span class=
"tsd-signature-symbol">?
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">void
</span><span class=
"tsd-signature-symbol">)
</span></div><div class=
"tsd-comment tsd-typography"><p>Enables/disables the worker node tasks queue in this pool.
</p>
42 </div><div class=
"tsd-type-declaration"><h4>Type declaration
</h4><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures"><li class=
"tsd-signature" id=
"enableTasksQueue.__type-4.__type-5"><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">enable
</span>,
<span class=
"tsd-kind-parameter">tasksQueueOptions
</span><span class=
"tsd-signature-symbol">?
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">enable
</span>:
<span class=
"tsd-signature-type">boolean
</span></span><div class=
"tsd-comment tsd-typography"><p>Whether to enable or disable the worker node tasks queue.
</p>
43 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">tasksQueueOptions
</span>:
<a href=
"TasksQueueOptions.html" class=
"tsd-signature-type tsd-kind-interface">TasksQueueOptions
</a></span><div class=
"tsd-comment tsd-typography"><p>The worker node tasks queue options.
</p>
44 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4></li></ul></li></ul></div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/a2568a2/src/pools/pool.ts#L360">src/pools/pool.ts:
360</a></li></ul></aside></section><section class=
"tsd-panel tsd-member"><a id=
"execute" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>execute
</span><a href=
"#execute" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">execute
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">data
</span><span class=
"tsd-signature-symbol">?
</span>,
<span class=
"tsd-kind-parameter">name
</span><span class=
"tsd-signature-symbol">?
</span>,
<span class=
"tsd-kind-parameter">transferList
</span><span class=
"tsd-signature-symbol">?
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"IPool.html#Response">Response
</a><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol">)
</span></div><div class=
"tsd-comment tsd-typography"><p>Executes the specified function in the worker constructor with the task data input parameter.
</p>
45 </div><div class=
"tsd-type-declaration"><h4>Type declaration
</h4><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures"><li class=
"tsd-signature" id=
"execute.__type-6.__type-7"><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">data
</span><span class=
"tsd-signature-symbol">?
</span>,
<span class=
"tsd-kind-parameter">name
</span><span class=
"tsd-signature-symbol">?
</span>,
<span class=
"tsd-kind-parameter">transferList
</span><span class=
"tsd-signature-symbol">?
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"IPool.html#Response">Response
</a><span class=
"tsd-signature-symbol">></span></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">data
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"IPool.html#Data">Data
</a></span><div class=
"tsd-comment tsd-typography"><p>The optional task input data for the specified task function. This can only be structured-cloneable data.
</p>
46 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">name
</span>:
<span class=
"tsd-signature-type">string
</span></span><div class=
"tsd-comment tsd-typography"><p>The optional name of the task function to execute. If not specified, the default task function will be executed.
</p>
47 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">transferList
</span>:
<span class=
"tsd-signature-type">TransferListItem
</span><span class=
"tsd-signature-symbol">[]
</span></span><div class=
"tsd-comment tsd-typography"><p>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.
</p>
48 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"IPool.html#Response">Response
</a><span class=
"tsd-signature-symbol">></span></h4></li></ul></li></ul></div><div class=
"tsd-comment tsd-typography"><h4>Returns
</h4><p>Promise that will be fulfilled when the task is completed.
</p>
49 </div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/a2568a2/src/pools/pool.ts#L282">src/pools/pool.ts:
282</a></li></ul></aside></section><section class=
"tsd-panel tsd-member"><a id=
"hasTaskFunction" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>has
<wbr/>Task
<wbr/>Function
</span><a href=
"#hasTaskFunction" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">has
<wbr/>Task
<wbr/>Function
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">name
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">boolean
</span><span class=
"tsd-signature-symbol">)
</span></div><div class=
"tsd-comment tsd-typography"><p>Whether the specified task function exists in this pool.
</p>
50 </div><div class=
"tsd-type-declaration"><h4>Type declaration
</h4><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures"><li class=
"tsd-signature" id=
"hasTaskFunction.__type-8.__type-9"><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">name
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">boolean
</span></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">name
</span>:
<span class=
"tsd-signature-type">string
</span></span><div class=
"tsd-comment tsd-typography"><p>The name of the task function.
</p>
51 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">boolean
</span></h4></li></ul></li></ul></div><div class=
"tsd-comment tsd-typography"><h4>Returns
</h4><p><code>true
</code> if the task function exists,
<code>false
</code> otherwise.
</p>
52 </div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/a2568a2/src/pools/pool.ts#L301">src/pools/pool.ts:
301</a></li></ul></aside></section><section class=
"tsd-panel tsd-member"><a id=
"info" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>info
</span><a href=
"#info" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">info
</span><span class=
"tsd-signature-symbol">:
</span> <a href=
"PoolInfo.html" class=
"tsd-signature-type tsd-kind-interface">PoolInfo
</a></div><div class=
"tsd-comment tsd-typography"><p>Pool information.
</p>
53 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/a2568a2/src/pools/pool.ts#L251">src/pools/pool.ts:
251</a></li></ul></aside></section><section class=
"tsd-panel tsd-member"><a id=
"listTaskFunctionNames" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>list
<wbr/>Task
<wbr/>Function
<wbr/>Names
</span><a href=
"#listTaskFunctionNames" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">list
<wbr/>Task
<wbr/>Function
<wbr/>Names
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">string
</span><span class=
"tsd-signature-symbol">[]
</span><span class=
"tsd-signature-symbol">)
</span></div><div class=
"tsd-comment tsd-typography"><p>Lists the names of task function available in this pool.
</p>
54 </div><div class=
"tsd-type-declaration"><h4>Type declaration
</h4><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures"><li class=
"tsd-signature" id=
"listTaskFunctionNames.__type-10.__type-11"><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">string
</span><span class=
"tsd-signature-symbol">[]
</span></li><li class=
"tsd-description"><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">string
</span><span class=
"tsd-signature-symbol">[]
</span></h4></li></ul></li></ul></div><div class=
"tsd-comment tsd-typography"><h4>Returns
</h4><p>The names of task function available in this pool.
</p>
55 </div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/a2568a2/src/pools/pool.ts#L328">src/pools/pool.ts:
328</a></li></ul></aside></section><section class=
"tsd-panel tsd-member"><a id=
"removeTaskFunction" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>remove
<wbr/>Task
<wbr/>Function
</span><a href=
"#removeTaskFunction" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">remove
<wbr/>Task
<wbr/>Function
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">name
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">boolean
</span><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol">)
</span></div><div class=
"tsd-comment tsd-typography"><p>Removes a task function from this pool.
</p>
56 </div><div class=
"tsd-type-declaration"><h4>Type declaration
</h4><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures"><li class=
"tsd-signature" id=
"removeTaskFunction.__type-12.__type-13"><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">name
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">boolean
</span><span class=
"tsd-signature-symbol">></span></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">name
</span>:
<span class=
"tsd-signature-type">string
</span></span><div class=
"tsd-comment tsd-typography"><p>The name of the task function.
</p>
57 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">boolean
</span><span class=
"tsd-signature-symbol">></span></h4></li></ul></li></ul></div><div class=
"tsd-comment tsd-typography"><h4>Returns
</h4><p><code>true
</code> if the task function was removed,
<code>false
</code> otherwise.
</p>
58 </div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/a2568a2/src/pools/pool.ts#L322">src/pools/pool.ts:
322</a></li></ul></aside></section><section class=
"tsd-panel tsd-member"><a id=
"setDefaultTaskFunction" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>set
<wbr/>Default
<wbr/>Task
<wbr/>Function
</span><a href=
"#setDefaultTaskFunction" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">set
<wbr/>Default
<wbr/>Task
<wbr/>Function
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">name
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">boolean
</span><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol">)
</span></div><div class=
"tsd-comment tsd-typography"><p>Sets the default task function in this pool.
</p>
59 </div><div class=
"tsd-type-declaration"><h4>Type declaration
</h4><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures"><li class=
"tsd-signature" id=
"setDefaultTaskFunction.__type-14.__type-15"><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">name
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">boolean
</span><span class=
"tsd-signature-symbol">></span></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">name
</span>:
<span class=
"tsd-signature-type">string
</span></span><div class=
"tsd-comment tsd-typography"><p>The name of the task function.
</p>
60 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">boolean
</span><span class=
"tsd-signature-symbol">></span></h4></li></ul></li></ul></div><div class=
"tsd-comment tsd-typography"><h4>Returns
</h4><p><code>true
</code> if the default task function was set,
<code>false
</code> otherwise.
</p>
61 </div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/a2568a2/src/pools/pool.ts#L335">src/pools/pool.ts:
335</a></li></ul></aside></section><section class=
"tsd-panel tsd-member"><a id=
"setTasksQueueOptions" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>set
<wbr/>Tasks
<wbr/>Queue
<wbr/>Options
</span><a href=
"#setTasksQueueOptions" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">set
<wbr/>Tasks
<wbr/>Queue
<wbr/>Options
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">tasksQueueOptions
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">void
</span><span class=
"tsd-signature-symbol">)
</span></div><div class=
"tsd-comment tsd-typography"><p>Sets the worker node tasks queue options in this pool.
</p>
62 </div><div class=
"tsd-type-declaration"><h4>Type declaration
</h4><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures"><li class=
"tsd-signature" id=
"setTasksQueueOptions.__type-16.__type-17"><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">tasksQueueOptions
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">tasksQueueOptions
</span>:
<a href=
"TasksQueueOptions.html" class=
"tsd-signature-type tsd-kind-interface">TasksQueueOptions
</a></span><div class=
"tsd-comment tsd-typography"><p>The worker node tasks queue options.
</p>
63 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4></li></ul></li></ul></div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/a2568a2/src/pools/pool.ts#L369">src/pools/pool.ts:
369</a></li></ul></aside></section><section class=
"tsd-panel tsd-member"><a id=
"setWorkerChoiceStrategy" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>set
<wbr/>Worker
<wbr/>Choice
<wbr/>Strategy
</span><a href=
"#setWorkerChoiceStrategy" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">set
<wbr/>Worker
<wbr/>Choice
<wbr/>Strategy
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerChoiceStrategy
</span>,
<span class=
"tsd-kind-parameter">workerChoiceStrategyOptions
</span><span class=
"tsd-signature-symbol">?
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">void
</span><span class=
"tsd-signature-symbol">)
</span></div><div class=
"tsd-comment tsd-typography"><p>Sets the worker choice strategy in this pool.
</p>
64 </div><div class=
"tsd-type-declaration"><h4>Type declaration
</h4><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures"><li class=
"tsd-signature" id=
"setWorkerChoiceStrategy.__type-18.__type-19"><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerChoiceStrategy
</span>,
<span class=
"tsd-kind-parameter">workerChoiceStrategyOptions
</span><span class=
"tsd-signature-symbol">?
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerChoiceStrategy
</span>:
<span class=
"tsd-signature-type">"ROUND_ROBIN
"</span><span class=
"tsd-signature-symbol"> |
</span><span class=
"tsd-signature-type">"LEAST_USED
"</span><span class=
"tsd-signature-symbol"> |
</span><span class=
"tsd-signature-type">"LEAST_BUSY
"</span><span class=
"tsd-signature-symbol"> |
</span><span class=
"tsd-signature-type">"LEAST_ELU
"</span><span class=
"tsd-signature-symbol"> |
</span><span class=
"tsd-signature-type">"FAIR_SHARE
"</span><span class=
"tsd-signature-symbol"> |
</span><span class=
"tsd-signature-type">"WEIGHTED_ROUND_ROBIN
"</span><span class=
"tsd-signature-symbol"> |
</span><span class=
"tsd-signature-type">"INTERLEAVED_WEIGHTED_ROUND_ROBIN
"</span></span><div class=
"tsd-comment tsd-typography"><p>The worker choice strategy.
</p>
65 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">workerChoiceStrategyOptions
</span>:
<a href=
"WorkerChoiceStrategyOptions.html" class=
"tsd-signature-type tsd-kind-interface">WorkerChoiceStrategyOptions
</a></span><div class=
"tsd-comment tsd-typography"><p>The worker choice strategy options.
</p>
66 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4></li></ul></li></ul></div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/a2568a2/src/pools/pool.ts#L342">src/pools/pool.ts:
342</a></li></ul></aside></section><section class=
"tsd-panel tsd-member"><a id=
"setWorkerChoiceStrategyOptions" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>set
<wbr/>Worker
<wbr/>Choice
<wbr/>Strategy
<wbr/>Options
</span><a href=
"#setWorkerChoiceStrategyOptions" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">set
<wbr/>Worker
<wbr/>Choice
<wbr/>Strategy
<wbr/>Options
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerChoiceStrategyOptions
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">void
</span><span class=
"tsd-signature-symbol">)
</span></div><div class=
"tsd-comment tsd-typography"><p>Sets the worker choice strategy options in this pool.
</p>
67 </div><div class=
"tsd-type-declaration"><h4>Type declaration
</h4><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures"><li class=
"tsd-signature" id=
"setWorkerChoiceStrategyOptions.__type-20.__type-21"><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerChoiceStrategyOptions
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerChoiceStrategyOptions
</span>:
<a href=
"WorkerChoiceStrategyOptions.html" class=
"tsd-signature-type tsd-kind-interface">WorkerChoiceStrategyOptions
</a></span><div class=
"tsd-comment tsd-typography"><p>The worker choice strategy options.
</p>
68 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4></li></ul></li></ul></div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/a2568a2/src/pools/pool.ts#L351">src/pools/pool.ts:
351</a></li></ul></aside></section><section class=
"tsd-panel tsd-member"><a id=
"start" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>start
</span><a href=
"#start" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">start
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">void
</span><span class=
"tsd-signature-symbol">)
</span></div><div class=
"tsd-comment tsd-typography"><p>Starts the minimum number of workers in this pool.
</p>
69 </div><div class=
"tsd-type-declaration"><h4>Type declaration
</h4><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures"><li class=
"tsd-signature" id=
"start.__type-22.__type-23"><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span></li><li class=
"tsd-description"><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4></li></ul></li></ul></div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/a2568a2/src/pools/pool.ts#L290">src/pools/pool.ts:
290</a></li></ul></aside></section><section class=
"tsd-panel tsd-member"><a id=
"workerNodes" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <code class=
"tsd-tag ts-flagInternal">Internal
</code> <span>worker
<wbr/>Nodes
</span><a href=
"#workerNodes" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">worker
<wbr/>Nodes
</span><span class=
"tsd-signature-symbol">:
</span> <a href=
"IWorkerNode.html" class=
"tsd-signature-type tsd-kind-interface">IWorkerNode
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"IPool.html#Worker">Worker
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"IPool.html#Data">Data
</a><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol">[]
</span></div><div class=
"tsd-comment tsd-typography"><p>Pool worker nodes.
</p>
70 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/a2568a2/src/pools/pool.ts#L257">src/pools/pool.ts:
257</a></li></ul></aside></section></section></div><div class=
"col-sidebar"><div class=
"page-menu"><div class=
"tsd-navigation settings"><details class=
"tsd-index-accordion"><summary class=
"tsd-accordion-summary"><h3><svg width=
"20" height=
"20" viewBox=
"0 0 24 24" fill=
"none"><use href=
"../assets/icons.svg#icon-chevronDown"></use></svg>Settings
</h3></summary><div class=
"tsd-accordion-details"><div class=
"tsd-filter-visibility"><h4 class=
"uppercase">Member Visibility
</h4><form><ul id=
"tsd-filter-options"><li class=
"tsd-filter-item"><label class=
"tsd-filter-input"><input type=
"checkbox" id=
"tsd-filter-protected" name=
"protected"/><svg width=
"32" height=
"32" viewBox=
"0 0 32 32" aria-hidden=
"true"><rect class=
"tsd-checkbox-background" width=
"30" height=
"30" x=
"1" y=
"1" rx=
"6" fill=
"none"></rect><path class=
"tsd-checkbox-checkmark" d=
"M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke=
"none" stroke-width=
"3.5" stroke-linejoin=
"round" fill=
"none"></path></svg><span>Protected
</span></label></li><li class=
"tsd-filter-item"><label class=
"tsd-filter-input"><input type=
"checkbox" id=
"tsd-filter-private" name=
"private"/><svg width=
"32" height=
"32" viewBox=
"0 0 32 32" aria-hidden=
"true"><rect class=
"tsd-checkbox-background" width=
"30" height=
"30" x=
"1" y=
"1" rx=
"6" fill=
"none"></rect><path class=
"tsd-checkbox-checkmark" d=
"M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke=
"none" stroke-width=
"3.5" stroke-linejoin=
"round" fill=
"none"></path></svg><span>Private
</span></label></li><li class=
"tsd-filter-item"><label class=
"tsd-filter-input"><input type=
"checkbox" id=
"tsd-filter-inherited" name=
"inherited" checked
/><svg width=
"32" height=
"32" viewBox=
"0 0 32 32" aria-hidden=
"true"><rect class=
"tsd-checkbox-background" width=
"30" height=
"30" x=
"1" y=
"1" rx=
"6" fill=
"none"></rect><path class=
"tsd-checkbox-checkmark" d=
"M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke=
"none" stroke-width=
"3.5" stroke-linejoin=
"round" fill=
"none"></path></svg><span>Inherited
</span></label></li><li class=
"tsd-filter-item"><label class=
"tsd-filter-input"><input type=
"checkbox" id=
"tsd-filter-external" name=
"external"/><svg width=
"32" height=
"32" viewBox=
"0 0 32 32" aria-hidden=
"true"><rect class=
"tsd-checkbox-background" width=
"30" height=
"30" x=
"1" y=
"1" rx=
"6" fill=
"none"></rect><path class=
"tsd-checkbox-checkmark" d=
"M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke=
"none" stroke-width=
"3.5" stroke-linejoin=
"round" fill=
"none"></path></svg><span>External
</span></label></li></ul></form></div><div class=
"tsd-theme-toggle"><h4 class=
"uppercase">Theme
</h4><select id=
"tsd-theme"><option value=
"os">OS
</option><option value=
"light">Light
</option><option value=
"dark">Dark
</option></select></div></div></details></div><details open
class=
"tsd-index-accordion tsd-page-navigation"><summary class=
"tsd-accordion-summary"><h3><svg width=
"20" height=
"20" viewBox=
"0 0 24 24" fill=
"none"><use href=
"../assets/icons.svg#icon-chevronDown"></use></svg>On This Page
</h3></summary><div class=
"tsd-accordion-details"><a href=
"#addTaskFunction" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>add
<wbr/>Task
<wbr/>Function
</span></a><a href=
"#destroy" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>destroy
</span></a><a href=
"#emitter" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>emitter
</span></a><a href=
"#enableTasksQueue" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>enable
<wbr/>Tasks
<wbr/>Queue
</span></a><a href=
"#execute" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>execute
</span></a><a href=
"#hasTaskFunction" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>has
<wbr/>Task
<wbr/>Function
</span></a><a href=
"#info" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>info
</span></a><a href=
"#listTaskFunctionNames" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>list
<wbr/>Task
<wbr/>Function
<wbr/>Names
</span></a><a href=
"#removeTaskFunction" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>remove
<wbr/>Task
<wbr/>Function
</span></a><a href=
"#setDefaultTaskFunction" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>set
<wbr/>Default
<wbr/>Task
<wbr/>Function
</span></a><a href=
"#setTasksQueueOptions" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>set
<wbr/>Tasks
<wbr/>Queue
<wbr/>Options
</span></a><a href=
"#setWorkerChoiceStrategy" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>set
<wbr/>Worker
<wbr/>Choice
<wbr/>Strategy
</span></a><a href=
"#setWorkerChoiceStrategyOptions" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>set
<wbr/>Worker
<wbr/>Choice
<wbr/>Strategy
<wbr/>Options
</span></a><a href=
"#start" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>start
</span></a><a href=
"#workerNodes" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>worker
<wbr/>Nodes
</span></a></div></details></div><div class=
"site-menu"><nav class=
"tsd-navigation"><a href=
"../index.html"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1"></use></svg><span>poolifier - v3.1
.29</span></a><ul class=
"tsd-small-nested-navigation" id=
"tsd-nav-container" data-base=
".."><li>Loading...
</li></ul></nav></div></div></div><div class=
"tsd-generator"><p>Generated using
<a href=
"https://typedoc.org/" target=
"_blank">TypeDoc
</a></p></div><div class=
"overlay"></div></body></html>
repositories / poolifier.git / blob