docs/index.html

   1 <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>poolifier</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 async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>poolifier</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/AbstractWorker.html" class="tsd-kind-icon">Abstract<wbr/>Worker</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/ClusterWorker.html" class="tsd-kind-icon">Cluster<wbr/>Worker</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/DynamicClusterPool.html" class="tsd-kind-icon">Dynamic<wbr/>Cluster<wbr/>Pool</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/DynamicThreadPool.html" class="tsd-kind-icon">Dynamic<wbr/>Thread<wbr/>Pool</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/FixedClusterPool.html" class="tsd-kind-icon">Fixed<wbr/>Cluster<wbr/>Pool</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/FixedThreadPool.html" class="tsd-kind-icon">Fixed<wbr/>Thread<wbr/>Pool</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/ThreadWorker.html" class="tsd-kind-icon">Thread<wbr/>Worker</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface"><a href="interfaces/ClusterPoolOptions.html" class="tsd-kind-icon">Cluster<wbr/>Pool<wbr/>Options</a></li><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/IPool.html" class="tsd-kind-icon">IPool</a></li><li class="tsd-kind-interface"><a href="interfaces/IWorker.html" class="tsd-kind-icon">IWorker</a></li><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/PoolOptions.html" class="tsd-kind-icon">Pool<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/WorkerOptions.html" class="tsd-kind-icon">Worker<wbr/>Options</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="index.html#ErrorHandler" class="tsd-kind-icon">Error<wbr/>Handler</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="index.html#ExitHandler" class="tsd-kind-icon">Exit<wbr/>Handler</a></li><li class="tsd-kind-type-alias"><a href="index.html#KillBehavior" class="tsd-kind-icon">Kill<wbr/>Behavior</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="index.html#OnlineHandler" class="tsd-kind-icon">Online<wbr/>Handler</a></li><li class="tsd-kind-type-alias"><a href="index.html#ThreadWorkerWithMessageChannel" class="tsd-kind-icon">Thread<wbr/>Worker<wbr/>With<wbr/>Message<wbr/>Channel</a></li><li class="tsd-kind-type-alias"><a href="index.html#WorkerChoiceStrategy" class="tsd-kind-icon">Worker<wbr/>Choice<wbr/>Strategy</a></li></ul></section><section class="tsd-index-section "><h3>Variables</h3><ul class="tsd-index-list"><li class="tsd-kind-variable"><a href="index.html#KillBehaviors" class="tsd-kind-icon">Kill<wbr/>Behaviors</a></li><li class="tsd-kind-variable"><a href="index.html#WorkerChoiceStrategies" class="tsd-kind-icon">Worker<wbr/>Choice<wbr/>Strategies</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a id="ErrorHandler" class="tsd-anchor"></a><h3>Error<wbr/>Handler</h3><div class="tsd-signature tsd-kind-icon">Error<wbr/>Handler<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Worker</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Worker</span>, e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/poolifier/poolifier/blob/0136f64/src/pools/abstract-pool.ts#L23">src/pools/abstract-pool.ts:23</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Worker</h4></li></ul><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Worker</span>, e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
   2 <p>Callback invoked if the worker raised an error.</p>
   3 </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>this: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Worker</span></h5></li><li><h5>e: <span class="tsd-signature-type">Error</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a id="ExitHandler" class="tsd-anchor"></a><h3>Exit<wbr/>Handler</h3><div class="tsd-signature tsd-kind-icon">Exit<wbr/>Handler<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Worker</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Worker</span>, code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/poolifier/poolifier/blob/0136f64/src/pools/abstract-pool.ts#L33">src/pools/abstract-pool.ts:33</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Worker</h4></li></ul><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Worker</span>, code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
   4 <p>Callback invoked when the worker exits successfully.</p>
   5 </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>this: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Worker</span></h5></li><li><h5>code: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="KillBehavior" class="tsd-anchor"></a><h3>Kill<wbr/>Behavior</h3><div class="tsd-signature tsd-kind-icon">Kill<wbr/>Behavior<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-symbol">typeof </span><a href="index.html#KillBehaviors" class="tsd-signature-type" data-tsd-kind="Variable">KillBehaviors</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/poolifier/poolifier/blob/0136f64/src/worker/worker-options.ts#L18">src/worker/worker-options.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
   6 <p>Kill behavior.</p>
   7 </div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a id="OnlineHandler" class="tsd-anchor"></a><h3>Online<wbr/>Handler</h3><div class="tsd-signature tsd-kind-icon">Online<wbr/>Handler<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Worker</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Worker</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/poolifier/poolifier/blob/0136f64/src/pools/abstract-pool.ts#L28">src/pools/abstract-pool.ts:28</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Worker</h4></li></ul><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Worker</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
   8 <p>Callback invoked when the worker has started successfully.</p>
   9 </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>this: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Worker</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="ThreadWorkerWithMessageChannel" class="tsd-anchor"></a><h3>Thread<wbr/>Worker<wbr/>With<wbr/>Message<wbr/>Channel</h3><div class="tsd-signature tsd-kind-icon">Thread<wbr/>Worker<wbr/>With<wbr/>Message<wbr/>Channel<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Worker</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">Draft</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">MessageChannel</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/poolifier/poolifier/blob/0136f64/src/pools/thread/fixed.ts#L10">src/pools/thread/fixed.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
  10 <p>A thread worker with message channels for communication between main thread and thread worker.</p>
  11 </div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="WorkerChoiceStrategy" class="tsd-anchor"></a><h3>Worker<wbr/>Choice<wbr/>Strategy</h3><div class="tsd-signature tsd-kind-icon">Worker<wbr/>Choice<wbr/>Strategy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-symbol">typeof </span><a href="index.html#WorkerChoiceStrategies" class="tsd-signature-type" data-tsd-kind="Variable">WorkerChoiceStrategies</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/poolifier/poolifier/blob/0136f64/src/pools/selection-strategies.ts#L22">src/pools/selection-strategies.ts:22</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
  12 <p>Worker choice strategy.</p>
  13 </div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Variables</h2><section class="tsd-panel tsd-member tsd-kind-variable"><a id="KillBehaviors" class="tsd-anchor"></a><h3>Kill<wbr/>Behaviors</h3><div class="tsd-signature tsd-kind-icon">Kill<wbr/>Behaviors<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>HARD<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;HARD&quot;</span><span class="tsd-signature-symbol">; </span>SOFT<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;SOFT&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/poolifier/poolifier/blob/0136f64/src/worker/worker-options.ts#L4">src/worker/worker-options.ts:4</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
  14 <p>Enumeration of kill behaviors.</p>
  15 </div></div></section><section class="tsd-panel tsd-member tsd-kind-variable"><a id="WorkerChoiceStrategies" class="tsd-anchor"></a><h3>Worker<wbr/>Choice<wbr/>Strategies</h3><div class="tsd-signature tsd-kind-icon">Worker<wbr/>Choice<wbr/>Strategies<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>LESS_RECENTLY_USED<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;LESS_RECENTLY_USED&quot;</span><span class="tsd-signature-symbol">; </span>ROUND_ROBIN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;ROUND_ROBIN&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/poolifier/poolifier/blob/0136f64/src/pools/selection-strategies.ts#L8">src/pools/selection-strategies.ts:8</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
  16 <p>Enumeration of worker choice strategies.</p>
  17 </div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="index.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/AbstractWorker.html" class="tsd-kind-icon">Abstract<wbr/>Worker</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/ClusterWorker.html" class="tsd-kind-icon">Cluster<wbr/>Worker</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/DynamicClusterPool.html" class="tsd-kind-icon">Dynamic<wbr/>Cluster<wbr/>Pool</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/DynamicThreadPool.html" class="tsd-kind-icon">Dynamic<wbr/>Thread<wbr/>Pool</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/FixedClusterPool.html" class="tsd-kind-icon">Fixed<wbr/>Cluster<wbr/>Pool</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/FixedThreadPool.html" class="tsd-kind-icon">Fixed<wbr/>Thread<wbr/>Pool</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/ThreadWorker.html" class="tsd-kind-icon">Thread<wbr/>Worker</a></li><li class="tsd-kind-interface"><a href="interfaces/ClusterPoolOptions.html" class="tsd-kind-icon">Cluster<wbr/>Pool<wbr/>Options</a></li><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/IPool.html" class="tsd-kind-icon">IPool</a></li><li class="tsd-kind-interface"><a href="interfaces/IWorker.html" class="tsd-kind-icon">IWorker</a></li><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/PoolOptions.html" class="tsd-kind-icon">Pool<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/WorkerOptions.html" class="tsd-kind-icon">Worker<wbr/>Options</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="index.html#ErrorHandler" class="tsd-kind-icon">Error<wbr/>Handler</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="index.html#ExitHandler" class="tsd-kind-icon">Exit<wbr/>Handler</a></li><li class="tsd-kind-type-alias"><a href="index.html#KillBehavior" class="tsd-kind-icon">Kill<wbr/>Behavior</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="index.html#OnlineHandler" class="tsd-kind-icon">Online<wbr/>Handler</a></li><li class="tsd-kind-type-alias"><a href="index.html#ThreadWorkerWithMessageChannel" class="tsd-kind-icon">Thread<wbr/>Worker<wbr/>With<wbr/>Message<wbr/>Channel</a></li><li class="tsd-kind-type-alias"><a href="index.html#WorkerChoiceStrategy" class="tsd-kind-icon">Worker<wbr/>Choice<wbr/>Strategy</a></li><li class="tsd-kind-variable"><a href="index.html#KillBehaviors" class="tsd-kind-icon">Kill<wbr/>Behaviors</a></li><li class="tsd-kind-variable"><a href="index.html#WorkerChoiceStrategies" class="tsd-kind-icon">Worker<wbr/>Choice<wbr/>Strategies</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>