-<!doctype html>
-<html class="default no-js">
-<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/css/main.css">
- <script async src="assets/js/search.js" id="search-script"></script>
-</head>
-<body>
-<header>
- <div class="tsd-page-toolbar">
- <div class="container">
- <div class="table-wrap">
- <div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
- <div class="field">
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
- <input id="tsd-search-field" type="text" />
- </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 name="errorhandler" class="tsd-anchor"></a>
- <h3>Error<wbr>Handler</h3>
- <div class="tsd-signature tsd-kind-icon">Error<wbr>Handler<Worker><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">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></div>
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/pioardi/poolifier/blob/36b71cf/src/pools/abstract-pool.ts#L24">src/pools/abstract-pool.ts:24</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Callback invoked if the worker raised an error.</p>
- </div>
- </div>
- <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">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">
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>this: <span class="tsd-signature-type">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 name="exithandler" class="tsd-anchor"></a>
- <h3>Exit<wbr>Handler</h3>
- <div class="tsd-signature tsd-kind-icon">Exit<wbr>Handler<Worker><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">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></div>
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/pioardi/poolifier/blob/36b71cf/src/pools/abstract-pool.ts#L34">src/pools/abstract-pool.ts:34</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Callback invoked when the worker exits successfully.</p>
- </div>
- </div>
- <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">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">
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>this: <span class="tsd-signature-type">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 name="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/pioardi/poolifier/blob/36b71cf/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">
- <p>Kill behavior.</p>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter">
- <a name="onlinehandler" class="tsd-anchor"></a>
- <h3>Online<wbr>Handler</h3>
- <div class="tsd-signature tsd-kind-icon">Online<wbr>Handler<Worker><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Worker</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/pioardi/poolifier/blob/36b71cf/src/pools/abstract-pool.ts#L29">src/pools/abstract-pool.ts:29</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Callback invoked when the worker has started successfully.</p>
- </div>
- </div>
- <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">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">
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>this: <span class="tsd-signature-type">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 name="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"> & </span><span class="tsd-signature-type">Draft</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MessageChannel</span><span class="tsd-signature-symbol">></span></div>
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/pioardi/poolifier/blob/36b71cf/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">
- <p>A thread worker with message channels for communication between main thread and thread worker.</p>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="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/pioardi/poolifier/blob/36b71cf/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">
- <p>Worker choice strategy.</p>
- </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 name="killbehaviors" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagConst">Const</span> 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"><</span><span class="tsd-signature-symbol">{ </span>HARD<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"HARD"</span><span class="tsd-signature-symbol">; </span>SOFT<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"SOFT"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div>
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/pioardi/poolifier/blob/36b71cf/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">
- <p>Enumeration of kill behaviors.</p>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-variable">
- <a name="workerchoicestrategies" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagConst">Const</span> 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"><</span><span class="tsd-signature-symbol">{ </span>LESS_RECENTLY_USED<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"LESS_RECENTLY_USED"</span><span class="tsd-signature-symbol">; </span>ROUND_ROBIN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"ROUND_ROBIN"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div>
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/pioardi/poolifier/blob/36b71cf/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">
- <p>Enumeration of worker choice strategies.</p>
- </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 class="before-current">
- <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>
- </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/js/main.js"></script>
-</body>
-</html>
\ No newline at end of file
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>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"><h2>poolifier - v3.1.29</h2></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="classes/AbstractPool.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Abstract<wbr/>Pool</span></a>
+<a href="classes/AbstractWorker.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Abstract<wbr/>Worker</span></a>
+<a href="classes/CircularArray.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Circular<wbr/>Array</span></a>
+<a href="classes/ClusterWorker.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Cluster<wbr/>Worker</span></a>
+<a href="classes/Deque.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Deque</span></a>
+<a href="classes/DynamicClusterPool.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Dynamic<wbr/>Cluster<wbr/>Pool</span></a>
+<a href="classes/DynamicThreadPool.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Dynamic<wbr/>Thread<wbr/>Pool</span></a>
+<a href="classes/FixedClusterPool.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Fixed<wbr/>Cluster<wbr/>Pool</span></a>
+<a href="classes/FixedThreadPool.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Fixed<wbr/>Thread<wbr/>Pool</span></a>
+<a href="classes/ThreadWorker.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Thread<wbr/>Worker</span></a>
+<a href="classes/WorkerChoiceStrategyContext.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Context</span></a>
+</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Interfaces</h3><div class="tsd-index-list"><a href="interfaces/EventLoopUtilizationMeasurementStatistics.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Event<wbr/>Loop<wbr/>Utilization<wbr/>Measurement<wbr/>Statistics</span></a>
+<a href="interfaces/ILinkedListNode.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>ILinked<wbr/>List<wbr/>Node</span></a>
+<a href="interfaces/IPool.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>IPool</span></a>
+<a href="interfaces/IWorker.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>IWorker</span></a>
+<a href="interfaces/IWorkerChoiceStrategy.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>IWorker<wbr/>Choice<wbr/>Strategy</span></a>
+<a href="interfaces/IWorkerNode.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>IWorker<wbr/>Node</span></a>
+<a href="interfaces/MeasurementOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Measurement<wbr/>Options</span></a>
+<a href="interfaces/MeasurementStatistics.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Measurement<wbr/>Statistics</span></a>
+<a href="interfaces/MeasurementStatisticsRequirements.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Measurement<wbr/>Statistics<wbr/>Requirements</span></a>
+<a href="interfaces/MessageValue.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Message<wbr/>Value</span></a>
+<a href="interfaces/PoolInfo.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Pool<wbr/>Info</span></a>
+<a href="interfaces/PoolOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Pool<wbr/>Options</span></a>
+<a href="interfaces/PromiseResponseWrapper.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Promise<wbr/>Response<wbr/>Wrapper</span></a>
+<a href="interfaces/StrategyData.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Strategy<wbr/>Data</span></a>
+<a href="interfaces/StrategyPolicy.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Strategy<wbr/>Policy</span></a>
+<a href="interfaces/Task.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Task</span></a>
+<a href="interfaces/TaskFunctionOperationResult.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Task<wbr/>Function<wbr/>Operation<wbr/>Result</span></a>
+<a href="interfaces/TaskPerformance.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Task<wbr/>Performance</span></a>
+<a href="interfaces/TaskStatistics.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Task<wbr/>Statistics</span></a>
+<a href="interfaces/TaskStatisticsRequirements.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Task<wbr/>Statistics<wbr/>Requirements</span></a>
+<a href="interfaces/TasksQueueOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Tasks<wbr/>Queue<wbr/>Options</span></a>
+<a href="interfaces/WorkerChoiceStrategyOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Options</span></a>
+<a href="interfaces/WorkerError.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Worker<wbr/>Error</span></a>
+<a href="interfaces/WorkerInfo.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Worker<wbr/>Info</span></a>
+<a href="interfaces/WorkerNodeEventDetail.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Worker<wbr/>Node<wbr/>Event<wbr/>Detail</span></a>
+<a href="interfaces/WorkerNodeOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Worker<wbr/>Node<wbr/>Options</span></a>
+<a href="interfaces/WorkerOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Worker<wbr/>Options</span></a>
+<a href="interfaces/WorkerStatistics.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Worker<wbr/>Statistics</span></a>
+<a href="interfaces/WorkerUsage.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Worker<wbr/>Usage</span></a>
+</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Type Aliases</h3><div class="tsd-index-list"><a href="types/ClusterPoolOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2097152"></use></svg><span>Cluster<wbr/>Pool<wbr/>Options</span></a>
+<a href="types/ErrorHandler.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2097152"></use></svg><span>Error<wbr/>Handler</span></a>
+<a href="types/EventHandler.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2097152"></use></svg><span>Event<wbr/>Handler</span></a>
+<a href="types/ExitHandler.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2097152"></use></svg><span>Exit<wbr/>Handler</span></a>
+<a href="types/KillBehavior.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2097152"></use></svg><span>Kill<wbr/>Behavior</span></a>
+<a href="types/KillHandler.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2097152"></use></svg><span>Kill<wbr/>Handler</span></a>
+<a href="types/Measurement.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2097152"></use></svg><span>Measurement</span></a>
+<a href="types/MessageHandler.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2097152"></use></svg><span>Message<wbr/>Handler</span></a>
+<a href="types/OnlineHandler.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2097152"></use></svg><span>Online<wbr/>Handler</span></a>
+<a href="types/PoolEvent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2097152"></use></svg><span>Pool<wbr/>Event</span></a>
+<a href="types/PoolType.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2097152"></use></svg><span>Pool<wbr/>Type</span></a>
+<a href="types/TaskAsyncFunction.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2097152"></use></svg><span>Task<wbr/>Async<wbr/>Function</span></a>
+<a href="types/TaskFunction.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2097152"></use></svg><span>Task<wbr/>Function</span></a>
+<a href="types/TaskFunctions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2097152"></use></svg><span>Task<wbr/>Functions</span></a>
+<a href="types/TaskSyncFunction.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2097152"></use></svg><span>Task<wbr/>Sync<wbr/>Function</span></a>
+<a href="types/ThreadPoolOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2097152"></use></svg><span>Thread<wbr/>Pool<wbr/>Options</span></a>
+<a href="types/WorkerChoiceStrategy.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2097152"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategy</span></a>
+<a href="types/WorkerType.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2097152"></use></svg><span>Worker<wbr/>Type</span></a>
+<a href="types/Writable.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2097152"></use></svg><span>Writable</span></a>
+</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Variables</h3><div class="tsd-index-list"><a href="variables/KillBehaviors.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-32"></use></svg><span>Kill<wbr/>Behaviors</span></a>
+<a href="variables/Measurements.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-32"></use></svg><span>Measurements</span></a>
+<a href="variables/PoolEvents.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-32"></use></svg><span>Pool<wbr/>Events</span></a>
+<a href="variables/PoolTypes.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-32"></use></svg><span>Pool<wbr/>Types</span></a>
+<a href="variables/WorkerChoiceStrategies.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-32"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategies</span></a>
+<a href="variables/WorkerTypes.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-32"></use></svg><span>Worker<wbr/>Types</span></a>
+</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Functions</h3><div class="tsd-index-list"><a href="functions/availableParallelism.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-64"></use></svg><span>available<wbr/>Parallelism</span></a>
+</div></section></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></div><div class="site-menu"><nav class="tsd-navigation"><a href="index.html" class="current"><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>
\ No newline at end of file
repositories / poolifier.git / blobdiff