--- /dev/null
+<!doctype html>
+<html class="default no-js">
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <title>PoolOptions | 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="pooloptions.html">PoolOptions</a>
+ </li>
+ </ul>
+ <h1>Interface PoolOptions<Worker></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>Options for a poolifier pool.</p>
+ </div>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-type-parameters">
+ <h3>Type parameters</h3>
+ <ul class="tsd-type-parameters">
+ <li>
+ <h4>Worker</h4>
+ </li>
+ </ul>
+ </section>
+ <section class="tsd-panel tsd-hierarchy">
+ <h3>Hierarchy</h3>
+ <ul class="tsd-hierarchy">
+ <li>
+ <span class="target">PoolOptions</span>
+ <ul class="tsd-hierarchy">
+ <li>
+ <a href="clusterpooloptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClusterPoolOptions</a>
+ </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>Properties</h3>
+ <ul class="tsd-index-list">
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="pooloptions.html#errorhandler" class="tsd-kind-icon">error<wbr>Handler</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="pooloptions.html#exithandler" class="tsd-kind-icon">exit<wbr>Handler</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="pooloptions.html#onlinehandler" class="tsd-kind-icon">online<wbr>Handler</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="pooloptions.html#workerchoicestrategy" class="tsd-kind-icon">worker<wbr>Choice<wbr>Strategy</a></li>
+ </ul>
+ </section>
+ </div>
+ </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-interface">
+ <a name="errorhandler" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> error<wbr>Handler</h3>
+ <div class="tsd-signature tsd-kind-icon">error<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#errorhandler" class="tsd-signature-type" data-tsd-kind="Type alias">ErrorHandler</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Worker</span><span class="tsd-signature-symbol">></span></div>
+ <aside class="tsd-sources">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L77">src/pools/abstract-pool.ts:77</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>A function that will listen for error event on each worker.</p>
+ </div>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+ <a name="exithandler" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> exit<wbr>Handler</h3>
+ <div class="tsd-signature tsd-kind-icon">exit<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#exithandler" class="tsd-signature-type" data-tsd-kind="Type alias">ExitHandler</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Worker</span><span class="tsd-signature-symbol">></span></div>
+ <aside class="tsd-sources">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L85">src/pools/abstract-pool.ts:85</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>A function that will listen for exit event on each worker.</p>
+ </div>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+ <a name="onlinehandler" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> online<wbr>Handler</h3>
+ <div class="tsd-signature tsd-kind-icon">online<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#onlinehandler" class="tsd-signature-type" data-tsd-kind="Type alias">OnlineHandler</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Worker</span><span class="tsd-signature-symbol">></span></div>
+ <aside class="tsd-sources">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L81">src/pools/abstract-pool.ts:81</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>A function that will listen for online event on each worker.</p>
+ </div>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+ <a name="workerchoicestrategy" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> 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-type">undefined</span><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></div>
+ <aside class="tsd-sources">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L89">src/pools/abstract-pool.ts:89</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>The work choice strategy to use in this pool.</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=" ">
+ <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="clusterpooloptions.html" class="tsd-kind-icon">Cluster<wbr>Pool<wbr>Options</a>
+ </li>
+ <li class=" tsd-kind-interface tsd-has-type-parameter">
+ <a href="ipool.html" class="tsd-kind-icon">IPool</a>
+ </li>
+ <li class=" tsd-kind-interface">
+ <a href="iworker.html" class="tsd-kind-icon">IWorker</a>
+ </li>
+ </ul>
+ <ul class="current">
+ <li class="current tsd-kind-interface tsd-has-type-parameter">
+ <a href="pooloptions.html" class="tsd-kind-icon">Pool<wbr>Options</a>
+ <ul>
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
+ <a href="pooloptions.html#errorhandler" class="tsd-kind-icon">error<wbr>Handler</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
+ <a href="pooloptions.html#exithandler" class="tsd-kind-icon">exit<wbr>Handler</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
+ <a href="pooloptions.html#onlinehandler" class="tsd-kind-icon">online<wbr>Handler</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
+ <a href="pooloptions.html#workerchoicestrategy" class="tsd-kind-icon">worker<wbr>Choice<wbr>Strategy</a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ <ul class="after-current">
+ <li class=" tsd-kind-interface">
+ <a href="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
repositories / poolifier.git / blobdiff