Fix strategy handling in pool options (#259)
[poolifier.git] / docs / interfaces / pooloptions.html
index f7dc49ab1b142a59e518e943fb6cd7aaa3acc9e1..6db10692b6176d3217663e70cc707c9cac72a257 100644 (file)
                                                <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#enableevents" class="tsd-kind-icon">enable<wbr>Events</a></li>
                                                                <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>
                        </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="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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></div>
+                                       <aside class="tsd-sources">
+                                               <ul>
+                                                       <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/7fb595d/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">
+                                                       <p>Pool events emission.</p>
+                                               </div>
+                                               <p>Default to true.</p>
+                                       </div>
+                               </section>
                                <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">&lt;</span><span class="tsd-signature-type">Worker</span><span class="tsd-signature-symbol">&gt;</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>
+                                                       <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/7fb595d/src/pools/abstract-pool.ts#L77">src/pools/abstract-pool.ts:77</a></li>
                                                </ul>
                                        </aside>
                                        <div class="tsd-comment tsd-typography">
                                        <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>
                                        <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>
+                                                       <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/7fb595d/src/pools/abstract-pool.ts#L85">src/pools/abstract-pool.ts:85</a></li>
                                                </ul>
                                        </aside>
                                        <div class="tsd-comment tsd-typography">
                                        <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>
                                        <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>
+                                                       <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/7fb595d/src/pools/abstract-pool.ts#L81">src/pools/abstract-pool.ts:81</a></li>
                                                </ul>
                                        </aside>
                                        <div class="tsd-comment tsd-typography">
                                        <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>
                                        <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>
+                                                       <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/7fb595d/src/pools/abstract-pool.ts#L89">src/pools/abstract-pool.ts:89</a></li>
                                                </ul>
                                        </aside>
                                        <div class="tsd-comment tsd-typography">
                                        <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#enableevents" class="tsd-kind-icon">enable<wbr>Events</a>
+                                                       </li>
                                                        <li class=" tsd-kind-property tsd-parent-kind-interface">
                                                                <a href="pooloptions.html#errorhandler" class="tsd-kind-icon">error<wbr>Handler</a>
                                                        </li>