docs/interfaces/pooloptions.html

   1 <!doctype html>
   2 <html class="default no-js">
   3 <head>
   4         <meta charset="utf-8">
   5         <meta http-equiv="X-UA-Compatible" content="IE=edge">
   6         <title>PoolOptions | poolifier</title>
   7         <meta name="description" content="Documentation for poolifier">
   8         <meta name="viewport" content="width=device-width, initial-scale=1">
   9         <link rel="stylesheet" href="../assets/css/main.css">
  10         <script async src="../assets/js/search.js" id="search-script"></script>
  11 </head>
  12 <body>
  13 <header>
  14         <div class="tsd-page-toolbar">
  15                 <div class="container">
  16                         <div class="table-wrap">
  17                                 <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
  18                                         <div class="field">
  19                                                 <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
  20                                                 <input id="tsd-search-field" type="text" />
  21                                         </div>
  22                                         <ul class="results">
  23                                                 <li class="state loading">Preparing search index...</li>
  24                                                 <li class="state failure">The search index is not available</li>
  25                                         </ul>
  26                                         <a href="../index.html" class="title">poolifier</a>
  27                                 </div>
  28                                 <div class="table-cell" id="tsd-widgets">
  29                                         <div id="tsd-filter">
  30                                                 <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
  31                                                 <div class="tsd-filter-group">
  32                                                         <div class="tsd-select" id="tsd-filter-visibility">
  33                                                                 <span class="tsd-select-label">All</span>
  34                                                                 <ul class="tsd-select-list">
  35                                                                         <li data-value="public">Public</li>
  36                                                                         <li data-value="protected">Public/Protected</li>
  37                                                                         <li data-value="private" class="selected">All</li>
  38                                                                 </ul>
  39                                                         </div>
  40                                                         <input type="checkbox" id="tsd-filter-inherited" checked />
  41                                                         <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
  42                                                         <input type="checkbox" id="tsd-filter-externals" checked />
  43                                                         <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
  44                                                 </div>
  45                                         </div>
  46                                         <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
  47                                 </div>
  48                         </div>
  49                 </div>
  50         </div>
  51         <div class="tsd-page-title">
  52                 <div class="container">
  53                         <ul class="tsd-breadcrumb">
  54                                 <li>
  55                                         <a href="../index.html">poolifier</a>
  56                                 </li>
  57                                 <li>
  58                                         <a href="pooloptions.html">PoolOptions</a>
  59                                 </li>
  60                         </ul>
  61                         <h1>Interface PoolOptions&lt;Worker&gt;</h1>
  62                 </div>
  63         </div>
  64 </header>
  65 <div class="container container-main">
  66         <div class="row">
  67                 <div class="col-8 col-content">
  68                         <section class="tsd-panel tsd-comment">
  69                                 <div class="tsd-comment tsd-typography">
  70                                         <div class="lead">
  71                                                 <p>Options for a poolifier pool.</p>
  72                                         </div>
  73                                 </div>
  74                         </section>
  75                         <section class="tsd-panel tsd-type-parameters">
  76                                 <h3>Type parameters</h3>
  77                                 <ul class="tsd-type-parameters">
  78                                         <li>
  79                                                 <h4>Worker</h4>
  80                                         </li>
  81                                 </ul>
  82                         </section>
  83                         <section class="tsd-panel tsd-hierarchy">
  84                                 <h3>Hierarchy</h3>
  85                                 <ul class="tsd-hierarchy">
  86                                         <li>
  87                                                 <span class="target">PoolOptions</span>
  88                                                 <ul class="tsd-hierarchy">
  89                                                         <li>
  90                                                                 <a href="clusterpooloptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClusterPoolOptions</a>
  91                                                         </li>
  92                                                 </ul>
  93                                         </li>
  94                                 </ul>
  95                         </section>
  96                         <section class="tsd-panel-group tsd-index-group">
  97                                 <h2>Index</h2>
  98                                 <section class="tsd-panel tsd-index-panel">
  99                                         <div class="tsd-index-content">
 100                                                 <section class="tsd-index-section ">
 101                                                         <h3>Properties</h3>
 102                                                         <ul class="tsd-index-list">
 103                                                                 <li class="tsd-kind-property tsd-parent-kind-interface"><a href="pooloptions.html#errorhandler" class="tsd-kind-icon">error<wbr>Handler</a></li>
 104                                                                 <li class="tsd-kind-property tsd-parent-kind-interface"><a href="pooloptions.html#exithandler" class="tsd-kind-icon">exit<wbr>Handler</a></li>
 105                                                                 <li class="tsd-kind-property tsd-parent-kind-interface"><a href="pooloptions.html#onlinehandler" class="tsd-kind-icon">online<wbr>Handler</a></li>
 106                                                                 <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>
 107                                                         </ul>
 108                                                 </section>
 109                                         </div>
 110                                 </section>
 111                         </section>
 112                         <section class="tsd-panel-group tsd-member-group ">
 113                                 <h2>Properties</h2>
 114                                 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
 115                                         <a name="errorhandler" class="tsd-anchor"></a>
 116                                         <h3><span class="tsd-flag ts-flagOptional">Optional</span> error<wbr>Handler</h3>
 117                                         <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">&lt;</span><span class="tsd-signature-type">Worker</span><span class="tsd-signature-symbol">&gt;</span></div>
 118                                         <aside class="tsd-sources">
 119                                                 <ul>
 120                                                         <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>
 121                                                 </ul>
 122                                         </aside>
 123                                         <div class="tsd-comment tsd-typography">
 124                                                 <div class="lead">
 125                                                         <p>A function that will listen for error event on each worker.</p>
 126                                                 </div>
 127                                         </div>
 128                                 </section>
 129                                 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
 130                                         <a name="exithandler" class="tsd-anchor"></a>
 131                                         <h3><span class="tsd-flag ts-flagOptional">Optional</span> exit<wbr>Handler</h3>
 132                                         <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">&lt;</span><span class="tsd-signature-type">Worker</span><span class="tsd-signature-symbol">&gt;</span></div>
 133                                         <aside class="tsd-sources">
 134                                                 <ul>
 135                                                         <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>
 136                                                 </ul>
 137                                         </aside>
 138                                         <div class="tsd-comment tsd-typography">
 139                                                 <div class="lead">
 140                                                         <p>A function that will listen for exit event on each worker.</p>
 141                                                 </div>
 142                                         </div>
 143                                 </section>
 144                                 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
 145                                         <a name="onlinehandler" class="tsd-anchor"></a>
 146                                         <h3><span class="tsd-flag ts-flagOptional">Optional</span> online<wbr>Handler</h3>
 147                                         <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">&lt;</span><span class="tsd-signature-type">Worker</span><span class="tsd-signature-symbol">&gt;</span></div>
 148                                         <aside class="tsd-sources">
 149                                                 <ul>
 150                                                         <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>
 151                                                 </ul>
 152                                         </aside>
 153                                         <div class="tsd-comment tsd-typography">
 154                                                 <div class="lead">
 155                                                         <p>A function that will listen for online event on each worker.</p>
 156                                                 </div>
 157                                         </div>
 158                                 </section>
 159                                 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
 160                                         <a name="workerchoicestrategy" class="tsd-anchor"></a>
 161                                         <h3><span class="tsd-flag ts-flagOptional">Optional</span> worker<wbr>Choice<wbr>Strategy</h3>
 162                                         <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">&quot;ROUND_ROBIN&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;LESS_RECENTLY_USED&quot;</span></div>
 163                                         <aside class="tsd-sources">
 164                                                 <ul>
 165                                                         <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>
 166                                                 </ul>
 167                                         </aside>
 168                                         <div class="tsd-comment tsd-typography">
 169                                                 <div class="lead">
 170                                                         <p>The work choice strategy to use in this pool.</p>
 171                                                 </div>
 172                                         </div>
 173                                 </section>
 174                         </section>
 175                 </div>
 176                 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 177                         <nav class="tsd-navigation primary">
 178                                 <ul>
 179                                         <li class=" ">
 180                                                 <a href="../index.html">Exports</a>
 181                                         </li>
 182                                 </ul>
 183                         </nav>
 184                         <nav class="tsd-navigation secondary menu-sticky">
 185                                 <ul class="before-current">
 186                                         <li class=" tsd-kind-class tsd-has-type-parameter">
 187                                                 <a href="../classes/abstractworker.html" class="tsd-kind-icon">Abstract<wbr>Worker</a>
 188                                         </li>
 189                                         <li class=" tsd-kind-class tsd-has-type-parameter">
 190                                                 <a href="../classes/clusterworker.html" class="tsd-kind-icon">Cluster<wbr>Worker</a>
 191                                         </li>
 192                                         <li class=" tsd-kind-class tsd-has-type-parameter">
 193                                                 <a href="../classes/dynamicclusterpool.html" class="tsd-kind-icon">Dynamic<wbr>Cluster<wbr>Pool</a>
 194                                         </li>
 195                                         <li class=" tsd-kind-class tsd-has-type-parameter">
 196                                                 <a href="../classes/dynamicthreadpool.html" class="tsd-kind-icon">Dynamic<wbr>Thread<wbr>Pool</a>
 197                                         </li>
 198                                         <li class=" tsd-kind-class tsd-has-type-parameter">
 199                                                 <a href="../classes/fixedclusterpool.html" class="tsd-kind-icon">Fixed<wbr>Cluster<wbr>Pool</a>
 200                                         </li>
 201                                         <li class=" tsd-kind-class tsd-has-type-parameter">
 202                                                 <a href="../classes/fixedthreadpool.html" class="tsd-kind-icon">Fixed<wbr>Thread<wbr>Pool</a>
 203                                         </li>
 204                                         <li class=" tsd-kind-class tsd-has-type-parameter">
 205                                                 <a href="../classes/threadworker.html" class="tsd-kind-icon">Thread<wbr>Worker</a>
 206                                         </li>
 207                                         <li class=" tsd-kind-interface">
 208                                                 <a href="clusterpooloptions.html" class="tsd-kind-icon">Cluster<wbr>Pool<wbr>Options</a>
 209                                         </li>
 210                                         <li class=" tsd-kind-interface tsd-has-type-parameter">
 211                                                 <a href="ipool.html" class="tsd-kind-icon">IPool</a>
 212                                         </li>
 213                                         <li class=" tsd-kind-interface">
 214                                                 <a href="iworker.html" class="tsd-kind-icon">IWorker</a>
 215                                         </li>
 216                                 </ul>
 217                                 <ul class="current">
 218                                         <li class="current tsd-kind-interface tsd-has-type-parameter">
 219                                                 <a href="pooloptions.html" class="tsd-kind-icon">Pool<wbr>Options</a>
 220                                                 <ul>
 221                                                         <li class=" tsd-kind-property tsd-parent-kind-interface">
 222                                                                 <a href="pooloptions.html#errorhandler" class="tsd-kind-icon">error<wbr>Handler</a>
 223                                                         </li>
 224                                                         <li class=" tsd-kind-property tsd-parent-kind-interface">
 225                                                                 <a href="pooloptions.html#exithandler" class="tsd-kind-icon">exit<wbr>Handler</a>
 226                                                         </li>
 227                                                         <li class=" tsd-kind-property tsd-parent-kind-interface">
 228                                                                 <a href="pooloptions.html#onlinehandler" class="tsd-kind-icon">online<wbr>Handler</a>
 229                                                         </li>
 230                                                         <li class=" tsd-kind-property tsd-parent-kind-interface">
 231                                                                 <a href="pooloptions.html#workerchoicestrategy" class="tsd-kind-icon">worker<wbr>Choice<wbr>Strategy</a>
 232                                                         </li>
 233                                                 </ul>
 234                                         </li>
 235                                 </ul>
 236                                 <ul class="after-current">
 237                                         <li class=" tsd-kind-interface">
 238                                                 <a href="workeroptions.html" class="tsd-kind-icon">Worker<wbr>Options</a>
 239                                         </li>
 240                                         <li class=" tsd-kind-type-alias tsd-has-type-parameter">
 241                                                 <a href="../index.html#errorhandler" class="tsd-kind-icon">Error<wbr>Handler</a>
 242                                         </li>
 243                                         <li class=" tsd-kind-type-alias tsd-has-type-parameter">
 244                                                 <a href="../index.html#exithandler" class="tsd-kind-icon">Exit<wbr>Handler</a>
 245                                         </li>
 246                                         <li class=" tsd-kind-type-alias">
 247                                                 <a href="../index.html#killbehavior" class="tsd-kind-icon">Kill<wbr>Behavior</a>
 248                                         </li>
 249                                         <li class=" tsd-kind-type-alias tsd-has-type-parameter">
 250                                                 <a href="../index.html#onlinehandler" class="tsd-kind-icon">Online<wbr>Handler</a>
 251                                         </li>
 252                                         <li class=" tsd-kind-type-alias">
 253                                                 <a href="../index.html#threadworkerwithmessagechannel" class="tsd-kind-icon">Thread<wbr>Worker<wbr>With<wbr>Message<wbr>Channel</a>
 254                                         </li>
 255                                         <li class=" tsd-kind-type-alias">
 256                                                 <a href="../index.html#workerchoicestrategy" class="tsd-kind-icon">Worker<wbr>Choice<wbr>Strategy</a>
 257                                         </li>
 258                                         <li class=" tsd-kind-variable">
 259                                                 <a href="../index.html#killbehaviors" class="tsd-kind-icon">Kill<wbr>Behaviors</a>
 260                                         </li>
 261                                         <li class=" tsd-kind-variable">
 262                                                 <a href="../index.html#workerchoicestrategies" class="tsd-kind-icon">Worker<wbr>Choice<wbr>Strategies</a>
 263                                         </li>
 264                                 </ul>
 265                         </nav>
 266                 </div>
 267         </div>
 268 </div>
 269 <footer class="with-border-bottom">
 270         <div class="container">
 271                 <h2>Legend</h2>
 272                 <div class="tsd-legend-group">
 273                         <ul class="tsd-legend">
 274                                 <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
 275                                 <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
 276                         </ul>
 277                         <ul class="tsd-legend">
 278                                 <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
 279                                 <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
 280                         </ul>
 281                         <ul class="tsd-legend">
 282                                 <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
 283                                 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
 284                         </ul>
 285                         <ul class="tsd-legend">
 286                                 <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
 287                                 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
 288                         </ul>
 289                         <ul class="tsd-legend">
 290                                 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
 291                         </ul>
 292                 </div>
 293         </div>
 294 </footer>
 295 <div class="container tsd-generator">
 296         <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
 297 </div>
 298 <div class="overlay"></div>
 299 <script src="../assets/js/main.js"></script>
 300 </body>
 301 </html>