-<!doctype html>
-<html class="default no-js">
-<head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <title>DynamicClusterPool | 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">
- <ul class="tsd-breadcrumb">
- <li>
- <a href="../index.html">poolifier</a>
- </li>
- <li>
- <a href="dynamicclusterpool.html">DynamicClusterPool</a>
- </li>
- </ul>
- <h1>Class DynamicClusterPool<Data, Response></h1>
- </div>
- </div>
-</header>
-<div class="container container-main">
- <div class="row">
- <div class="col-8 col-content">
- <section class="tsd-panel tsd-comment">
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.</p>
- </div>
- <p>This cluster pool creates new workers when the others are busy, up to the maximum number of workers.
- When the maximum number of workers is reached, an event is emitted. If you want to listen to this event, use the pool's <code>emitter</code>.</p>
- <dl class="tsd-comment-tags">
- <dt>author</dt>
- <dd><p><a href="https://github.com/Shinigami92">Christopher Quadflieg</a></p>
- </dd>
- <dt>since</dt>
- <dd><p>2.0.0</p>
- </dd>
- </dl>
- </div>
- </section>
- <section class="tsd-panel tsd-type-parameters">
- <h3>Type parameters</h3>
- <ul class="tsd-type-parameters">
- <li>
- <h4>Data = <span class="tsd-signature-type">unknown</span></h4>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Type of data sent to the worker. This can only be serializable data.</p>
- </div>
- </div>
- </li>
- <li>
- <h4>Response = <span class="tsd-signature-type">unknown</span></h4>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Type of response of execution. This can only be serializable data.</p>
- </div>
- </div>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-hierarchy">
- <h3>Hierarchy</h3>
- <ul class="tsd-hierarchy">
- <li>
- <a href="fixedclusterpool.html" class="tsd-signature-type" data-tsd-kind="Class">FixedClusterPool</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span>
- <ul class="tsd-hierarchy">
- <li>
- <span class="target">DynamicClusterPool</span>
- </li>
- </ul>
- </li>
- </ul>
- </section>
- <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>Constructors</h3>
- <ul class="tsd-index-list">
- <li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="dynamicclusterpool.html#constructor" class="tsd-kind-icon">constructor</a></li>
- </ul>
- </section>
- <section class="tsd-index-section ">
- <h3>Properties</h3>
- <ul class="tsd-index-list">
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="dynamicclusterpool.html#emitter" class="tsd-kind-icon">emitter</a></li>
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="dynamicclusterpool.html#filepath" class="tsd-kind-icon">file<wbr>Path</a></li>
- <li class="tsd-kind-property tsd-parent-kind-class"><a href="dynamicclusterpool.html#max" class="tsd-kind-icon">max</a></li>
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#nextmessageid" class="tsd-kind-icon">next<wbr>Message<wbr>Id</a></li>
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="dynamicclusterpool.html#numberofworkers" class="tsd-kind-icon">number<wbr>OfWorkers</a></li>
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="dynamicclusterpool.html#opts" class="tsd-kind-icon">opts</a></li>
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#promisemap" class="tsd-kind-icon">promise<wbr>Map</a></li>
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="dynamicclusterpool.html#tasks" class="tsd-kind-icon">tasks</a></li>
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#workerchoicestrategycontext" class="tsd-kind-icon">worker<wbr>Choice<wbr>Strategy<wbr>Context</a></li>
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="dynamicclusterpool.html#workers" class="tsd-kind-icon">workers</a></li>
- </ul>
- </section>
- <section class="tsd-index-section ">
- <h3>Accessors</h3>
- <ul class="tsd-index-list">
- <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="dynamicclusterpool.html#dynamic" class="tsd-kind-icon">dynamic</a></li>
- </ul>
- </section>
- <section class="tsd-index-section ">
- <h3>Methods</h3>
- <ul class="tsd-index-list">
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#afterworkersetup" class="tsd-kind-icon">after<wbr>Worker<wbr>Setup</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#chooseworker" class="tsd-kind-icon">choose<wbr>Worker</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#createandsetupworker" class="tsd-kind-icon">create<wbr>And<wbr>Setup<wbr>Worker</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#createworker" class="tsd-kind-icon">create<wbr>Worker</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#decreaseworkerstasks" class="tsd-kind-icon">decrease<wbr>Workers<wbr>Tasks</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="dynamicclusterpool.html#destroy" class="tsd-kind-icon">destroy</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="dynamicclusterpool.html#destroyworker" class="tsd-kind-icon">destroy<wbr>Worker</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="dynamicclusterpool.html#execute" class="tsd-kind-icon">execute</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#increaseworkerstask" class="tsd-kind-icon">increase<wbr>Workers<wbr>Task</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#internalexecute" class="tsd-kind-icon">internal<wbr>Execute</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#ismain" class="tsd-kind-icon">is<wbr>Main</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="dynamicclusterpool.html#registerworkermessagelistener" class="tsd-kind-icon">register<wbr>Worker<wbr>Message<wbr>Listener</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#removeworker" class="tsd-kind-icon">remove<wbr>Worker</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#sendtoworker" class="tsd-kind-icon">send<wbr>ToWorker</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="dynamicclusterpool.html#setworkerchoicestrategy" class="tsd-kind-icon">set<wbr>Worker<wbr>Choice<wbr>Strategy</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#setuphook" class="tsd-kind-icon">setup<wbr>Hook</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#workerlistener" class="tsd-kind-icon">worker<wbr>Listener</a></li>
- </ul>
- </section>
- </div>
- </section>
- </section>
- <section class="tsd-panel-group tsd-member-group ">
- <h2>Constructors</h2>
- <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
- <a name="constructor" class="tsd-anchor"></a>
- <h3>constructor</h3>
- <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
- <li class="tsd-signature tsd-kind-icon">new <wbr>Dynamic<wbr>Cluster<wbr>Pool<Data, Response><span class="tsd-signature-symbol">(</span>min<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, max<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, filePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><a href="../interfaces/clusterpooloptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClusterPoolOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="dynamicclusterpool.html" class="tsd-signature-type" data-tsd-kind="Class">DynamicClusterPool</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#constructor">constructor</a></p>
- <ul>
- <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/cluster/dynamic.ts#L19">src/pools/cluster/dynamic.ts:19</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Constructs a new poolifier dynamic cluster pool.</p>
- </div>
- </div>
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
- <ul class="tsd-type-parameters">
- <li>
- <h4>Data = <span class="tsd-signature-type">unknown</span></h4>
- </li>
- <li>
- <h4>Response = <span class="tsd-signature-type">unknown</span></h4>
- </li>
- </ul>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>min: <span class="tsd-signature-type">number</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>Minimum number of workers which are always active.</p>
- </div>
- </li>
- <li>
- <h5>max: <span class="tsd-signature-type">number</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>Maximum number of workers that can be created by this pool.</p>
- </div>
- </li>
- <li>
- <h5>filePath: <span class="tsd-signature-type">string</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>Path to an implementation of a <code>ClusterWorker</code> file, which can be relative or absolute.</p>
- </div>
- </li>
- <li>
- <h5>opts: <a href="../interfaces/clusterpooloptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClusterPoolOptions</a><span class="tsd-signature-symbol"> = ...</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>Options for this dynamic cluster pool. Default: <code>{}</code></p>
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <a href="dynamicclusterpool.html" class="tsd-signature-type" data-tsd-kind="Class">DynamicClusterPool</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></h4>
- </li>
- </ul>
- </section>
- </section>
- <section class="tsd-panel-group tsd-member-group ">
- <h2>Properties</h2>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a name="emitter" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> emitter</h3>
- <div class="tsd-signature tsd-kind-icon">emitter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PoolEmitter</span></div>
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#emitter">emitter</a></p>
- <ul>
- <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L111">src/pools/abstract-pool.ts:111</a></li>
- </ul>
- </aside>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a name="filepath" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> file<wbr>Path</h3>
- <div class="tsd-signature tsd-kind-icon">file<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#filepath">filePath</a></p>
- </aside>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
- <a name="max" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> max</h3>
- <div class="tsd-signature tsd-kind-icon">max<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
- <aside class="tsd-sources">
- </aside>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a name="nextmessageid" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagProtected">Protected</span> next<wbr>Message<wbr>Id</h3>
- <div class="tsd-signature tsd-kind-icon">next<wbr>Message<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div>
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#nextmessageid">nextMessageId</a></p>
- <ul>
- <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L129">src/pools/abstract-pool.ts:129</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>ID of the next message.</p>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a name="numberofworkers" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> number<wbr>OfWorkers</h3>
- <div class="tsd-signature tsd-kind-icon">number<wbr>OfWorkers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#numberofworkers">numberOfWorkers</a></p>
- </aside>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a name="opts" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> opts</h3>
- <div class="tsd-signature tsd-kind-icon">opts<span class="tsd-signature-symbol">:</span> <a href="../interfaces/clusterpooloptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClusterPoolOptions</a><span class="tsd-signature-symbol"> = ...</span></div>
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#opts">opts</a></p>
- </aside>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a name="promisemap" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagProtected">Protected</span> promise<wbr>Map</h3>
- <div class="tsd-signature tsd-kind-icon">promise<wbr>Map<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">PromiseWorkerResponseWrapper</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Worker</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div>
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#promisemap">promiseMap</a></p>
- <ul>
- <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L121">src/pools/abstract-pool.ts:121</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>The promise map.</p>
- </div>
- <ul>
- <li><code>key</code>: This is the message ID of each submitted task.</li>
- <li><code>value</code>: An object that contains the worker, the resolve function and the reject function.</li>
- </ul>
- <p>When we receive a message from the worker we get a map entry and resolve/reject the promise based on the message.</p>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a name="tasks" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> tasks</h3>
- <div class="tsd-signature tsd-kind-icon">tasks<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Worker</span><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></div>
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#tasks">tasks</a></p>
- <ul>
- <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L108">src/pools/abstract-pool.ts:108</a></li>
- </ul>
- </aside>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a name="workerchoicestrategycontext" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagProtected">Protected</span> worker<wbr>Choice<wbr>Strategy<wbr>Context</h3>
- <div class="tsd-signature tsd-kind-icon">worker<wbr>Choice<wbr>Strategy<wbr>Context<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">WorkerChoiceStrategyContext</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Worker</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></div>
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#workerchoicestrategycontext">workerChoiceStrategyContext</a></p>
- <ul>
- <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L136">src/pools/abstract-pool.ts:136</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Worker choice strategy instance implementing the worker choice algorithm.</p>
- </div>
- <p>Default to a strategy implementing a round robin algorithm.</p>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a name="workers" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> workers</h3>
- <div class="tsd-signature tsd-kind-icon">workers<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></div>
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#workers">workers</a></p>
- <ul>
- <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L105">src/pools/abstract-pool.ts:105</a></li>
- </ul>
- </aside>
- </section>
- </section>
- <section class="tsd-panel-group tsd-member-group ">
- <h2>Accessors</h2>
- <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
- <a name="dynamic" class="tsd-anchor"></a>
- <h3>dynamic</h3>
- <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
- <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> dynamic<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/cluster/dynamic.ts#L38">src/pools/cluster/dynamic.ts:38</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <dl class="tsd-comment-tags">
- <dt>inheritdoc</dt>
- <dd></dd>
- </dl>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
- </li>
- </ul>
- </section>
- </section>
- <section class="tsd-panel-group tsd-member-group ">
- <h2>Methods</h2>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a name="afterworkersetup" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagProtected">Protected</span> after<wbr>Worker<wbr>Setup</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <li class="tsd-signature tsd-kind-icon">after<wbr>Worker<wbr>Setup<span class="tsd-signature-symbol">(</span>worker<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">
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#afterworkersetup">afterWorkerSetup</a></p>
- <ul>
- <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/cluster/fixed.ts#L83">src/pools/cluster/fixed.ts:83</a></li>
- </ul>
- </aside>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>worker: <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>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a name="chooseworker" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagProtected">Protected</span> choose<wbr>Worker</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <li class="tsd-signature tsd-kind-icon">choose<wbr>Worker<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Worker</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#chooseworker">chooseWorker</a></p>
- <ul>
- <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L313">src/pools/abstract-pool.ts:313</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Choose a worker for the next task.</p>
- </div>
- <p>The default implementation uses a round robin algorithm to distribute the load.</p>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Worker</span></h4>
- <p>Worker.</p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a name="createandsetupworker" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagProtected">Protected</span> create<wbr>And<wbr>Setup<wbr>Worker</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <li class="tsd-signature tsd-kind-icon">create<wbr>And<wbr>Setup<wbr>Worker<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Worker</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#createandsetupworker">createAndSetupWorker</a></p>
- <ul>
- <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L366">src/pools/abstract-pool.ts:366</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Creates a new worker for this pool and sets it up completely.</p>
- </div>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Worker</span></h4>
- <p>New, completely set up worker.</p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a name="createworker" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagProtected">Protected</span> create<wbr>Worker</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <li class="tsd-signature tsd-kind-icon">create<wbr>Worker<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Worker</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#createworker">createWorker</a></p>
- <ul>
- <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/cluster/fixed.ts#L79">src/pools/cluster/fixed.ts:79</a></li>
- </ul>
- </aside>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Worker</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a name="decreaseworkerstasks" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagProtected">Protected</span> decrease<wbr>Workers<wbr>Tasks</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <li class="tsd-signature tsd-kind-icon">decrease<wbr>Workers<wbr>Tasks<span class="tsd-signature-symbol">(</span>worker<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">
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#decreaseworkerstasks">decreaseWorkersTasks</a></p>
- <ul>
- <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L275">src/pools/abstract-pool.ts:275</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Decrease the number of tasks that the given workers has done.</p>
- </div>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>worker: <span class="tsd-signature-type">Worker</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>Worker whose tasks are decreased.</p>
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="destroy" class="tsd-anchor"></a>
- <h3>destroy</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <li class="tsd-signature tsd-kind-icon">destroy<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>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#destroy">destroy</a></p>
- <ul>
- <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L237">src/pools/abstract-pool.ts:237</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <dl class="tsd-comment-tags">
- <dt>inheritdoc</dt>
- <dd></dd>
- </dl>
- </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">void</span><span class="tsd-signature-symbol">></span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="destroyworker" class="tsd-anchor"></a>
- <h3>destroy<wbr>Worker</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <li class="tsd-signature tsd-kind-icon">destroy<wbr>Worker<span class="tsd-signature-symbol">(</span>worker<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">
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#destroyworker">destroyWorker</a></p>
- <ul>
- <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/cluster/fixed.ts#L62">src/pools/cluster/fixed.ts:62</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <dl class="tsd-comment-tags">
- <dt>inheritdoc</dt>
- <dd></dd>
- </dl>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>worker: <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>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="execute" class="tsd-anchor"></a>
- <h3>execute</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <li class="tsd-signature tsd-kind-icon">execute<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Data</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">Response</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#execute">execute</a></p>
- <ul>
- <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L226">src/pools/abstract-pool.ts:226</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <dl class="tsd-comment-tags">
- <dt>inheritdoc</dt>
- <dd></dd>
- </dl>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>data: <span class="tsd-signature-type">Data</span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a name="increaseworkerstask" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagProtected">Protected</span> increase<wbr>Workers<wbr>Task</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <li class="tsd-signature tsd-kind-icon">increase<wbr>Workers<wbr>Task<span class="tsd-signature-symbol">(</span>worker<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">
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#increaseworkerstask">increaseWorkersTask</a></p>
- <ul>
- <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L266">src/pools/abstract-pool.ts:266</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Increase the number of tasks that the given workers has done.</p>
- </div>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>worker: <span class="tsd-signature-type">Worker</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>Worker whose tasks are increased.</p>
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a name="internalexecute" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagProtected">Protected</span> internal<wbr>Execute</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <li class="tsd-signature tsd-kind-icon">internal<wbr>Execute<span class="tsd-signature-symbol">(</span>worker<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Worker</span>, messageId<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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#internalexecute">internalExecute</a></p>
- <ul>
- <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L338">src/pools/abstract-pool.ts:338</a></li>
- </ul>
- </aside>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>worker: <span class="tsd-signature-type">Worker</span></h5>
- </li>
- <li>
- <h5>messageId: <span class="tsd-signature-type">number</span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a name="ismain" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagProtected">Protected</span> is<wbr>Main</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <li class="tsd-signature tsd-kind-icon">is<wbr>Main<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#ismain">isMain</a></p>
- <ul>
- <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/cluster/fixed.ts#L57">src/pools/cluster/fixed.ts:57</a></li>
- </ul>
- </aside>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
- <a name="registerworkermessagelistener" class="tsd-anchor"></a>
- <h3>register<wbr>Worker<wbr>Message<wbr>Listener</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
- <li class="tsd-signature tsd-kind-icon">register<wbr>Worker<wbr>Message<wbr>Listener<Message><span class="tsd-signature-symbol">(</span>worker<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Worker</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</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><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#registerworkermessagelistener">registerWorkerMessageListener</a></p>
- <ul>
- <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/cluster/fixed.ts#L72">src/pools/cluster/fixed.ts:72</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <dl class="tsd-comment-tags">
- <dt>inheritdoc</dt>
- <dd></dd>
- </dl>
- </div>
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
- <ul class="tsd-type-parameters">
- <li>
- <h4>Message</h4>
- </li>
- </ul>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>worker: <span class="tsd-signature-type">Worker</span></h5>
- </li>
- <li>
- <h5>listener: <span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</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></h5>
- <ul class="tsd-parameters">
- <li class="tsd-parameter-signature">
- <ul class="tsd-signatures tsd-kind-type-literal">
- <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</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>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>message: <span class="tsd-signature-type">MessageValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a name="removeworker" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagProtected">Protected</span> remove<wbr>Worker</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <li class="tsd-signature tsd-kind-icon">remove<wbr>Worker<span class="tsd-signature-symbol">(</span>worker<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">
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#removeworker">removeWorker</a></p>
- <ul>
- <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L299">src/pools/abstract-pool.ts:299</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Removes the given worker from the pool.</p>
- </div>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>worker: <span class="tsd-signature-type">Worker</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>Worker that will be removed.</p>
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a name="sendtoworker" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagProtected">Protected</span> send<wbr>ToWorker</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <li class="tsd-signature tsd-kind-icon">send<wbr>ToWorker<span class="tsd-signature-symbol">(</span>worker<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Worker</span>, message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</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>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#sendtoworker">sendToWorker</a></p>
- <ul>
- <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/cluster/fixed.ts#L67">src/pools/cluster/fixed.ts:67</a></li>
- </ul>
- </aside>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>worker: <span class="tsd-signature-type">Worker</span></h5>
- </li>
- <li>
- <h5>message: <span class="tsd-signature-type">MessageValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="setworkerchoicestrategy" class="tsd-anchor"></a>
- <h3>set<wbr>Worker<wbr>Choice<wbr>Strategy</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Worker<wbr>Choice<wbr>Strategy<span class="tsd-signature-symbol">(</span>workerChoiceStrategy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"ROUND_ROBIN"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"LESS_RECENTLY_USED"</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">
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#setworkerchoicestrategy">setWorkerChoiceStrategy</a></p>
- <ul>
- <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L216">src/pools/abstract-pool.ts:216</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <dl class="tsd-comment-tags">
- <dt>inheritdoc</dt>
- <dd></dd>
- </dl>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>workerChoiceStrategy: <span class="tsd-signature-type">"ROUND_ROBIN"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"LESS_RECENTLY_USED"</span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a name="setuphook" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagProtected">Protected</span> setup<wbr>Hook</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <li class="tsd-signature tsd-kind-icon">setup<wbr>Hook<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>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#setuphook">setupHook</a></p>
- <ul>
- <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/cluster/fixed.ts#L51">src/pools/cluster/fixed.ts:51</a></li>
- </ul>
- </aside>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a name="workerlistener" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagProtected">Protected</span> worker<wbr>Listener</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <li class="tsd-signature tsd-kind-icon">worker<wbr>Listener<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</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>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#workerlistener">workerListener</a></p>
- <ul>
- <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L389">src/pools/abstract-pool.ts:389</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>This function is the listener registered for each worker.</p>
- </div>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</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></h4>
- <p>The listener function to execute when a message is sent from a worker.</p>
- <ul class="tsd-parameters">
- <li class="tsd-parameter-signature">
- <ul class="tsd-signatures tsd-kind-type-literal">
- <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</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>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>message: <span class="tsd-signature-type">MessageValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </section>
- </section>
- </div>
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
- <nav class="tsd-navigation primary">
- <ul>
- <li class=" ">
- <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="abstractworker.html" class="tsd-kind-icon">Abstract<wbr>Worker</a>
- </li>
- <li class=" tsd-kind-class tsd-has-type-parameter">
- <a href="clusterworker.html" class="tsd-kind-icon">Cluster<wbr>Worker</a>
- </li>
- </ul>
- <ul class="current">
- <li class="current tsd-kind-class tsd-has-type-parameter">
- <a href="dynamicclusterpool.html" class="tsd-kind-icon">Dynamic<wbr>Cluster<wbr>Pool</a>
- <ul>
- <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
- <a href="dynamicclusterpool.html#constructor" class="tsd-kind-icon">constructor</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a href="dynamicclusterpool.html#emitter" class="tsd-kind-icon">emitter</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a href="dynamicclusterpool.html#filepath" class="tsd-kind-icon">file<wbr>Path</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-class">
- <a href="dynamicclusterpool.html#max" class="tsd-kind-icon">max</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a href="dynamicclusterpool.html#nextmessageid" class="tsd-kind-icon">next<wbr>Message<wbr>Id</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a href="dynamicclusterpool.html#numberofworkers" class="tsd-kind-icon">number<wbr>OfWorkers</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a href="dynamicclusterpool.html#opts" class="tsd-kind-icon">opts</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a href="dynamicclusterpool.html#promisemap" class="tsd-kind-icon">promise<wbr>Map</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a href="dynamicclusterpool.html#tasks" class="tsd-kind-icon">tasks</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a href="dynamicclusterpool.html#workerchoicestrategycontext" class="tsd-kind-icon">worker<wbr>Choice<wbr>Strategy<wbr>Context</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a href="dynamicclusterpool.html#workers" class="tsd-kind-icon">workers</a>
- </li>
- <li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
- <a href="dynamicclusterpool.html#dynamic" class="tsd-kind-icon">dynamic</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a href="dynamicclusterpool.html#afterworkersetup" class="tsd-kind-icon">after<wbr>Worker<wbr>Setup</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a href="dynamicclusterpool.html#chooseworker" class="tsd-kind-icon">choose<wbr>Worker</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a href="dynamicclusterpool.html#createandsetupworker" class="tsd-kind-icon">create<wbr>And<wbr>Setup<wbr>Worker</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a href="dynamicclusterpool.html#createworker" class="tsd-kind-icon">create<wbr>Worker</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a href="dynamicclusterpool.html#decreaseworkerstasks" class="tsd-kind-icon">decrease<wbr>Workers<wbr>Tasks</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a href="dynamicclusterpool.html#destroy" class="tsd-kind-icon">destroy</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a href="dynamicclusterpool.html#destroyworker" class="tsd-kind-icon">destroy<wbr>Worker</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a href="dynamicclusterpool.html#execute" class="tsd-kind-icon">execute</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a href="dynamicclusterpool.html#increaseworkerstask" class="tsd-kind-icon">increase<wbr>Workers<wbr>Task</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a href="dynamicclusterpool.html#internalexecute" class="tsd-kind-icon">internal<wbr>Execute</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a href="dynamicclusterpool.html#ismain" class="tsd-kind-icon">is<wbr>Main</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
- <a href="dynamicclusterpool.html#registerworkermessagelistener" class="tsd-kind-icon">register<wbr>Worker<wbr>Message<wbr>Listener</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a href="dynamicclusterpool.html#removeworker" class="tsd-kind-icon">remove<wbr>Worker</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a href="dynamicclusterpool.html#sendtoworker" class="tsd-kind-icon">send<wbr>ToWorker</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a href="dynamicclusterpool.html#setworkerchoicestrategy" class="tsd-kind-icon">set<wbr>Worker<wbr>Choice<wbr>Strategy</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a href="dynamicclusterpool.html#setuphook" class="tsd-kind-icon">setup<wbr>Hook</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
- <a href="dynamicclusterpool.html#workerlistener" class="tsd-kind-icon">worker<wbr>Listener</a>
- </li>
- </ul>
- </li>
- </ul>
- <ul class="after-current">
- <li class=" tsd-kind-class tsd-has-type-parameter">
- <a href="dynamicthreadpool.html" class="tsd-kind-icon">Dynamic<wbr>Thread<wbr>Pool</a>
- </li>
- <li class=" tsd-kind-class tsd-has-type-parameter">
- <a href="fixedclusterpool.html" class="tsd-kind-icon">Fixed<wbr>Cluster<wbr>Pool</a>
- </li>
- <li class=" tsd-kind-class tsd-has-type-parameter">
- <a href="fixedthreadpool.html" class="tsd-kind-icon">Fixed<wbr>Thread<wbr>Pool</a>
- </li>
- <li class=" tsd-kind-class tsd-has-type-parameter">
- <a href="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