1 <!DOCTYPE html
><html class=
"default"><head><meta charSet=
"utf-8"/><meta http-equiv=
"x-ua-compatible" content=
"IE=edge"/><title>ClusterPoolOptions | poolifier
</title><meta name=
"description" content=
"Documentation for poolifier"/><meta name=
"viewport" content=
"width=device-width, initial-scale=1"/><link rel=
"stylesheet" href=
"../assets/style.css"/><link rel=
"stylesheet" href=
"../assets/highlight.css"/><script async
src=
"../assets/search.js" id=
"search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem(
"tsd-theme") ||
"os")
</script><header><div class=
"tsd-page-toolbar"><div class=
"container"><div class=
"table-wrap"><div class=
"table-cell" id=
"tsd-search" data-base=
".."><div class=
"field"><label for=
"tsd-search-field" class=
"tsd-widget search no-caption">Search
</label><input type=
"text" id=
"tsd-search-field"/></div><ul class=
"results"><li class=
"state loading">Preparing search index...
</li><li class=
"state failure">The search index is not available
</li></ul><a href=
"../index.html" class=
"title">poolifier
</a></div><div class=
"table-cell" id=
"tsd-widgets"><div id=
"tsd-filter"><a href=
"#" class=
"tsd-widget options no-caption" data-toggle=
"options">Options
</a><div class=
"tsd-filter-group"><div class=
"tsd-select" id=
"tsd-filter-visibility"><span class=
"tsd-select-label">All
</span><ul class=
"tsd-select-list"><li data-value=
"public">Public
</li><li data-value=
"protected">Public/Protected
</li><li data-value=
"private" class=
"selected">All
</li></ul></div> <input type=
"checkbox" id=
"tsd-filter-inherited" checked
/><label class=
"tsd-widget" for=
"tsd-filter-inherited">Inherited
</label><input type=
"checkbox" id=
"tsd-filter-externals" checked
/><label class=
"tsd-widget" for=
"tsd-filter-externals">Externals
</label></div></div><a href=
"#" class=
"tsd-widget menu no-caption" data-toggle=
"menu">Menu
</a></div></div></div></div><div class=
"tsd-page-title"><div class=
"container"><ul class=
"tsd-breadcrumb"><li><a href=
"../index.html">poolifier
</a></li><li><a href=
"ClusterPoolOptions.html">ClusterPoolOptions
</a></li></ul><h1>Interface ClusterPoolOptions
</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">
2 <p>Options for a poolifier cluster pool.
</p>
3 </div></div></section><section class=
"tsd-panel tsd-hierarchy"><h3>Hierarchy
</h3><ul class=
"tsd-hierarchy"><li><a href=
"PoolOptions.html" class=
"tsd-signature-type" data-tsd-kind=
"Interface">PoolOptions
</a><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">Worker
</span><span class=
"tsd-signature-symbol">></span><ul class=
"tsd-hierarchy"><li><span class=
"target">ClusterPoolOptions
</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>Properties
</h3><ul class=
"tsd-index-list"><li class=
"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href=
"ClusterPoolOptions.html#enableEvents" class=
"tsd-kind-icon">enable
<wbr/>Events
</a></li><li class=
"tsd-kind-property tsd-parent-kind-interface"><a href=
"ClusterPoolOptions.html#env" class=
"tsd-kind-icon">env
</a></li><li class=
"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href=
"ClusterPoolOptions.html#errorHandler" class=
"tsd-kind-icon">error
<wbr/>Handler
</a></li><li class=
"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href=
"ClusterPoolOptions.html#exitHandler" class=
"tsd-kind-icon">exit
<wbr/>Handler
</a></li><li class=
"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href=
"ClusterPoolOptions.html#messageHandler" class=
"tsd-kind-icon">message
<wbr/>Handler
</a></li><li class=
"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href=
"ClusterPoolOptions.html#onlineHandler" class=
"tsd-kind-icon">online
<wbr/>Handler
</a></li><li class=
"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href=
"ClusterPoolOptions.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 tsd-is-inherited"><a id=
"enableEvents" class=
"tsd-anchor"></a><h3><span class=
"tsd-flag ts-flagOptional">Optional
</span> enable
<wbr/>Events
</h3><div class=
"tsd-signature tsd-kind-icon">enable
<wbr/>Events
<span class=
"tsd-signature-symbol">?:
</span> <span class=
"tsd-signature-type">boolean
</span></div><aside class=
"tsd-sources"><p>Inherited from
<a href=
"PoolOptions.html">PoolOptions
</a>.
<a href=
"PoolOptions.html#enableEvents">enableEvents
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/0136f64/src/pools/abstract-pool.ts#L105">src/pools/abstract-pool.ts:
105</a></li></ul></aside><div class=
"tsd-comment tsd-typography"><div class=
"lead">
4 <p>Pool events emission.
</p>
5 </div><dl class=
"tsd-comment-tags"><dt>default
</dt><dd><p>true
</p>
6 </dd></dl></div></section><section class=
"tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id=
"env" class=
"tsd-anchor"></a><h3><span class=
"tsd-flag ts-flagOptional">Optional
</span> env
</h3><div class=
"tsd-signature tsd-kind-icon">env
<span class=
"tsd-signature-symbol">?:
</span> <span class=
"tsd-signature-type">any
</span></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/0136f64/src/pools/cluster/fixed.ts#L18">src/pools/cluster/fixed.ts:
18</a></li></ul></aside><div class=
"tsd-comment tsd-typography"><div class=
"lead">
7 <p>Key/value pairs to add to worker process environment.
</p>
8 </div><dl class=
"tsd-comment-tags"><dt>see
</dt><dd><p><a href=
"https://nodejs.org/api/cluster.html#cluster_cluster_fork_env">https://nodejs.org/api/cluster.html#cluster_cluster_fork_env
</a></p>
9 </dd></dl></div></section><section class=
"tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id=
"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> <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"><p>Inherited from
<a href=
"PoolOptions.html">PoolOptions
</a>.
<a href=
"PoolOptions.html#errorHandler">errorHandler
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/0136f64/src/pools/abstract-pool.ts#L87">src/pools/abstract-pool.ts:
87</a></li></ul></aside><div class=
"tsd-comment tsd-typography"><div class=
"lead">
10 <p>A function that will listen for error event on each worker.
</p>
11 </div></div></section><section class=
"tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id=
"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> <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"><p>Inherited from
<a href=
"PoolOptions.html">PoolOptions
</a>.
<a href=
"PoolOptions.html#exitHandler">exitHandler
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/0136f64/src/pools/abstract-pool.ts#L95">src/pools/abstract-pool.ts:
95</a></li></ul></aside><div class=
"tsd-comment tsd-typography"><div class=
"lead">
12 <p>A function that will listen for exit event on each worker.
</p>
13 </div></div></section><section class=
"tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id=
"messageHandler" class=
"tsd-anchor"></a><h3><span class=
"tsd-flag ts-flagOptional">Optional
</span> message
<wbr/>Handler
</h3><div class=
"tsd-signature tsd-kind-icon">message
<wbr/>Handler
<span class=
"tsd-signature-symbol">?:
</span> <span class=
"tsd-signature-type">MessageHandler
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">Worker
</span><span class=
"tsd-signature-symbol">></span></div><aside class=
"tsd-sources"><p>Inherited from
<a href=
"PoolOptions.html">PoolOptions
</a>.
<a href=
"PoolOptions.html#messageHandler">messageHandler
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/0136f64/src/pools/abstract-pool.ts#L83">src/pools/abstract-pool.ts:
83</a></li></ul></aside><div class=
"tsd-comment tsd-typography"><div class=
"lead">
14 <p>A function that will listen for message event on each worker.
</p>
15 </div></div></section><section class=
"tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id=
"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> <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"><p>Inherited from
<a href=
"PoolOptions.html">PoolOptions
</a>.
<a href=
"PoolOptions.html#onlineHandler">onlineHandler
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/0136f64/src/pools/abstract-pool.ts#L91">src/pools/abstract-pool.ts:
91</a></li></ul></aside><div class=
"tsd-comment tsd-typography"><div class=
"lead">
16 <p>A function that will listen for online event on each worker.
</p>
17 </div></div></section><section class=
"tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id=
"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">"ROUND_ROBIN
"</span><span class=
"tsd-signature-symbol"> |
</span><span class=
"tsd-signature-type">"LESS_RECENTLY_USED
"</span></div><aside class=
"tsd-sources"><p>Inherited from
<a href=
"PoolOptions.html">PoolOptions
</a>.
<a href=
"PoolOptions.html#workerChoiceStrategy">workerChoiceStrategy
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/0136f64/src/pools/abstract-pool.ts#L99">src/pools/abstract-pool.ts:
99</a></li></ul></aside><div class=
"tsd-comment tsd-typography"><div class=
"lead">
18 <p>The work choice strategy to use in this pool.
</p>
19 </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><li class=
"current tsd-kind-interface"><a href=
"ClusterPoolOptions.html" class=
"tsd-kind-icon">Cluster
<wbr/>Pool
<wbr/>Options
</a><ul><li class=
"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href=
"ClusterPoolOptions.html#enableEvents" class=
"tsd-kind-icon">enable
<wbr/>Events
</a></li><li class=
"tsd-kind-property tsd-parent-kind-interface"><a href=
"ClusterPoolOptions.html#env" class=
"tsd-kind-icon">env
</a></li><li class=
"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href=
"ClusterPoolOptions.html#errorHandler" class=
"tsd-kind-icon">error
<wbr/>Handler
</a></li><li class=
"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href=
"ClusterPoolOptions.html#exitHandler" class=
"tsd-kind-icon">exit
<wbr/>Handler
</a></li><li class=
"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href=
"ClusterPoolOptions.html#messageHandler" class=
"tsd-kind-icon">message
<wbr/>Handler
</a></li><li class=
"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href=
"ClusterPoolOptions.html#onlineHandler" class=
"tsd-kind-icon">online
<wbr/>Handler
</a></li><li class=
"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href=
"ClusterPoolOptions.html#workerChoiceStrategy" class=
"tsd-kind-icon">worker
<wbr/>Choice
<wbr/>Strategy
</a></li></ul></li></ul></nav></div></div></div><footer class=
"with-border-bottom"><div class=
"container"><h2>Legend
</h2><div class=
"tsd-legend-group"><ul class=
"tsd-legend"><li class=
"tsd-kind-property tsd-parent-kind-interface"><span class=
"tsd-kind-icon">Property
</span></li><li class=
"tsd-kind-method tsd-parent-kind-interface"><span class=
"tsd-kind-icon">Method
</span></li></ul><ul class=
"tsd-legend"><li class=
"tsd-kind-property tsd-parent-kind-class"><span class=
"tsd-kind-icon">Property
</span></li><li class=
"tsd-kind-method tsd-parent-kind-class"><span class=
"tsd-kind-icon">Method
</span></li></ul><ul class=
"tsd-legend"><li class=
"tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class=
"tsd-kind-icon">Inherited property
</span></li><li class=
"tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class=
"tsd-kind-icon">Inherited method
</span></li></ul><ul class=
"tsd-legend"><li class=
"tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class=
"tsd-kind-icon">Protected property
</span></li><li class=
"tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class=
"tsd-kind-icon">Protected method
</span></li></ul><ul class=
"tsd-legend"><li class=
"tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class=
"tsd-kind-icon">Private method
</span></li></ul></div><h2>Settings
</h2><p>Theme
<select id=
"theme"><option value=
"os">OS
</option><option value=
"light">Light
</option><option value=
"dark">Dark
</option></select></p></div></footer><div class=
"container tsd-generator"><p>Generated using
<a href=
"https://typedoc.org/" target=
"_blank">TypeDoc
</a></p></div><div class=
"overlay"></div><script src=
"../assets/main.js"></script></body></html>
repositories / poolifier.git / blob