benchmarks/versus-external-pools/
+docs/
lib/
!.vscode/tasks.json
# Mac
-.DS_Store/
.DS_Store
.history/
.nyc_output/
coverage/
+docs/
lib/
#### Public property replacements
`numWorkers` property is now `numberOfWorkers`
-`nextWorker` property is now `nextWorkerIndex`
#### Internal (protected) properties and methods renaming
<div align="center">
-<img src="./docs/logo.png" width="340px" height="266px"/>
+<img src="./images/logo.png" width="340px" height="266px"/>
</div>
<h2 align="center">Node Thread Pool and Cluster Pool :arrow_double_up: :on:</h2>
--- /dev/null
+/*! normalize.css v1.1.3 | MIT License | git.io/normalize */
+/* ==========================================================================
+ * * HTML5 display definitions
+ * * ========================================================================== */
+/**
+ * * Correct `block` display not defined in IE 6/7/8/9 and Firefox 3. */
+article, aside, details, figcaption, figure, footer, header, hgroup, main, nav, section, summary {
+ display: block;
+}
+
+/**
+ * * Correct `inline-block` display not defined in IE 6/7/8/9 and Firefox 3. */
+audio, canvas, video {
+ display: inline-block;
+ *display: inline;
+ *zoom: 1;
+}
+
+/**
+ * * Prevent modern browsers from displaying `audio` without controls.
+ * * Remove excess height in iOS 5 devices. */
+audio:not([controls]) {
+ display: none;
+ height: 0;
+}
+
+/**
+ * * Address styling not present in IE 7/8/9, Firefox 3, and Safari 4.
+ * * Known issue: no IE 6 support. */
+[hidden] {
+ display: none;
+}
+
+/* ==========================================================================
+ * * Base
+ * * ========================================================================== */
+/**
+ * * 1. Correct text resizing oddly in IE 6/7 when body `font-size` is set using
+ * * `em` units.
+ * * 2. Prevent iOS text size adjust after orientation change, without disabling
+ * * user zoom. */
+html {
+ font-size: 100%;
+ /* 1 */
+ -ms-text-size-adjust: 100%;
+ /* 2 */
+ -webkit-text-size-adjust: 100%;
+ /* 2 */
+ font-family: sans-serif;
+}
+
+/**
+ * * Address `font-family` inconsistency between `textarea` and other form
+ * * elements. */
+button, input, select, textarea {
+ font-family: sans-serif;
+}
+
+/**
+ * * Address margins handled incorrectly in IE 6/7. */
+body {
+ margin: 0;
+}
+
+/* ==========================================================================
+ * * Links
+ * * ========================================================================== */
+/**
+ * * Address `outline` inconsistency between Chrome and other browsers. */
+a:focus {
+ outline: thin dotted;
+}
+a:active, a:hover {
+ outline: 0;
+}
+
+/**
+ * * Improve readability when focused and also mouse hovered in all browsers. */
+/* ==========================================================================
+ * * Typography
+ * * ========================================================================== */
+/**
+ * * Address font sizes and margins set differently in IE 6/7.
+ * * Address font sizes within `section` and `article` in Firefox 4+, Safari 5,
+ * * and Chrome. */
+h1 {
+ font-size: 2em;
+ margin: 0.67em 0;
+}
+
+h2 {
+ font-size: 1.5em;
+ margin: 0.83em 0;
+}
+
+h3 {
+ font-size: 1.17em;
+ margin: 1em 0;
+}
+
+h4, .tsd-index-panel h3 {
+ font-size: 1em;
+ margin: 1.33em 0;
+}
+
+h5 {
+ font-size: 0.83em;
+ margin: 1.67em 0;
+}
+
+h6 {
+ font-size: 0.67em;
+ margin: 2.33em 0;
+}
+
+/**
+ * * Address styling not present in IE 7/8/9, Safari 5, and Chrome. */
+abbr[title] {
+ border-bottom: 1px dotted;
+}
+
+/**
+ * * Address style set to `bolder` in Firefox 3+, Safari 4/5, and Chrome. */
+b, strong {
+ font-weight: bold;
+}
+
+blockquote {
+ margin: 1em 40px;
+}
+
+/**
+ * * Address styling not present in Safari 5 and Chrome. */
+dfn {
+ font-style: italic;
+}
+
+/**
+ * * Address differences between Firefox and other browsers.
+ * * Known issue: no IE 6/7 normalization. */
+hr {
+ -moz-box-sizing: content-box;
+ box-sizing: content-box;
+ height: 0;
+}
+
+/**
+ * * Address styling not present in IE 6/7/8/9. */
+mark {
+ background: #ff0;
+ color: #000;
+}
+
+/**
+ * * Address margins set differently in IE 6/7. */
+p, pre {
+ margin: 1em 0;
+}
+
+/**
+ * * Correct font family set oddly in IE 6, Safari 4/5, and Chrome. */
+code, kbd, pre, samp {
+ font-family: monospace, serif;
+ _font-family: "courier new", monospace;
+ font-size: 1em;
+}
+
+/**
+ * * Improve readability of pre-formatted text in all browsers. */
+pre {
+ white-space: pre;
+ white-space: pre-wrap;
+ word-wrap: break-word;
+}
+
+/**
+ * * Address CSS quotes not supported in IE 6/7. */
+q {
+ quotes: none;
+}
+q:before, q:after {
+ content: "";
+ content: none;
+}
+
+/**
+ * * Address `quotes` property not supported in Safari 4. */
+/**
+ * * Address inconsistent and variable font size in all browsers. */
+small {
+ font-size: 80%;
+}
+
+/**
+ * * Prevent `sub` and `sup` affecting `line-height` in all browsers. */
+sub {
+ font-size: 75%;
+ line-height: 0;
+ position: relative;
+ vertical-align: baseline;
+}
+
+sup {
+ font-size: 75%;
+ line-height: 0;
+ position: relative;
+ vertical-align: baseline;
+ top: -0.5em;
+}
+
+sub {
+ bottom: -0.25em;
+}
+
+/* ==========================================================================
+ * * Lists
+ * * ========================================================================== */
+/**
+ * * Address margins set differently in IE 6/7. */
+dl, menu, ol, ul {
+ margin: 1em 0;
+}
+
+dd {
+ margin: 0 0 0 40px;
+}
+
+/**
+ * * Address paddings set differently in IE 6/7. */
+menu, ol, ul {
+ padding: 0 0 0 40px;
+}
+
+/**
+ * * Correct list images handled incorrectly in IE 7. */
+nav ul, nav ol {
+ list-style: none;
+ list-style-image: none;
+}
+
+/* ==========================================================================
+ * * Embedded content
+ * * ========================================================================== */
+/**
+ * * 1. Remove border when inside `a` element in IE 6/7/8/9 and Firefox 3.
+ * * 2. Improve image quality when scaled in IE 7. */
+img {
+ border: 0;
+ /* 1 */
+ -ms-interpolation-mode: bicubic;
+}
+
+/* 2 */
+/**
+ * * Correct overflow displayed oddly in IE 9. */
+svg:not(:root) {
+ overflow: hidden;
+}
+
+/* ==========================================================================
+ * * Figures
+ * * ========================================================================== */
+/**
+ * * Address margin not present in IE 6/7/8/9, Safari 5, and Opera 11. */
+figure, form {
+ margin: 0;
+}
+
+/* ==========================================================================
+ * * Forms
+ * * ========================================================================== */
+/**
+ * * Correct margin displayed oddly in IE 6/7. */
+/**
+ * * Define consistent border, margin, and padding. */
+fieldset {
+ border: 1px solid #c0c0c0;
+ margin: 0 2px;
+ padding: 0.35em 0.625em 0.75em;
+}
+
+/**
+ * * 1. Correct color not being inherited in IE 6/7/8/9.
+ * * 2. Correct text not wrapping in Firefox 3.
+ * * 3. Correct alignment displayed oddly in IE 6/7. */
+legend {
+ border: 0;
+ /* 1 */
+ padding: 0;
+ white-space: normal;
+ /* 2 */
+ *margin-left: -7px;
+}
+
+/* 3 */
+/**
+ * * 1. Correct font size not being inherited in all browsers.
+ * * 2. Address margins set differently in IE 6/7, Firefox 3+, Safari 5,
+ * * and Chrome.
+ * * 3. Improve appearance and consistency in all browsers. */
+button, input, select, textarea {
+ font-size: 100%;
+ /* 1 */
+ margin: 0;
+ /* 2 */
+ vertical-align: baseline;
+ /* 3 */
+ *vertical-align: middle;
+}
+
+/* 3 */
+/**
+ * * Address Firefox 3+ setting `line-height` on `input` using `!important` in
+ * * the UA stylesheet. */
+button, input {
+ line-height: normal;
+}
+
+/**
+ * * Address inconsistent `text-transform` inheritance for `button` and `select`.
+ * * All other form control elements do not inherit `text-transform` values.
+ * * Correct `button` style inheritance in Chrome, Safari 5+, and IE 6+.
+ * * Correct `select` style inheritance in Firefox 4+ and Opera. */
+button, select {
+ text-transform: none;
+}
+
+/**
+ * * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio`
+ * * and `video` controls.
+ * * 2. Correct inability to style clickable `input` types in iOS.
+ * * 3. Improve usability and consistency of cursor style between image-type
+ * * `input` and others.
+ * * 4. Remove inner spacing in IE 7 without affecting normal text inputs.
+ * * Known issue: inner spacing remains in IE 6. */
+button, html input[type=button] {
+ -webkit-appearance: button;
+ /* 2 */
+ cursor: pointer;
+ /* 3 */
+ *overflow: visible;
+}
+
+/* 4 */
+input[type=reset], input[type=submit] {
+ -webkit-appearance: button;
+ /* 2 */
+ cursor: pointer;
+ /* 3 */
+ *overflow: visible;
+}
+
+/* 4 */
+/**
+ * * Re-set default cursor for disabled elements. */
+button[disabled], html input[disabled] {
+ cursor: default;
+}
+
+/**
+ * * 1. Address box sizing set to content-box in IE 8/9.
+ * * 2. Remove excess padding in IE 8/9.
+ * * 3. Remove excess padding in IE 7.
+ * * Known issue: excess padding remains in IE 6. */
+input {
+ /* 3 */
+}
+input[type=checkbox], input[type=radio] {
+ box-sizing: border-box;
+ /* 1 */
+ padding: 0;
+ /* 2 */
+ *height: 13px;
+ /* 3 */
+ *width: 13px;
+}
+input[type=search] {
+ -webkit-appearance: textfield;
+ /* 1 */
+ -moz-box-sizing: content-box;
+ -webkit-box-sizing: content-box;
+ /* 2 */
+ box-sizing: content-box;
+}
+input[type=search]::-webkit-search-cancel-button, input[type=search]::-webkit-search-decoration {
+ -webkit-appearance: none;
+}
+
+/**
+ * * 1. Address `appearance` set to `searchfield` in Safari 5 and Chrome.
+ * * 2. Address `box-sizing` set to `border-box` in Safari 5 and Chrome
+ * * (include `-moz` to future-proof). */
+/**
+ * * Remove inner padding and search cancel button in Safari 5 and Chrome
+ * * on OS X. */
+/**
+ * * Remove inner padding and border in Firefox 3+. */
+button::-moz-focus-inner, input::-moz-focus-inner {
+ border: 0;
+ padding: 0;
+}
+
+/**
+ * * 1. Remove default vertical scrollbar in IE 6/7/8/9.
+ * * 2. Improve readability and alignment in all browsers. */
+textarea {
+ overflow: auto;
+ /* 1 */
+ vertical-align: top;
+}
+
+/* 2 */
+/* ==========================================================================
+ * * Tables
+ * * ========================================================================== */
+/**
+ * * Remove most spacing between table cells. */
+table {
+ border-collapse: collapse;
+ border-spacing: 0;
+}
+
+ul.tsd-descriptions > li > :first-child, .tsd-panel > :first-child, .col > :first-child, .col-11 > :first-child, .col-10 > :first-child, .col-9 > :first-child, .col-8 > :first-child, .col-7 > :first-child, .col-6 > :first-child, .col-5 > :first-child, .col-4 > :first-child, .col-3 > :first-child, .col-2 > :first-child, .col-1 > :first-child,
+ul.tsd-descriptions > li > :first-child > :first-child,
+.tsd-panel > :first-child > :first-child,
+.col > :first-child > :first-child,
+.col-11 > :first-child > :first-child,
+.col-10 > :first-child > :first-child,
+.col-9 > :first-child > :first-child,
+.col-8 > :first-child > :first-child,
+.col-7 > :first-child > :first-child,
+.col-6 > :first-child > :first-child,
+.col-5 > :first-child > :first-child,
+.col-4 > :first-child > :first-child,
+.col-3 > :first-child > :first-child,
+.col-2 > :first-child > :first-child,
+.col-1 > :first-child > :first-child,
+ul.tsd-descriptions > li > :first-child > :first-child > :first-child,
+.tsd-panel > :first-child > :first-child > :first-child,
+.col > :first-child > :first-child > :first-child,
+.col-11 > :first-child > :first-child > :first-child,
+.col-10 > :first-child > :first-child > :first-child,
+.col-9 > :first-child > :first-child > :first-child,
+.col-8 > :first-child > :first-child > :first-child,
+.col-7 > :first-child > :first-child > :first-child,
+.col-6 > :first-child > :first-child > :first-child,
+.col-5 > :first-child > :first-child > :first-child,
+.col-4 > :first-child > :first-child > :first-child,
+.col-3 > :first-child > :first-child > :first-child,
+.col-2 > :first-child > :first-child > :first-child,
+.col-1 > :first-child > :first-child > :first-child {
+ margin-top: 0;
+}
+ul.tsd-descriptions > li > :last-child, .tsd-panel > :last-child, .col > :last-child, .col-11 > :last-child, .col-10 > :last-child, .col-9 > :last-child, .col-8 > :last-child, .col-7 > :last-child, .col-6 > :last-child, .col-5 > :last-child, .col-4 > :last-child, .col-3 > :last-child, .col-2 > :last-child, .col-1 > :last-child,
+ul.tsd-descriptions > li > :last-child > :last-child,
+.tsd-panel > :last-child > :last-child,
+.col > :last-child > :last-child,
+.col-11 > :last-child > :last-child,
+.col-10 > :last-child > :last-child,
+.col-9 > :last-child > :last-child,
+.col-8 > :last-child > :last-child,
+.col-7 > :last-child > :last-child,
+.col-6 > :last-child > :last-child,
+.col-5 > :last-child > :last-child,
+.col-4 > :last-child > :last-child,
+.col-3 > :last-child > :last-child,
+.col-2 > :last-child > :last-child,
+.col-1 > :last-child > :last-child,
+ul.tsd-descriptions > li > :last-child > :last-child > :last-child,
+.tsd-panel > :last-child > :last-child > :last-child,
+.col > :last-child > :last-child > :last-child,
+.col-11 > :last-child > :last-child > :last-child,
+.col-10 > :last-child > :last-child > :last-child,
+.col-9 > :last-child > :last-child > :last-child,
+.col-8 > :last-child > :last-child > :last-child,
+.col-7 > :last-child > :last-child > :last-child,
+.col-6 > :last-child > :last-child > :last-child,
+.col-5 > :last-child > :last-child > :last-child,
+.col-4 > :last-child > :last-child > :last-child,
+.col-3 > :last-child > :last-child > :last-child,
+.col-2 > :last-child > :last-child > :last-child,
+.col-1 > :last-child > :last-child > :last-child {
+ margin-bottom: 0;
+}
+
+.container {
+ max-width: 1200px;
+ margin: 0 auto;
+ padding: 0 40px;
+}
+@media (max-width: 640px) {
+ .container {
+ padding: 0 20px;
+ }
+}
+
+.container-main {
+ padding-bottom: 200px;
+}
+
+.row {
+ display: flex;
+ position: relative;
+ margin: 0 -10px;
+}
+.row:after {
+ visibility: hidden;
+ display: block;
+ content: "";
+ clear: both;
+ height: 0;
+}
+
+.col, .col-11, .col-10, .col-9, .col-8, .col-7, .col-6, .col-5, .col-4, .col-3, .col-2, .col-1 {
+ box-sizing: border-box;
+ float: left;
+ padding: 0 10px;
+}
+
+.col-1 {
+ width: 8.3333333333%;
+}
+
+.offset-1 {
+ margin-left: 8.3333333333%;
+}
+
+.col-2 {
+ width: 16.6666666667%;
+}
+
+.offset-2 {
+ margin-left: 16.6666666667%;
+}
+
+.col-3 {
+ width: 25%;
+}
+
+.offset-3 {
+ margin-left: 25%;
+}
+
+.col-4 {
+ width: 33.3333333333%;
+}
+
+.offset-4 {
+ margin-left: 33.3333333333%;
+}
+
+.col-5 {
+ width: 41.6666666667%;
+}
+
+.offset-5 {
+ margin-left: 41.6666666667%;
+}
+
+.col-6 {
+ width: 50%;
+}
+
+.offset-6 {
+ margin-left: 50%;
+}
+
+.col-7 {
+ width: 58.3333333333%;
+}
+
+.offset-7 {
+ margin-left: 58.3333333333%;
+}
+
+.col-8 {
+ width: 66.6666666667%;
+}
+
+.offset-8 {
+ margin-left: 66.6666666667%;
+}
+
+.col-9 {
+ width: 75%;
+}
+
+.offset-9 {
+ margin-left: 75%;
+}
+
+.col-10 {
+ width: 83.3333333333%;
+}
+
+.offset-10 {
+ margin-left: 83.3333333333%;
+}
+
+.col-11 {
+ width: 91.6666666667%;
+}
+
+.offset-11 {
+ margin-left: 91.6666666667%;
+}
+
+.tsd-kind-icon {
+ display: block;
+ position: relative;
+ padding-left: 20px;
+ text-indent: -20px;
+}
+.tsd-kind-icon:before {
+ content: "";
+ display: inline-block;
+ vertical-align: middle;
+ width: 17px;
+ height: 17px;
+ margin: 0 3px 2px 0;
+ background-image: url(../images/icons.png);
+}
+@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) {
+ .tsd-kind-icon:before {
+ background-image: url(../images/icons@2x.png);
+ background-size: 238px 204px;
+ }
+}
+
+.tsd-signature.tsd-kind-icon:before {
+ background-position: 0 -153px;
+}
+
+.tsd-kind-object-literal > .tsd-kind-icon:before {
+ background-position: 0px -17px;
+}
+.tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -17px -17px;
+}
+.tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -34px -17px;
+}
+
+.tsd-kind-class > .tsd-kind-icon:before {
+ background-position: 0px -34px;
+}
+.tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -17px -34px;
+}
+.tsd-kind-class.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -34px -34px;
+}
+
+.tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before {
+ background-position: 0px -51px;
+}
+.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -17px -51px;
+}
+.tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -34px -51px;
+}
+
+.tsd-kind-interface > .tsd-kind-icon:before {
+ background-position: 0px -68px;
+}
+.tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -17px -68px;
+}
+.tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -34px -68px;
+}
+
+.tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before {
+ background-position: 0px -85px;
+}
+.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -17px -85px;
+}
+.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -34px -85px;
+}
+
+.tsd-kind-namespace > .tsd-kind-icon:before {
+ background-position: 0px -102px;
+}
+.tsd-kind-namespace.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -17px -102px;
+}
+.tsd-kind-namespace.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -34px -102px;
+}
+
+.tsd-kind-module > .tsd-kind-icon:before {
+ background-position: 0px -102px;
+}
+.tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -17px -102px;
+}
+.tsd-kind-module.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -34px -102px;
+}
+
+.tsd-kind-enum > .tsd-kind-icon:before {
+ background-position: 0px -119px;
+}
+.tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -17px -119px;
+}
+.tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -34px -119px;
+}
+
+.tsd-kind-enum-member > .tsd-kind-icon:before {
+ background-position: 0px -136px;
+}
+.tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -17px -136px;
+}
+.tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -34px -136px;
+}
+
+.tsd-kind-signature > .tsd-kind-icon:before {
+ background-position: 0px -153px;
+}
+.tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -17px -153px;
+}
+.tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -34px -153px;
+}
+
+.tsd-kind-type-alias > .tsd-kind-icon:before {
+ background-position: 0px -170px;
+}
+.tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -17px -170px;
+}
+.tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -34px -170px;
+}
+
+.tsd-kind-type-alias.tsd-has-type-parameter > .tsd-kind-icon:before {
+ background-position: 0px -187px;
+}
+.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -17px -187px;
+}
+.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -34px -187px;
+}
+
+.tsd-kind-variable > .tsd-kind-icon:before {
+ background-position: -136px -0px;
+}
+.tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -153px -0px;
+}
+.tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -0px;
+}
+.tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before {
+ background-position: -51px -0px;
+}
+.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -68px -0px;
+}
+.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -85px -0px;
+}
+.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -102px -0px;
+}
+.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -0px;
+}
+.tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before {
+ background-position: -170px -0px;
+}
+.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -187px -0px;
+}
+.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -0px;
+}
+.tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before {
+ background-position: -204px -0px;
+}
+.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -221px -0px;
+}
+
+.tsd-kind-property > .tsd-kind-icon:before {
+ background-position: -136px -0px;
+}
+.tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -153px -0px;
+}
+.tsd-kind-property.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -0px;
+}
+.tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before {
+ background-position: -51px -0px;
+}
+.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -68px -0px;
+}
+.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -85px -0px;
+}
+.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -102px -0px;
+}
+.tsd-kind-property.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -0px;
+}
+.tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before {
+ background-position: -170px -0px;
+}
+.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -187px -0px;
+}
+.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -0px;
+}
+.tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before {
+ background-position: -204px -0px;
+}
+.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -221px -0px;
+}
+
+.tsd-kind-get-signature > .tsd-kind-icon:before {
+ background-position: -136px -17px;
+}
+.tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -153px -17px;
+}
+.tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -17px;
+}
+.tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before {
+ background-position: -51px -17px;
+}
+.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -68px -17px;
+}
+.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -85px -17px;
+}
+.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -102px -17px;
+}
+.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -17px;
+}
+.tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before {
+ background-position: -170px -17px;
+}
+.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -187px -17px;
+}
+.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -17px;
+}
+.tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before {
+ background-position: -204px -17px;
+}
+.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -221px -17px;
+}
+
+.tsd-kind-set-signature > .tsd-kind-icon:before {
+ background-position: -136px -34px;
+}
+.tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -153px -34px;
+}
+.tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -34px;
+}
+.tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before {
+ background-position: -51px -34px;
+}
+.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -68px -34px;
+}
+.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -85px -34px;
+}
+.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -102px -34px;
+}
+.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -34px;
+}
+.tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before {
+ background-position: -170px -34px;
+}
+.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -187px -34px;
+}
+.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -34px;
+}
+.tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before {
+ background-position: -204px -34px;
+}
+.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -221px -34px;
+}
+
+.tsd-kind-accessor > .tsd-kind-icon:before {
+ background-position: -136px -51px;
+}
+.tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -153px -51px;
+}
+.tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -51px;
+}
+.tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before {
+ background-position: -51px -51px;
+}
+.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -68px -51px;
+}
+.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -85px -51px;
+}
+.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -102px -51px;
+}
+.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -51px;
+}
+.tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before {
+ background-position: -170px -51px;
+}
+.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -187px -51px;
+}
+.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -51px;
+}
+.tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before {
+ background-position: -204px -51px;
+}
+.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -221px -51px;
+}
+
+.tsd-kind-function > .tsd-kind-icon:before {
+ background-position: -136px -68px;
+}
+.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -153px -68px;
+}
+.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -68px;
+}
+.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before {
+ background-position: -51px -68px;
+}
+.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -68px -68px;
+}
+.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -85px -68px;
+}
+.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -102px -68px;
+}
+.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -68px;
+}
+.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before {
+ background-position: -170px -68px;
+}
+.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -187px -68px;
+}
+.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -68px;
+}
+.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before {
+ background-position: -204px -68px;
+}
+.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -221px -68px;
+}
+
+.tsd-kind-method > .tsd-kind-icon:before {
+ background-position: -136px -68px;
+}
+.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -153px -68px;
+}
+.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -68px;
+}
+.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before {
+ background-position: -51px -68px;
+}
+.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -68px -68px;
+}
+.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -85px -68px;
+}
+.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -102px -68px;
+}
+.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -68px;
+}
+.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before {
+ background-position: -170px -68px;
+}
+.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -187px -68px;
+}
+.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -68px;
+}
+.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before {
+ background-position: -204px -68px;
+}
+.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -221px -68px;
+}
+
+.tsd-kind-call-signature > .tsd-kind-icon:before {
+ background-position: -136px -68px;
+}
+.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -153px -68px;
+}
+.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -68px;
+}
+.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before {
+ background-position: -51px -68px;
+}
+.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -68px -68px;
+}
+.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -85px -68px;
+}
+.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -102px -68px;
+}
+.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -68px;
+}
+.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before {
+ background-position: -170px -68px;
+}
+.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -187px -68px;
+}
+.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -68px;
+}
+.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before {
+ background-position: -204px -68px;
+}
+.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -221px -68px;
+}
+
+.tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before {
+ background-position: -136px -85px;
+}
+.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -153px -85px;
+}
+.tsd-kind-function.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -85px;
+}
+.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before {
+ background-position: -51px -85px;
+}
+.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -68px -85px;
+}
+.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -85px -85px;
+}
+.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -102px -85px;
+}
+.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -85px;
+}
+.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before {
+ background-position: -170px -85px;
+}
+.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -187px -85px;
+}
+.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -85px;
+}
+.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before {
+ background-position: -204px -85px;
+}
+.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -221px -85px;
+}
+
+.tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before {
+ background-position: -136px -85px;
+}
+.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -153px -85px;
+}
+.tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -85px;
+}
+.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before {
+ background-position: -51px -85px;
+}
+.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -68px -85px;
+}
+.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -85px -85px;
+}
+.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -102px -85px;
+}
+.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -85px;
+}
+.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before {
+ background-position: -170px -85px;
+}
+.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -187px -85px;
+}
+.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -85px;
+}
+.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before {
+ background-position: -204px -85px;
+}
+.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -221px -85px;
+}
+
+.tsd-kind-constructor > .tsd-kind-icon:before {
+ background-position: -136px -102px;
+}
+.tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -153px -102px;
+}
+.tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -102px;
+}
+.tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before {
+ background-position: -51px -102px;
+}
+.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -68px -102px;
+}
+.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -85px -102px;
+}
+.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -102px -102px;
+}
+.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -102px;
+}
+.tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before {
+ background-position: -170px -102px;
+}
+.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -187px -102px;
+}
+.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -102px;
+}
+.tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before {
+ background-position: -204px -102px;
+}
+.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -221px -102px;
+}
+
+.tsd-kind-constructor-signature > .tsd-kind-icon:before {
+ background-position: -136px -102px;
+}
+.tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -153px -102px;
+}
+.tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -102px;
+}
+.tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before {
+ background-position: -51px -102px;
+}
+.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -68px -102px;
+}
+.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -85px -102px;
+}
+.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -102px -102px;
+}
+.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -102px;
+}
+.tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before {
+ background-position: -170px -102px;
+}
+.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -187px -102px;
+}
+.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -102px;
+}
+.tsd-kind-constructor-signature.tsd-parent-kind-interface > .tsd-kind-icon:before {
+ background-position: -204px -102px;
+}
+.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -221px -102px;
+}
+
+.tsd-kind-index-signature > .tsd-kind-icon:before {
+ background-position: -136px -119px;
+}
+.tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -153px -119px;
+}
+.tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -119px;
+}
+.tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before {
+ background-position: -51px -119px;
+}
+.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -68px -119px;
+}
+.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -85px -119px;
+}
+.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -102px -119px;
+}
+.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -119px;
+}
+.tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before {
+ background-position: -170px -119px;
+}
+.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -187px -119px;
+}
+.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -119px;
+}
+.tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before {
+ background-position: -204px -119px;
+}
+.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -221px -119px;
+}
+
+.tsd-kind-event > .tsd-kind-icon:before {
+ background-position: -136px -136px;
+}
+.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -153px -136px;
+}
+.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -136px;
+}
+.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before {
+ background-position: -51px -136px;
+}
+.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -68px -136px;
+}
+.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -85px -136px;
+}
+.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -102px -136px;
+}
+.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -136px;
+}
+.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before {
+ background-position: -170px -136px;
+}
+.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -187px -136px;
+}
+.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -136px;
+}
+.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before {
+ background-position: -204px -136px;
+}
+.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -221px -136px;
+}
+
+.tsd-is-static > .tsd-kind-icon:before {
+ background-position: -136px -153px;
+}
+.tsd-is-static.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -153px -153px;
+}
+.tsd-is-static.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -153px;
+}
+.tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before {
+ background-position: -51px -153px;
+}
+.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -68px -153px;
+}
+.tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -85px -153px;
+}
+.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -102px -153px;
+}
+.tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -153px;
+}
+.tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before {
+ background-position: -170px -153px;
+}
+.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -187px -153px;
+}
+.tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -153px;
+}
+.tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before {
+ background-position: -204px -153px;
+}
+.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -221px -153px;
+}
+
+.tsd-is-static.tsd-kind-function > .tsd-kind-icon:before {
+ background-position: -136px -170px;
+}
+.tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -153px -170px;
+}
+.tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -170px;
+}
+.tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before {
+ background-position: -51px -170px;
+}
+.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -68px -170px;
+}
+.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -85px -170px;
+}
+.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -102px -170px;
+}
+.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -170px;
+}
+.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before {
+ background-position: -170px -170px;
+}
+.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -187px -170px;
+}
+.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -170px;
+}
+.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before {
+ background-position: -204px -170px;
+}
+.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -221px -170px;
+}
+
+.tsd-is-static.tsd-kind-method > .tsd-kind-icon:before {
+ background-position: -136px -170px;
+}
+.tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -153px -170px;
+}
+.tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -170px;
+}
+.tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before {
+ background-position: -51px -170px;
+}
+.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -68px -170px;
+}
+.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -85px -170px;
+}
+.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -102px -170px;
+}
+.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -170px;
+}
+.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before {
+ background-position: -170px -170px;
+}
+.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -187px -170px;
+}
+.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -170px;
+}
+.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before {
+ background-position: -204px -170px;
+}
+.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -221px -170px;
+}
+
+.tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before {
+ background-position: -136px -170px;
+}
+.tsd-is-static.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -153px -170px;
+}
+.tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -170px;
+}
+.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before {
+ background-position: -51px -170px;
+}
+.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -68px -170px;
+}
+.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -85px -170px;
+}
+.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -102px -170px;
+}
+.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -170px;
+}
+.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before {
+ background-position: -170px -170px;
+}
+.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -187px -170px;
+}
+.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -170px;
+}
+.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before {
+ background-position: -204px -170px;
+}
+.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -221px -170px;
+}
+
+.tsd-is-static.tsd-kind-event > .tsd-kind-icon:before {
+ background-position: -136px -187px;
+}
+.tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -153px -187px;
+}
+.tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -187px;
+}
+.tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before {
+ background-position: -51px -187px;
+}
+.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -68px -187px;
+}
+.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -85px -187px;
+}
+.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -102px -187px;
+}
+.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -187px;
+}
+.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before {
+ background-position: -170px -187px;
+}
+.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before {
+ background-position: -187px -187px;
+}
+.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
+ background-position: -119px -187px;
+}
+.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before {
+ background-position: -204px -187px;
+}
+.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before {
+ background-position: -221px -187px;
+}
+
+@keyframes fade-in {
+ from {
+ opacity: 0;
+ }
+ to {
+ opacity: 1;
+ }
+}
+@keyframes fade-out {
+ from {
+ opacity: 1;
+ visibility: visible;
+ }
+ to {
+ opacity: 0;
+ }
+}
+@keyframes fade-in-delayed {
+ 0% {
+ opacity: 0;
+ }
+ 33% {
+ opacity: 0;
+ }
+ 100% {
+ opacity: 1;
+ }
+}
+@keyframes fade-out-delayed {
+ 0% {
+ opacity: 1;
+ visibility: visible;
+ }
+ 66% {
+ opacity: 0;
+ }
+ 100% {
+ opacity: 0;
+ }
+}
+@keyframes shift-to-left {
+ from {
+ transform: translate(0, 0);
+ }
+ to {
+ transform: translate(-25%, 0);
+ }
+}
+@keyframes unshift-to-left {
+ from {
+ transform: translate(-25%, 0);
+ }
+ to {
+ transform: translate(0, 0);
+ }
+}
+@keyframes pop-in-from-right {
+ from {
+ transform: translate(100%, 0);
+ }
+ to {
+ transform: translate(0, 0);
+ }
+}
+@keyframes pop-out-to-right {
+ from {
+ transform: translate(0, 0);
+ visibility: visible;
+ }
+ to {
+ transform: translate(100%, 0);
+ }
+}
+body {
+ background: #fdfdfd;
+ font-family: "Segoe UI", sans-serif;
+ font-size: 16px;
+ color: #222;
+}
+
+a {
+ color: #4da6ff;
+ text-decoration: none;
+}
+a:hover {
+ text-decoration: underline;
+}
+
+code, pre {
+ font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
+ padding: 0.2em;
+ margin: 0;
+ font-size: 14px;
+ background-color: rgba(0, 0, 0, 0.04);
+}
+
+pre {
+ padding: 10px;
+}
+pre code {
+ padding: 0;
+ font-size: 100%;
+ background-color: transparent;
+}
+
+blockquote {
+ margin: 1em 0;
+ padding-left: 1em;
+ border-left: 4px solid gray;
+}
+
+.tsd-typography {
+ line-height: 1.333em;
+}
+.tsd-typography ul {
+ list-style: square;
+ padding: 0 0 0 20px;
+ margin: 0;
+}
+.tsd-typography h4, .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, .tsd-typography h5, .tsd-typography h6 {
+ font-size: 1em;
+ margin: 0;
+}
+.tsd-typography h5, .tsd-typography h6 {
+ font-weight: normal;
+}
+.tsd-typography p, .tsd-typography ul, .tsd-typography ol {
+ margin: 1em 0;
+}
+
+@media (min-width: 901px) and (max-width: 1024px) {
+ html.default .col-content {
+ width: 72%;
+ }
+ html.default .col-menu {
+ width: 28%;
+ }
+ html.default .tsd-navigation {
+ padding-left: 10px;
+ }
+}
+@media (max-width: 900px) {
+ html.default .col-content {
+ float: none;
+ width: 100%;
+ }
+ html.default .col-menu {
+ position: fixed !important;
+ overflow: auto;
+ -webkit-overflow-scrolling: touch;
+ z-index: 1024;
+ top: 0 !important;
+ bottom: 0 !important;
+ left: auto !important;
+ right: 0 !important;
+ width: 100%;
+ padding: 20px 20px 0 0;
+ max-width: 450px;
+ visibility: hidden;
+ background-color: #fff;
+ transform: translate(100%, 0);
+ }
+ html.default .col-menu > *:last-child {
+ padding-bottom: 20px;
+ }
+ html.default .overlay {
+ content: "";
+ display: block;
+ position: fixed;
+ z-index: 1023;
+ top: 0;
+ left: 0;
+ right: 0;
+ bottom: 0;
+ background-color: rgba(0, 0, 0, 0.75);
+ visibility: hidden;
+ }
+ html.default.to-has-menu .overlay {
+ animation: fade-in 0.4s;
+ }
+ html.default.to-has-menu header,
+html.default.to-has-menu footer,
+html.default.to-has-menu .col-content {
+ animation: shift-to-left 0.4s;
+ }
+ html.default.to-has-menu .col-menu {
+ animation: pop-in-from-right 0.4s;
+ }
+ html.default.from-has-menu .overlay {
+ animation: fade-out 0.4s;
+ }
+ html.default.from-has-menu header,
+html.default.from-has-menu footer,
+html.default.from-has-menu .col-content {
+ animation: unshift-to-left 0.4s;
+ }
+ html.default.from-has-menu .col-menu {
+ animation: pop-out-to-right 0.4s;
+ }
+ html.default.has-menu body {
+ overflow: hidden;
+ }
+ html.default.has-menu .overlay {
+ visibility: visible;
+ }
+ html.default.has-menu header,
+html.default.has-menu footer,
+html.default.has-menu .col-content {
+ transform: translate(-25%, 0);
+ }
+ html.default.has-menu .col-menu {
+ visibility: visible;
+ transform: translate(0, 0);
+ }
+}
+
+.tsd-page-title {
+ padding: 70px 0 20px 0;
+ margin: 0 0 40px 0;
+ background: #fff;
+ box-shadow: 0 0 5px rgba(0, 0, 0, 0.35);
+}
+.tsd-page-title h1 {
+ margin: 0;
+}
+
+.tsd-breadcrumb {
+ margin: 0;
+ padding: 0;
+ color: #707070;
+}
+.tsd-breadcrumb a {
+ color: #707070;
+ text-decoration: none;
+}
+.tsd-breadcrumb a:hover {
+ text-decoration: underline;
+}
+.tsd-breadcrumb li {
+ display: inline;
+}
+.tsd-breadcrumb li:after {
+ content: " / ";
+}
+
+html.minimal .container {
+ margin: 0;
+}
+html.minimal .container-main {
+ padding-top: 50px;
+ padding-bottom: 0;
+}
+html.minimal .content-wrap {
+ padding-left: 300px;
+}
+html.minimal .tsd-navigation {
+ position: fixed !important;
+ overflow: auto;
+ -webkit-overflow-scrolling: touch;
+ box-sizing: border-box;
+ z-index: 1;
+ left: 0;
+ top: 40px;
+ bottom: 0;
+ width: 300px;
+ padding: 20px;
+ margin: 0;
+}
+html.minimal .tsd-member .tsd-member {
+ margin-left: 0;
+}
+html.minimal .tsd-page-toolbar {
+ position: fixed;
+ z-index: 2;
+}
+html.minimal #tsd-filter .tsd-filter-group {
+ right: 0;
+ transform: none;
+}
+html.minimal footer {
+ background-color: transparent;
+}
+html.minimal footer .container {
+ padding: 0;
+}
+html.minimal .tsd-generator {
+ padding: 0;
+}
+@media (max-width: 900px) {
+ html.minimal .tsd-navigation {
+ display: none;
+ }
+ html.minimal .content-wrap {
+ padding-left: 0;
+ }
+}
+
+dl.tsd-comment-tags {
+ overflow: hidden;
+}
+dl.tsd-comment-tags dt {
+ float: left;
+ padding: 1px 5px;
+ margin: 0 10px 0 0;
+ border-radius: 4px;
+ border: 1px solid #707070;
+ color: #707070;
+ font-size: 0.8em;
+ font-weight: normal;
+}
+dl.tsd-comment-tags dd {
+ margin: 0 0 10px 0;
+}
+dl.tsd-comment-tags dd:before, dl.tsd-comment-tags dd:after {
+ display: table;
+ content: " ";
+}
+dl.tsd-comment-tags dd pre, dl.tsd-comment-tags dd:after {
+ clear: both;
+}
+dl.tsd-comment-tags p {
+ margin: 0;
+}
+
+.tsd-panel.tsd-comment .lead {
+ font-size: 1.1em;
+ line-height: 1.333em;
+ margin-bottom: 2em;
+}
+.tsd-panel.tsd-comment .lead:last-child {
+ margin-bottom: 0;
+}
+
+.toggle-protected .tsd-is-private {
+ display: none;
+}
+
+.toggle-public .tsd-is-private,
+.toggle-public .tsd-is-protected,
+.toggle-public .tsd-is-private-protected {
+ display: none;
+}
+
+.toggle-inherited .tsd-is-inherited {
+ display: none;
+}
+
+.toggle-externals .tsd-is-external {
+ display: none;
+}
+
+#tsd-filter {
+ position: relative;
+ display: inline-block;
+ height: 40px;
+ vertical-align: bottom;
+}
+.no-filter #tsd-filter {
+ display: none;
+}
+#tsd-filter .tsd-filter-group {
+ display: inline-block;
+ height: 40px;
+ vertical-align: bottom;
+ white-space: nowrap;
+}
+#tsd-filter input {
+ display: none;
+}
+@media (max-width: 900px) {
+ #tsd-filter .tsd-filter-group {
+ display: block;
+ position: absolute;
+ top: 40px;
+ right: 20px;
+ height: auto;
+ background-color: #fff;
+ visibility: hidden;
+ transform: translate(50%, 0);
+ box-shadow: 0 0 4px rgba(0, 0, 0, 0.25);
+ }
+ .has-options #tsd-filter .tsd-filter-group {
+ visibility: visible;
+ }
+ .to-has-options #tsd-filter .tsd-filter-group {
+ animation: fade-in 0.2s;
+ }
+ .from-has-options #tsd-filter .tsd-filter-group {
+ animation: fade-out 0.2s;
+ }
+ #tsd-filter label,
+#tsd-filter .tsd-select {
+ display: block;
+ padding-right: 20px;
+ }
+}
+
+footer {
+ border-top: 1px solid #eee;
+ background-color: #fff;
+}
+footer.with-border-bottom {
+ border-bottom: 1px solid #eee;
+}
+footer .tsd-legend-group {
+ font-size: 0;
+}
+footer .tsd-legend {
+ display: inline-block;
+ width: 25%;
+ padding: 0;
+ font-size: 16px;
+ list-style: none;
+ line-height: 1.333em;
+ vertical-align: top;
+}
+@media (max-width: 900px) {
+ footer .tsd-legend {
+ width: 50%;
+ }
+}
+
+.tsd-hierarchy {
+ list-style: square;
+ padding: 0 0 0 20px;
+ margin: 0;
+}
+.tsd-hierarchy .target {
+ font-weight: bold;
+}
+
+.tsd-index-panel .tsd-index-content {
+ margin-bottom: -30px !important;
+}
+.tsd-index-panel .tsd-index-section {
+ margin-bottom: 30px !important;
+}
+.tsd-index-panel h3 {
+ margin: 0 -20px 10px -20px;
+ padding: 0 20px 10px 20px;
+ border-bottom: 1px solid #eee;
+}
+.tsd-index-panel ul.tsd-index-list {
+ -webkit-column-count: 3;
+ -moz-column-count: 3;
+ -ms-column-count: 3;
+ -o-column-count: 3;
+ column-count: 3;
+ -webkit-column-gap: 20px;
+ -moz-column-gap: 20px;
+ -ms-column-gap: 20px;
+ -o-column-gap: 20px;
+ column-gap: 20px;
+ padding: 0;
+ list-style: none;
+ line-height: 1.333em;
+}
+@media (max-width: 900px) {
+ .tsd-index-panel ul.tsd-index-list {
+ -webkit-column-count: 1;
+ -moz-column-count: 1;
+ -ms-column-count: 1;
+ -o-column-count: 1;
+ column-count: 1;
+ }
+}
+@media (min-width: 901px) and (max-width: 1024px) {
+ .tsd-index-panel ul.tsd-index-list {
+ -webkit-column-count: 2;
+ -moz-column-count: 2;
+ -ms-column-count: 2;
+ -o-column-count: 2;
+ column-count: 2;
+ }
+}
+.tsd-index-panel ul.tsd-index-list li {
+ -webkit-page-break-inside: avoid;
+ -moz-page-break-inside: avoid;
+ -ms-page-break-inside: avoid;
+ -o-page-break-inside: avoid;
+ page-break-inside: avoid;
+}
+.tsd-index-panel a,
+.tsd-index-panel .tsd-parent-kind-module a {
+ color: #9600ff;
+}
+.tsd-index-panel .tsd-parent-kind-interface a {
+ color: #647F1B;
+}
+.tsd-index-panel .tsd-parent-kind-enum a {
+ color: #937210;
+}
+.tsd-index-panel .tsd-parent-kind-class a {
+ color: #0672DE;
+}
+.tsd-index-panel .tsd-kind-module a {
+ color: #9600ff;
+}
+.tsd-index-panel .tsd-kind-interface a {
+ color: #647F1B;
+}
+.tsd-index-panel .tsd-kind-enum a {
+ color: #937210;
+}
+.tsd-index-panel .tsd-kind-class a {
+ color: #0672DE;
+}
+.tsd-index-panel .tsd-is-private a {
+ color: #707070;
+}
+
+.tsd-flag {
+ display: inline-block;
+ padding: 1px 5px;
+ border-radius: 4px;
+ color: #fff;
+ background-color: #707070;
+ text-indent: 0;
+ font-size: 14px;
+ font-weight: normal;
+}
+
+.tsd-anchor {
+ position: absolute;
+ top: -100px;
+}
+
+.tsd-member {
+ position: relative;
+}
+.tsd-member .tsd-anchor + h3 {
+ margin-top: 0;
+ margin-bottom: 0;
+ border-bottom: none;
+}
+.tsd-member a[data-tsd-kind] {
+ color: #9600ff;
+}
+.tsd-member a[data-tsd-kind=Interface] {
+ color: #647F1B;
+}
+.tsd-member a[data-tsd-kind=Enum] {
+ color: #937210;
+}
+.tsd-member a[data-tsd-kind=Class] {
+ color: #0672DE;
+}
+.tsd-member a[data-tsd-kind=Private] {
+ color: #707070;
+}
+
+.tsd-navigation {
+ margin: 0 0 0 40px;
+}
+.tsd-navigation a {
+ display: block;
+ padding-top: 2px;
+ padding-bottom: 2px;
+ border-left: 2px solid transparent;
+ color: #222;
+ text-decoration: none;
+ transition: border-left-color 0.1s;
+}
+.tsd-navigation a:hover {
+ text-decoration: underline;
+}
+.tsd-navigation ul {
+ margin: 0;
+ padding: 0;
+ list-style: none;
+}
+.tsd-navigation li {
+ padding: 0;
+}
+
+.tsd-navigation.primary {
+ padding-bottom: 40px;
+}
+.tsd-navigation.primary a {
+ display: block;
+ padding-top: 6px;
+ padding-bottom: 6px;
+}
+.tsd-navigation.primary ul li a {
+ padding-left: 5px;
+}
+.tsd-navigation.primary ul li li a {
+ padding-left: 25px;
+}
+.tsd-navigation.primary ul li li li a {
+ padding-left: 45px;
+}
+.tsd-navigation.primary ul li li li li a {
+ padding-left: 65px;
+}
+.tsd-navigation.primary ul li li li li li a {
+ padding-left: 85px;
+}
+.tsd-navigation.primary ul li li li li li li a {
+ padding-left: 105px;
+}
+.tsd-navigation.primary > ul {
+ border-bottom: 1px solid #eee;
+}
+.tsd-navigation.primary li {
+ border-top: 1px solid #eee;
+}
+.tsd-navigation.primary li.current > a {
+ font-weight: bold;
+}
+.tsd-navigation.primary li.label span {
+ display: block;
+ padding: 20px 0 6px 5px;
+ color: #707070;
+}
+.tsd-navigation.primary li.globals + li > span, .tsd-navigation.primary li.globals + li > a {
+ padding-top: 20px;
+}
+
+.tsd-navigation.secondary {
+ max-height: calc(100vh - 1rem - 40px);
+ overflow: auto;
+ position: -webkit-sticky;
+ position: sticky;
+ top: calc(.5rem + 40px);
+ transition: 0.3s;
+}
+.tsd-navigation.secondary.tsd-navigation--toolbar-hide {
+ max-height: calc(100vh - 1rem);
+ top: 0.5rem;
+}
+.tsd-navigation.secondary ul {
+ transition: opacity 0.2s;
+}
+.tsd-navigation.secondary ul li a {
+ padding-left: 25px;
+}
+.tsd-navigation.secondary ul li li a {
+ padding-left: 45px;
+}
+.tsd-navigation.secondary ul li li li a {
+ padding-left: 65px;
+}
+.tsd-navigation.secondary ul li li li li a {
+ padding-left: 85px;
+}
+.tsd-navigation.secondary ul li li li li li a {
+ padding-left: 105px;
+}
+.tsd-navigation.secondary ul li li li li li li a {
+ padding-left: 125px;
+}
+.tsd-navigation.secondary ul.current a {
+ border-left-color: #eee;
+}
+.tsd-navigation.secondary li.focus > a,
+.tsd-navigation.secondary ul.current li.focus > a {
+ border-left-color: #000;
+}
+.tsd-navigation.secondary li.current {
+ margin-top: 20px;
+ margin-bottom: 20px;
+ border-left-color: #eee;
+}
+.tsd-navigation.secondary li.current > a {
+ font-weight: bold;
+}
+
+@media (min-width: 901px) {
+ .menu-sticky-wrap {
+ position: static;
+ }
+}
+
+.tsd-panel {
+ margin: 20px 0;
+ padding: 20px;
+ background-color: #fff;
+ box-shadow: 0 0 4px rgba(0, 0, 0, 0.25);
+}
+.tsd-panel:empty {
+ display: none;
+}
+.tsd-panel > h1, .tsd-panel > h2, .tsd-panel > h3 {
+ margin: 1.5em -20px 10px -20px;
+ padding: 0 20px 10px 20px;
+ border-bottom: 1px solid #eee;
+}
+.tsd-panel > h1.tsd-before-signature, .tsd-panel > h2.tsd-before-signature, .tsd-panel > h3.tsd-before-signature {
+ margin-bottom: 0;
+ border-bottom: 0;
+}
+.tsd-panel table {
+ display: block;
+ width: 100%;
+ overflow: auto;
+ margin-top: 10px;
+ word-break: normal;
+ word-break: keep-all;
+}
+.tsd-panel table th {
+ font-weight: bold;
+}
+.tsd-panel table th, .tsd-panel table td {
+ padding: 6px 13px;
+ border: 1px solid #ddd;
+}
+.tsd-panel table tr {
+ background-color: #fff;
+ border-top: 1px solid #ccc;
+}
+.tsd-panel table tr:nth-child(2n) {
+ background-color: #f8f8f8;
+}
+
+.tsd-panel-group {
+ margin: 60px 0;
+}
+.tsd-panel-group > h1, .tsd-panel-group > h2, .tsd-panel-group > h3 {
+ padding-left: 20px;
+ padding-right: 20px;
+}
+
+#tsd-search {
+ transition: background-color 0.2s;
+}
+#tsd-search .title {
+ position: relative;
+ z-index: 2;
+}
+#tsd-search .field {
+ position: absolute;
+ left: 0;
+ top: 0;
+ right: 40px;
+ height: 40px;
+}
+#tsd-search .field input {
+ box-sizing: border-box;
+ position: relative;
+ top: -50px;
+ z-index: 1;
+ width: 100%;
+ padding: 0 10px;
+ opacity: 0;
+ outline: 0;
+ border: 0;
+ background: transparent;
+ color: #222;
+}
+#tsd-search .field label {
+ position: absolute;
+ overflow: hidden;
+ right: -40px;
+}
+#tsd-search .field input,
+#tsd-search .title {
+ transition: opacity 0.2s;
+}
+#tsd-search .results {
+ position: absolute;
+ visibility: hidden;
+ top: 40px;
+ width: 100%;
+ margin: 0;
+ padding: 0;
+ list-style: none;
+ box-shadow: 0 0 4px rgba(0, 0, 0, 0.25);
+}
+#tsd-search .results li {
+ padding: 0 10px;
+ background-color: #fdfdfd;
+}
+#tsd-search .results li:nth-child(even) {
+ background-color: #fff;
+}
+#tsd-search .results li.state {
+ display: none;
+}
+#tsd-search .results li.current,
+#tsd-search .results li:hover {
+ background-color: #eee;
+}
+#tsd-search .results a {
+ display: block;
+}
+#tsd-search .results a:before {
+ top: 10px;
+}
+#tsd-search .results span.parent {
+ color: #707070;
+ font-weight: normal;
+}
+#tsd-search.has-focus {
+ background-color: #eee;
+}
+#tsd-search.has-focus .field input {
+ top: 0;
+ opacity: 1;
+}
+#tsd-search.has-focus .title {
+ z-index: 0;
+ opacity: 0;
+}
+#tsd-search.has-focus .results {
+ visibility: visible;
+}
+#tsd-search.loading .results li.state.loading {
+ display: block;
+}
+#tsd-search.failure .results li.state.failure {
+ display: block;
+}
+
+.tsd-signature {
+ margin: 0 0 1em 0;
+ padding: 10px;
+ border: 1px solid #eee;
+ font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
+ font-size: 14px;
+ overflow-x: auto;
+}
+.tsd-signature.tsd-kind-icon {
+ padding-left: 30px;
+}
+.tsd-signature.tsd-kind-icon:before {
+ top: 10px;
+ left: 10px;
+}
+.tsd-panel > .tsd-signature {
+ margin-left: -20px;
+ margin-right: -20px;
+ border-width: 1px 0;
+}
+.tsd-panel > .tsd-signature.tsd-kind-icon {
+ padding-left: 40px;
+}
+.tsd-panel > .tsd-signature.tsd-kind-icon:before {
+ left: 20px;
+}
+
+.tsd-signature-symbol {
+ color: #707070;
+ font-weight: normal;
+}
+
+.tsd-signature-type {
+ font-style: italic;
+ font-weight: normal;
+}
+
+.tsd-signatures {
+ padding: 0;
+ margin: 0 0 1em 0;
+ border: 1px solid #eee;
+}
+.tsd-signatures .tsd-signature {
+ margin: 0;
+ border-width: 1px 0 0 0;
+ transition: background-color 0.1s;
+}
+.tsd-signatures .tsd-signature:first-child {
+ border-top-width: 0;
+}
+.tsd-signatures .tsd-signature.current {
+ background-color: #eee;
+}
+.tsd-signatures.active > .tsd-signature {
+ cursor: pointer;
+}
+.tsd-panel > .tsd-signatures {
+ margin-left: -20px;
+ margin-right: -20px;
+ border-width: 1px 0;
+}
+.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon {
+ padding-left: 40px;
+}
+.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before {
+ left: 20px;
+}
+.tsd-panel > a.anchor + .tsd-signatures {
+ border-top-width: 0;
+ margin-top: -20px;
+}
+
+ul.tsd-descriptions {
+ position: relative;
+ overflow: hidden;
+ padding: 0;
+ list-style: none;
+}
+ul.tsd-descriptions.active > .tsd-description {
+ display: none;
+}
+ul.tsd-descriptions.active > .tsd-description.current {
+ display: block;
+}
+ul.tsd-descriptions.active > .tsd-description.fade-in {
+ animation: fade-in-delayed 0.3s;
+}
+ul.tsd-descriptions.active > .tsd-description.fade-out {
+ animation: fade-out-delayed 0.3s;
+ position: absolute;
+ display: block;
+ top: 0;
+ left: 0;
+ right: 0;
+ opacity: 0;
+ visibility: hidden;
+}
+ul.tsd-descriptions h4, ul.tsd-descriptions .tsd-index-panel h3, .tsd-index-panel ul.tsd-descriptions h3 {
+ font-size: 16px;
+ margin: 1em 0 0.5em 0;
+}
+
+ul.tsd-parameters,
+ul.tsd-type-parameters {
+ list-style: square;
+ margin: 0;
+ padding-left: 20px;
+}
+ul.tsd-parameters > li.tsd-parameter-signature,
+ul.tsd-type-parameters > li.tsd-parameter-signature {
+ list-style: none;
+ margin-left: -20px;
+}
+ul.tsd-parameters h5,
+ul.tsd-type-parameters h5 {
+ font-size: 16px;
+ margin: 1em 0 0.5em 0;
+}
+ul.tsd-parameters .tsd-comment,
+ul.tsd-type-parameters .tsd-comment {
+ margin-top: -0.5em;
+}
+
+.tsd-sources {
+ font-size: 14px;
+ color: #707070;
+ margin: 0 0 1em 0;
+}
+.tsd-sources a {
+ color: #707070;
+ text-decoration: underline;
+}
+.tsd-sources ul, .tsd-sources p {
+ margin: 0 !important;
+}
+.tsd-sources ul {
+ list-style: none;
+ padding: 0;
+}
+
+.tsd-page-toolbar {
+ position: fixed;
+ z-index: 1;
+ top: 0;
+ left: 0;
+ width: 100%;
+ height: 40px;
+ color: #333;
+ background: #fff;
+ border-bottom: 1px solid #eee;
+ transition: transform 0.3s linear;
+}
+.tsd-page-toolbar a {
+ color: #333;
+ text-decoration: none;
+}
+.tsd-page-toolbar a.title {
+ font-weight: bold;
+}
+.tsd-page-toolbar a.title:hover {
+ text-decoration: underline;
+}
+.tsd-page-toolbar .table-wrap {
+ display: table;
+ width: 100%;
+ height: 40px;
+}
+.tsd-page-toolbar .table-cell {
+ display: table-cell;
+ position: relative;
+ white-space: nowrap;
+ line-height: 40px;
+}
+.tsd-page-toolbar .table-cell:first-child {
+ width: 100%;
+}
+
+.tsd-page-toolbar--hide {
+ transform: translateY(-100%);
+}
+
+.tsd-select .tsd-select-list li:before, .tsd-select .tsd-select-label:before, .tsd-widget:before {
+ content: "";
+ display: inline-block;
+ width: 40px;
+ height: 40px;
+ margin: 0 -8px 0 0;
+ background-image: url(../images/widgets.png);
+ background-repeat: no-repeat;
+ text-indent: -1024px;
+ vertical-align: bottom;
+}
+@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) {
+ .tsd-select .tsd-select-list li:before, .tsd-select .tsd-select-label:before, .tsd-widget:before {
+ background-image: url(../images/widgets@2x.png);
+ background-size: 320px 40px;
+ }
+}
+
+.tsd-widget {
+ display: inline-block;
+ overflow: hidden;
+ opacity: 0.6;
+ height: 40px;
+ transition: opacity 0.1s, background-color 0.2s;
+ vertical-align: bottom;
+ cursor: pointer;
+}
+.tsd-widget:hover {
+ opacity: 0.8;
+}
+.tsd-widget.active {
+ opacity: 1;
+ background-color: #eee;
+}
+.tsd-widget.no-caption {
+ width: 40px;
+}
+.tsd-widget.no-caption:before {
+ margin: 0;
+}
+.tsd-widget.search:before {
+ background-position: 0 0;
+}
+.tsd-widget.menu:before {
+ background-position: -40px 0;
+}
+.tsd-widget.options:before {
+ background-position: -80px 0;
+}
+.tsd-widget.options, .tsd-widget.menu {
+ display: none;
+}
+@media (max-width: 900px) {
+ .tsd-widget.options, .tsd-widget.menu {
+ display: inline-block;
+ }
+}
+input[type=checkbox] + .tsd-widget:before {
+ background-position: -120px 0;
+}
+input[type=checkbox]:checked + .tsd-widget:before {
+ background-position: -160px 0;
+}
+
+.tsd-select {
+ position: relative;
+ display: inline-block;
+ height: 40px;
+ transition: opacity 0.1s, background-color 0.2s;
+ vertical-align: bottom;
+ cursor: pointer;
+}
+.tsd-select .tsd-select-label {
+ opacity: 0.6;
+ transition: opacity 0.2s;
+}
+.tsd-select .tsd-select-label:before {
+ background-position: -240px 0;
+}
+.tsd-select.active .tsd-select-label {
+ opacity: 0.8;
+}
+.tsd-select.active .tsd-select-list {
+ visibility: visible;
+ opacity: 1;
+ transition-delay: 0s;
+}
+.tsd-select .tsd-select-list {
+ position: absolute;
+ visibility: hidden;
+ top: 40px;
+ left: 0;
+ margin: 0;
+ padding: 0;
+ opacity: 0;
+ list-style: none;
+ box-shadow: 0 0 4px rgba(0, 0, 0, 0.25);
+ transition: visibility 0s 0.2s, opacity 0.2s;
+}
+.tsd-select .tsd-select-list li {
+ padding: 0 20px 0 0;
+ background-color: #fdfdfd;
+}
+.tsd-select .tsd-select-list li:before {
+ background-position: 40px 0;
+}
+.tsd-select .tsd-select-list li:nth-child(even) {
+ background-color: #fff;
+}
+.tsd-select .tsd-select-list li:hover {
+ background-color: #eee;
+}
+.tsd-select .tsd-select-list li.selected:before {
+ background-position: -200px 0;
+}
+@media (max-width: 900px) {
+ .tsd-select .tsd-select-list {
+ top: 0;
+ left: auto;
+ right: 100%;
+ margin-right: -5px;
+ }
+ .tsd-select .tsd-select-label:before {
+ background-position: -280px 0;
+ }
+}
+
+img {
+ max-width: 100%;
+}
--- /dev/null
+/*
+ * ATTENTION: The "eval" devtool has been used (maybe by default in mode: "development").
+ * This devtool is not neither made for production nor for readable output files.
+ * It uses "eval()" calls to create a separate source file in the browser devtools.
+ * If you are trying to read the output file, select a different devtool (https://webpack.js.org/configuration/devtool/)
+ * or disable the default devtool with "devtool: false".
+ * If you are looking for production-ready output files, see mode: "production" (https://webpack.js.org/configuration/mode/).
+ */
+/******/ (() => { // webpackBootstrap
+/******/ var __webpack_modules__ = ({
+
+/***/ "../node_modules/lunr/lunr.js":
+/*!************************************!*\
+ !*** ../node_modules/lunr/lunr.js ***!
+ \************************************/
+/***/ ((module, exports, __webpack_require__) => {
+
+eval("var __WEBPACK_AMD_DEFINE_FACTORY__, __WEBPACK_AMD_DEFINE_RESULT__;/**\n * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9\n * Copyright (C) 2020 Oliver Nightingale\n * @license MIT\n */\n\n;(function(){\n\n/**\n * A convenience function for configuring and constructing\n * a new lunr Index.\n *\n * A lunr.Builder instance is created and the pipeline setup\n * with a trimmer, stop word filter and stemmer.\n *\n * This builder object is yielded to the configuration function\n * that is passed as a parameter, allowing the list of fields\n * and other builder parameters to be customised.\n *\n * All documents _must_ be added within the passed config function.\n *\n * @example\n * var idx = lunr(function () {\n * this.field('title')\n * this.field('body')\n * this.ref('id')\n *\n * documents.forEach(function (doc) {\n * this.add(doc)\n * }, this)\n * })\n *\n * @see {@link lunr.Builder}\n * @see {@link lunr.Pipeline}\n * @see {@link lunr.trimmer}\n * @see {@link lunr.stopWordFilter}\n * @see {@link lunr.stemmer}\n * @namespace {function} lunr\n */\nvar lunr = function (config) {\n var builder = new lunr.Builder\n\n builder.pipeline.add(\n lunr.trimmer,\n lunr.stopWordFilter,\n lunr.stemmer\n )\n\n builder.searchPipeline.add(\n lunr.stemmer\n )\n\n config.call(builder, builder)\n return builder.build()\n}\n\nlunr.version = \"2.3.9\"\n/*!\n * lunr.utils\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A namespace containing utils for the rest of the lunr library\n * @namespace lunr.utils\n */\nlunr.utils = {}\n\n/**\n * Print a warning message to the console.\n *\n * @param {String} message The message to be printed.\n * @memberOf lunr.utils\n * @function\n */\nlunr.utils.warn = (function (global) {\n /* eslint-disable no-console */\n return function (message) {\n if (global.console && console.warn) {\n console.warn(message)\n }\n }\n /* eslint-enable no-console */\n})(this)\n\n/**\n * Convert an object to a string.\n *\n * In the case of `null` and `undefined` the function returns\n * the empty string, in all other cases the result of calling\n * `toString` on the passed object is returned.\n *\n * @param {Any} obj The object to convert to a string.\n * @return {String} string representation of the passed object.\n * @memberOf lunr.utils\n */\nlunr.utils.asString = function (obj) {\n if (obj === void 0 || obj === null) {\n return \"\"\n } else {\n return obj.toString()\n }\n}\n\n/**\n * Clones an object.\n *\n * Will create a copy of an existing object such that any mutations\n * on the copy cannot affect the original.\n *\n * Only shallow objects are supported, passing a nested object to this\n * function will cause a TypeError.\n *\n * Objects with primitives, and arrays of primitives are supported.\n *\n * @param {Object} obj The object to clone.\n * @return {Object} a clone of the passed object.\n * @throws {TypeError} when a nested object is passed.\n * @memberOf Utils\n */\nlunr.utils.clone = function (obj) {\n if (obj === null || obj === undefined) {\n return obj\n }\n\n var clone = Object.create(null),\n keys = Object.keys(obj)\n\n for (var i = 0; i < keys.length; i++) {\n var key = keys[i],\n val = obj[key]\n\n if (Array.isArray(val)) {\n clone[key] = val.slice()\n continue\n }\n\n if (typeof val === 'string' ||\n typeof val === 'number' ||\n typeof val === 'boolean') {\n clone[key] = val\n continue\n }\n\n throw new TypeError(\"clone is not deep and does not support nested objects\")\n }\n\n return clone\n}\nlunr.FieldRef = function (docRef, fieldName, stringValue) {\n this.docRef = docRef\n this.fieldName = fieldName\n this._stringValue = stringValue\n}\n\nlunr.FieldRef.joiner = \"/\"\n\nlunr.FieldRef.fromString = function (s) {\n var n = s.indexOf(lunr.FieldRef.joiner)\n\n if (n === -1) {\n throw \"malformed field ref string\"\n }\n\n var fieldRef = s.slice(0, n),\n docRef = s.slice(n + 1)\n\n return new lunr.FieldRef (docRef, fieldRef, s)\n}\n\nlunr.FieldRef.prototype.toString = function () {\n if (this._stringValue == undefined) {\n this._stringValue = this.fieldName + lunr.FieldRef.joiner + this.docRef\n }\n\n return this._stringValue\n}\n/*!\n * lunr.Set\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A lunr set.\n *\n * @constructor\n */\nlunr.Set = function (elements) {\n this.elements = Object.create(null)\n\n if (elements) {\n this.length = elements.length\n\n for (var i = 0; i < this.length; i++) {\n this.elements[elements[i]] = true\n }\n } else {\n this.length = 0\n }\n}\n\n/**\n * A complete set that contains all elements.\n *\n * @static\n * @readonly\n * @type {lunr.Set}\n */\nlunr.Set.complete = {\n intersect: function (other) {\n return other\n },\n\n union: function () {\n return this\n },\n\n contains: function () {\n return true\n }\n}\n\n/**\n * An empty set that contains no elements.\n *\n * @static\n * @readonly\n * @type {lunr.Set}\n */\nlunr.Set.empty = {\n intersect: function () {\n return this\n },\n\n union: function (other) {\n return other\n },\n\n contains: function () {\n return false\n }\n}\n\n/**\n * Returns true if this set contains the specified object.\n *\n * @param {object} object - Object whose presence in this set is to be tested.\n * @returns {boolean} - True if this set contains the specified object.\n */\nlunr.Set.prototype.contains = function (object) {\n return !!this.elements[object]\n}\n\n/**\n * Returns a new set containing only the elements that are present in both\n * this set and the specified set.\n *\n * @param {lunr.Set} other - set to intersect with this set.\n * @returns {lunr.Set} a new set that is the intersection of this and the specified set.\n */\n\nlunr.Set.prototype.intersect = function (other) {\n var a, b, elements, intersection = []\n\n if (other === lunr.Set.complete) {\n return this\n }\n\n if (other === lunr.Set.empty) {\n return other\n }\n\n if (this.length < other.length) {\n a = this\n b = other\n } else {\n a = other\n b = this\n }\n\n elements = Object.keys(a.elements)\n\n for (var i = 0; i < elements.length; i++) {\n var element = elements[i]\n if (element in b.elements) {\n intersection.push(element)\n }\n }\n\n return new lunr.Set (intersection)\n}\n\n/**\n * Returns a new set combining the elements of this and the specified set.\n *\n * @param {lunr.Set} other - set to union with this set.\n * @return {lunr.Set} a new set that is the union of this and the specified set.\n */\n\nlunr.Set.prototype.union = function (other) {\n if (other === lunr.Set.complete) {\n return lunr.Set.complete\n }\n\n if (other === lunr.Set.empty) {\n return this\n }\n\n return new lunr.Set(Object.keys(this.elements).concat(Object.keys(other.elements)))\n}\n/**\n * A function to calculate the inverse document frequency for\n * a posting. This is shared between the builder and the index\n *\n * @private\n * @param {object} posting - The posting for a given term\n * @param {number} documentCount - The total number of documents.\n */\nlunr.idf = function (posting, documentCount) {\n var documentsWithTerm = 0\n\n for (var fieldName in posting) {\n if (fieldName == '_index') continue // Ignore the term index, its not a field\n documentsWithTerm += Object.keys(posting[fieldName]).length\n }\n\n var x = (documentCount - documentsWithTerm + 0.5) / (documentsWithTerm + 0.5)\n\n return Math.log(1 + Math.abs(x))\n}\n\n/**\n * A token wraps a string representation of a token\n * as it is passed through the text processing pipeline.\n *\n * @constructor\n * @param {string} [str=''] - The string token being wrapped.\n * @param {object} [metadata={}] - Metadata associated with this token.\n */\nlunr.Token = function (str, metadata) {\n this.str = str || \"\"\n this.metadata = metadata || {}\n}\n\n/**\n * Returns the token string that is being wrapped by this object.\n *\n * @returns {string}\n */\nlunr.Token.prototype.toString = function () {\n return this.str\n}\n\n/**\n * A token update function is used when updating or optionally\n * when cloning a token.\n *\n * @callback lunr.Token~updateFunction\n * @param {string} str - The string representation of the token.\n * @param {Object} metadata - All metadata associated with this token.\n */\n\n/**\n * Applies the given function to the wrapped string token.\n *\n * @example\n * token.update(function (str, metadata) {\n * return str.toUpperCase()\n * })\n *\n * @param {lunr.Token~updateFunction} fn - A function to apply to the token string.\n * @returns {lunr.Token}\n */\nlunr.Token.prototype.update = function (fn) {\n this.str = fn(this.str, this.metadata)\n return this\n}\n\n/**\n * Creates a clone of this token. Optionally a function can be\n * applied to the cloned token.\n *\n * @param {lunr.Token~updateFunction} [fn] - An optional function to apply to the cloned token.\n * @returns {lunr.Token}\n */\nlunr.Token.prototype.clone = function (fn) {\n fn = fn || function (s) { return s }\n return new lunr.Token (fn(this.str, this.metadata), this.metadata)\n}\n/*!\n * lunr.tokenizer\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A function for splitting a string into tokens ready to be inserted into\n * the search index. Uses `lunr.tokenizer.separator` to split strings, change\n * the value of this property to change how strings are split into tokens.\n *\n * This tokenizer will convert its parameter to a string by calling `toString` and\n * then will split this string on the character in `lunr.tokenizer.separator`.\n * Arrays will have their elements converted to strings and wrapped in a lunr.Token.\n *\n * Optional metadata can be passed to the tokenizer, this metadata will be cloned and\n * added as metadata to every token that is created from the object to be tokenized.\n *\n * @static\n * @param {?(string|object|object[])} obj - The object to convert into tokens\n * @param {?object} metadata - Optional metadata to associate with every token\n * @returns {lunr.Token[]}\n * @see {@link lunr.Pipeline}\n */\nlunr.tokenizer = function (obj, metadata) {\n if (obj == null || obj == undefined) {\n return []\n }\n\n if (Array.isArray(obj)) {\n return obj.map(function (t) {\n return new lunr.Token(\n lunr.utils.asString(t).toLowerCase(),\n lunr.utils.clone(metadata)\n )\n })\n }\n\n var str = obj.toString().toLowerCase(),\n len = str.length,\n tokens = []\n\n for (var sliceEnd = 0, sliceStart = 0; sliceEnd <= len; sliceEnd++) {\n var char = str.charAt(sliceEnd),\n sliceLength = sliceEnd - sliceStart\n\n if ((char.match(lunr.tokenizer.separator) || sliceEnd == len)) {\n\n if (sliceLength > 0) {\n var tokenMetadata = lunr.utils.clone(metadata) || {}\n tokenMetadata[\"position\"] = [sliceStart, sliceLength]\n tokenMetadata[\"index\"] = tokens.length\n\n tokens.push(\n new lunr.Token (\n str.slice(sliceStart, sliceEnd),\n tokenMetadata\n )\n )\n }\n\n sliceStart = sliceEnd + 1\n }\n\n }\n\n return tokens\n}\n\n/**\n * The separator used to split a string into tokens. Override this property to change the behaviour of\n * `lunr.tokenizer` behaviour when tokenizing strings. By default this splits on whitespace and hyphens.\n *\n * @static\n * @see lunr.tokenizer\n */\nlunr.tokenizer.separator = /[\\s\\-]+/\n/*!\n * lunr.Pipeline\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.Pipelines maintain an ordered list of functions to be applied to all\n * tokens in documents entering the search index and queries being ran against\n * the index.\n *\n * An instance of lunr.Index created with the lunr shortcut will contain a\n * pipeline with a stop word filter and an English language stemmer. Extra\n * functions can be added before or after either of these functions or these\n * default functions can be removed.\n *\n * When run the pipeline will call each function in turn, passing a token, the\n * index of that token in the original list of all tokens and finally a list of\n * all the original tokens.\n *\n * The output of functions in the pipeline will be passed to the next function\n * in the pipeline. To exclude a token from entering the index the function\n * should return undefined, the rest of the pipeline will not be called with\n * this token.\n *\n * For serialisation of pipelines to work, all functions used in an instance of\n * a pipeline should be registered with lunr.Pipeline. Registered functions can\n * then be loaded. If trying to load a serialised pipeline that uses functions\n * that are not registered an error will be thrown.\n *\n * If not planning on serialising the pipeline then registering pipeline functions\n * is not necessary.\n *\n * @constructor\n */\nlunr.Pipeline = function () {\n this._stack = []\n}\n\nlunr.Pipeline.registeredFunctions = Object.create(null)\n\n/**\n * A pipeline function maps lunr.Token to lunr.Token. A lunr.Token contains the token\n * string as well as all known metadata. A pipeline function can mutate the token string\n * or mutate (or add) metadata for a given token.\n *\n * A pipeline function can indicate that the passed token should be discarded by returning\n * null, undefined or an empty string. This token will not be passed to any downstream pipeline\n * functions and will not be added to the index.\n *\n * Multiple tokens can be returned by returning an array of tokens. Each token will be passed\n * to any downstream pipeline functions and all will returned tokens will be added to the index.\n *\n * Any number of pipeline functions may be chained together using a lunr.Pipeline.\n *\n * @interface lunr.PipelineFunction\n * @param {lunr.Token} token - A token from the document being processed.\n * @param {number} i - The index of this token in the complete list of tokens for this document/field.\n * @param {lunr.Token[]} tokens - All tokens for this document/field.\n * @returns {(?lunr.Token|lunr.Token[])}\n */\n\n/**\n * Register a function with the pipeline.\n *\n * Functions that are used in the pipeline should be registered if the pipeline\n * needs to be serialised, or a serialised pipeline needs to be loaded.\n *\n * Registering a function does not add it to a pipeline, functions must still be\n * added to instances of the pipeline for them to be used when running a pipeline.\n *\n * @param {lunr.PipelineFunction} fn - The function to check for.\n * @param {String} label - The label to register this function with\n */\nlunr.Pipeline.registerFunction = function (fn, label) {\n if (label in this.registeredFunctions) {\n lunr.utils.warn('Overwriting existing registered function: ' + label)\n }\n\n fn.label = label\n lunr.Pipeline.registeredFunctions[fn.label] = fn\n}\n\n/**\n * Warns if the function is not registered as a Pipeline function.\n *\n * @param {lunr.PipelineFunction} fn - The function to check for.\n * @private\n */\nlunr.Pipeline.warnIfFunctionNotRegistered = function (fn) {\n var isRegistered = fn.label && (fn.label in this.registeredFunctions)\n\n if (!isRegistered) {\n lunr.utils.warn('Function is not registered with pipeline. This may cause problems when serialising the index.\\n', fn)\n }\n}\n\n/**\n * Loads a previously serialised pipeline.\n *\n * All functions to be loaded must already be registered with lunr.Pipeline.\n * If any function from the serialised data has not been registered then an\n * error will be thrown.\n *\n * @param {Object} serialised - The serialised pipeline to load.\n * @returns {lunr.Pipeline}\n */\nlunr.Pipeline.load = function (serialised) {\n var pipeline = new lunr.Pipeline\n\n serialised.forEach(function (fnName) {\n var fn = lunr.Pipeline.registeredFunctions[fnName]\n\n if (fn) {\n pipeline.add(fn)\n } else {\n throw new Error('Cannot load unregistered function: ' + fnName)\n }\n })\n\n return pipeline\n}\n\n/**\n * Adds new functions to the end of the pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction[]} functions - Any number of functions to add to the pipeline.\n */\nlunr.Pipeline.prototype.add = function () {\n var fns = Array.prototype.slice.call(arguments)\n\n fns.forEach(function (fn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(fn)\n this._stack.push(fn)\n }, this)\n}\n\n/**\n * Adds a single function after a function that already exists in the\n * pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline.\n * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline.\n */\nlunr.Pipeline.prototype.after = function (existingFn, newFn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(newFn)\n\n var pos = this._stack.indexOf(existingFn)\n if (pos == -1) {\n throw new Error('Cannot find existingFn')\n }\n\n pos = pos + 1\n this._stack.splice(pos, 0, newFn)\n}\n\n/**\n * Adds a single function before a function that already exists in the\n * pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline.\n * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline.\n */\nlunr.Pipeline.prototype.before = function (existingFn, newFn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(newFn)\n\n var pos = this._stack.indexOf(existingFn)\n if (pos == -1) {\n throw new Error('Cannot find existingFn')\n }\n\n this._stack.splice(pos, 0, newFn)\n}\n\n/**\n * Removes a function from the pipeline.\n *\n * @param {lunr.PipelineFunction} fn The function to remove from the pipeline.\n */\nlunr.Pipeline.prototype.remove = function (fn) {\n var pos = this._stack.indexOf(fn)\n if (pos == -1) {\n return\n }\n\n this._stack.splice(pos, 1)\n}\n\n/**\n * Runs the current list of functions that make up the pipeline against the\n * passed tokens.\n *\n * @param {Array} tokens The tokens to run through the pipeline.\n * @returns {Array}\n */\nlunr.Pipeline.prototype.run = function (tokens) {\n var stackLength = this._stack.length\n\n for (var i = 0; i < stackLength; i++) {\n var fn = this._stack[i]\n var memo = []\n\n for (var j = 0; j < tokens.length; j++) {\n var result = fn(tokens[j], j, tokens)\n\n if (result === null || result === void 0 || result === '') continue\n\n if (Array.isArray(result)) {\n for (var k = 0; k < result.length; k++) {\n memo.push(result[k])\n }\n } else {\n memo.push(result)\n }\n }\n\n tokens = memo\n }\n\n return tokens\n}\n\n/**\n * Convenience method for passing a string through a pipeline and getting\n * strings out. This method takes care of wrapping the passed string in a\n * token and mapping the resulting tokens back to strings.\n *\n * @param {string} str - The string to pass through the pipeline.\n * @param {?object} metadata - Optional metadata to associate with the token\n * passed to the pipeline.\n * @returns {string[]}\n */\nlunr.Pipeline.prototype.runString = function (str, metadata) {\n var token = new lunr.Token (str, metadata)\n\n return this.run([token]).map(function (t) {\n return t.toString()\n })\n}\n\n/**\n * Resets the pipeline by removing any existing processors.\n *\n */\nlunr.Pipeline.prototype.reset = function () {\n this._stack = []\n}\n\n/**\n * Returns a representation of the pipeline ready for serialisation.\n *\n * Logs a warning if the function has not been registered.\n *\n * @returns {Array}\n */\nlunr.Pipeline.prototype.toJSON = function () {\n return this._stack.map(function (fn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(fn)\n\n return fn.label\n })\n}\n/*!\n * lunr.Vector\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A vector is used to construct the vector space of documents and queries. These\n * vectors support operations to determine the similarity between two documents or\n * a document and a query.\n *\n * Normally no parameters are required for initializing a vector, but in the case of\n * loading a previously dumped vector the raw elements can be provided to the constructor.\n *\n * For performance reasons vectors are implemented with a flat array, where an elements\n * index is immediately followed by its value. E.g. [index, value, index, value]. This\n * allows the underlying array to be as sparse as possible and still offer decent\n * performance when being used for vector calculations.\n *\n * @constructor\n * @param {Number[]} [elements] - The flat list of element index and element value pairs.\n */\nlunr.Vector = function (elements) {\n this._magnitude = 0\n this.elements = elements || []\n}\n\n\n/**\n * Calculates the position within the vector to insert a given index.\n *\n * This is used internally by insert and upsert. If there are duplicate indexes then\n * the position is returned as if the value for that index were to be updated, but it\n * is the callers responsibility to check whether there is a duplicate at that index\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @returns {Number}\n */\nlunr.Vector.prototype.positionForIndex = function (index) {\n // For an empty vector the tuple can be inserted at the beginning\n if (this.elements.length == 0) {\n return 0\n }\n\n var start = 0,\n end = this.elements.length / 2,\n sliceLength = end - start,\n pivotPoint = Math.floor(sliceLength / 2),\n pivotIndex = this.elements[pivotPoint * 2]\n\n while (sliceLength > 1) {\n if (pivotIndex < index) {\n start = pivotPoint\n }\n\n if (pivotIndex > index) {\n end = pivotPoint\n }\n\n if (pivotIndex == index) {\n break\n }\n\n sliceLength = end - start\n pivotPoint = start + Math.floor(sliceLength / 2)\n pivotIndex = this.elements[pivotPoint * 2]\n }\n\n if (pivotIndex == index) {\n return pivotPoint * 2\n }\n\n if (pivotIndex > index) {\n return pivotPoint * 2\n }\n\n if (pivotIndex < index) {\n return (pivotPoint + 1) * 2\n }\n}\n\n/**\n * Inserts an element at an index within the vector.\n *\n * Does not allow duplicates, will throw an error if there is already an entry\n * for this index.\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @param {Number} val - The value to be inserted into the vector.\n */\nlunr.Vector.prototype.insert = function (insertIdx, val) {\n this.upsert(insertIdx, val, function () {\n throw \"duplicate index\"\n })\n}\n\n/**\n * Inserts or updates an existing index within the vector.\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @param {Number} val - The value to be inserted into the vector.\n * @param {function} fn - A function that is called for updates, the existing value and the\n * requested value are passed as arguments\n */\nlunr.Vector.prototype.upsert = function (insertIdx, val, fn) {\n this._magnitude = 0\n var position = this.positionForIndex(insertIdx)\n\n if (this.elements[position] == insertIdx) {\n this.elements[position + 1] = fn(this.elements[position + 1], val)\n } else {\n this.elements.splice(position, 0, insertIdx, val)\n }\n}\n\n/**\n * Calculates the magnitude of this vector.\n *\n * @returns {Number}\n */\nlunr.Vector.prototype.magnitude = function () {\n if (this._magnitude) return this._magnitude\n\n var sumOfSquares = 0,\n elementsLength = this.elements.length\n\n for (var i = 1; i < elementsLength; i += 2) {\n var val = this.elements[i]\n sumOfSquares += val * val\n }\n\n return this._magnitude = Math.sqrt(sumOfSquares)\n}\n\n/**\n * Calculates the dot product of this vector and another vector.\n *\n * @param {lunr.Vector} otherVector - The vector to compute the dot product with.\n * @returns {Number}\n */\nlunr.Vector.prototype.dot = function (otherVector) {\n var dotProduct = 0,\n a = this.elements, b = otherVector.elements,\n aLen = a.length, bLen = b.length,\n aVal = 0, bVal = 0,\n i = 0, j = 0\n\n while (i < aLen && j < bLen) {\n aVal = a[i], bVal = b[j]\n if (aVal < bVal) {\n i += 2\n } else if (aVal > bVal) {\n j += 2\n } else if (aVal == bVal) {\n dotProduct += a[i + 1] * b[j + 1]\n i += 2\n j += 2\n }\n }\n\n return dotProduct\n}\n\n/**\n * Calculates the similarity between this vector and another vector.\n *\n * @param {lunr.Vector} otherVector - The other vector to calculate the\n * similarity with.\n * @returns {Number}\n */\nlunr.Vector.prototype.similarity = function (otherVector) {\n return this.dot(otherVector) / this.magnitude() || 0\n}\n\n/**\n * Converts the vector to an array of the elements within the vector.\n *\n * @returns {Number[]}\n */\nlunr.Vector.prototype.toArray = function () {\n var output = new Array (this.elements.length / 2)\n\n for (var i = 1, j = 0; i < this.elements.length; i += 2, j++) {\n output[j] = this.elements[i]\n }\n\n return output\n}\n\n/**\n * A JSON serializable representation of the vector.\n *\n * @returns {Number[]}\n */\nlunr.Vector.prototype.toJSON = function () {\n return this.elements\n}\n/* eslint-disable */\n/*!\n * lunr.stemmer\n * Copyright (C) 2020 Oliver Nightingale\n * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt\n */\n\n/**\n * lunr.stemmer is an english language stemmer, this is a JavaScript\n * implementation of the PorterStemmer taken from http://tartarus.org/~martin\n *\n * @static\n * @implements {lunr.PipelineFunction}\n * @param {lunr.Token} token - The string to stem\n * @returns {lunr.Token}\n * @see {@link lunr.Pipeline}\n * @function\n */\nlunr.stemmer = (function(){\n var step2list = {\n \"ational\" : \"ate\",\n \"tional\" : \"tion\",\n \"enci\" : \"ence\",\n \"anci\" : \"ance\",\n \"izer\" : \"ize\",\n \"bli\" : \"ble\",\n \"alli\" : \"al\",\n \"entli\" : \"ent\",\n \"eli\" : \"e\",\n \"ousli\" : \"ous\",\n \"ization\" : \"ize\",\n \"ation\" : \"ate\",\n \"ator\" : \"ate\",\n \"alism\" : \"al\",\n \"iveness\" : \"ive\",\n \"fulness\" : \"ful\",\n \"ousness\" : \"ous\",\n \"aliti\" : \"al\",\n \"iviti\" : \"ive\",\n \"biliti\" : \"ble\",\n \"logi\" : \"log\"\n },\n\n step3list = {\n \"icate\" : \"ic\",\n \"ative\" : \"\",\n \"alize\" : \"al\",\n \"iciti\" : \"ic\",\n \"ical\" : \"ic\",\n \"ful\" : \"\",\n \"ness\" : \"\"\n },\n\n c = \"[^aeiou]\", // consonant\n v = \"[aeiouy]\", // vowel\n C = c + \"[^aeiouy]*\", // consonant sequence\n V = v + \"[aeiou]*\", // vowel sequence\n\n mgr0 = \"^(\" + C + \")?\" + V + C, // [C]VC... is m>0\n meq1 = \"^(\" + C + \")?\" + V + C + \"(\" + V + \")?$\", // [C]VC[V] is m=1\n mgr1 = \"^(\" + C + \")?\" + V + C + V + C, // [C]VCVC... is m>1\n s_v = \"^(\" + C + \")?\" + v; // vowel in stem\n\n var re_mgr0 = new RegExp(mgr0);\n var re_mgr1 = new RegExp(mgr1);\n var re_meq1 = new RegExp(meq1);\n var re_s_v = new RegExp(s_v);\n\n var re_1a = /^(.+?)(ss|i)es$/;\n var re2_1a = /^(.+?)([^s])s$/;\n var re_1b = /^(.+?)eed$/;\n var re2_1b = /^(.+?)(ed|ing)$/;\n var re_1b_2 = /.$/;\n var re2_1b_2 = /(at|bl|iz)$/;\n var re3_1b_2 = new RegExp(\"([^aeiouylsz])\\\\1$\");\n var re4_1b_2 = new RegExp(\"^\" + C + v + \"[^aeiouwxy]$\");\n\n var re_1c = /^(.+?[^aeiou])y$/;\n var re_2 = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;\n\n var re_3 = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;\n\n var re_4 = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;\n var re2_4 = /^(.+?)(s|t)(ion)$/;\n\n var re_5 = /^(.+?)e$/;\n var re_5_1 = /ll$/;\n var re3_5 = new RegExp(\"^\" + C + v + \"[^aeiouwxy]$\");\n\n var porterStemmer = function porterStemmer(w) {\n var stem,\n suffix,\n firstch,\n re,\n re2,\n re3,\n re4;\n\n if (w.length < 3) { return w; }\n\n firstch = w.substr(0,1);\n if (firstch == \"y\") {\n w = firstch.toUpperCase() + w.substr(1);\n }\n\n // Step 1a\n re = re_1a\n re2 = re2_1a;\n\n if (re.test(w)) { w = w.replace(re,\"$1$2\"); }\n else if (re2.test(w)) { w = w.replace(re2,\"$1$2\"); }\n\n // Step 1b\n re = re_1b;\n re2 = re2_1b;\n if (re.test(w)) {\n var fp = re.exec(w);\n re = re_mgr0;\n if (re.test(fp[1])) {\n re = re_1b_2;\n w = w.replace(re,\"\");\n }\n } else if (re2.test(w)) {\n var fp = re2.exec(w);\n stem = fp[1];\n re2 = re_s_v;\n if (re2.test(stem)) {\n w = stem;\n re2 = re2_1b_2;\n re3 = re3_1b_2;\n re4 = re4_1b_2;\n if (re2.test(w)) { w = w + \"e\"; }\n else if (re3.test(w)) { re = re_1b_2; w = w.replace(re,\"\"); }\n else if (re4.test(w)) { w = w + \"e\"; }\n }\n }\n\n // Step 1c - replace suffix y or Y by i if preceded by a non-vowel which is not the first letter of the word (so cry -> cri, by -> by, say -> say)\n re = re_1c;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n w = stem + \"i\";\n }\n\n // Step 2\n re = re_2;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n suffix = fp[2];\n re = re_mgr0;\n if (re.test(stem)) {\n w = stem + step2list[suffix];\n }\n }\n\n // Step 3\n re = re_3;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n suffix = fp[2];\n re = re_mgr0;\n if (re.test(stem)) {\n w = stem + step3list[suffix];\n }\n }\n\n // Step 4\n re = re_4;\n re2 = re2_4;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n re = re_mgr1;\n if (re.test(stem)) {\n w = stem;\n }\n } else if (re2.test(w)) {\n var fp = re2.exec(w);\n stem = fp[1] + fp[2];\n re2 = re_mgr1;\n if (re2.test(stem)) {\n w = stem;\n }\n }\n\n // Step 5\n re = re_5;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n re = re_mgr1;\n re2 = re_meq1;\n re3 = re3_5;\n if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) {\n w = stem;\n }\n }\n\n re = re_5_1;\n re2 = re_mgr1;\n if (re.test(w) && re2.test(w)) {\n re = re_1b_2;\n w = w.replace(re,\"\");\n }\n\n // and turn initial Y back to y\n\n if (firstch == \"y\") {\n w = firstch.toLowerCase() + w.substr(1);\n }\n\n return w;\n };\n\n return function (token) {\n return token.update(porterStemmer);\n }\n})();\n\nlunr.Pipeline.registerFunction(lunr.stemmer, 'stemmer')\n/*!\n * lunr.stopWordFilter\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.generateStopWordFilter builds a stopWordFilter function from the provided\n * list of stop words.\n *\n * The built in lunr.stopWordFilter is built using this generator and can be used\n * to generate custom stopWordFilters for applications or non English languages.\n *\n * @function\n * @param {Array} token The token to pass through the filter\n * @returns {lunr.PipelineFunction}\n * @see lunr.Pipeline\n * @see lunr.stopWordFilter\n */\nlunr.generateStopWordFilter = function (stopWords) {\n var words = stopWords.reduce(function (memo, stopWord) {\n memo[stopWord] = stopWord\n return memo\n }, {})\n\n return function (token) {\n if (token && words[token.toString()] !== token.toString()) return token\n }\n}\n\n/**\n * lunr.stopWordFilter is an English language stop word list filter, any words\n * contained in the list will not be passed through the filter.\n *\n * This is intended to be used in the Pipeline. If the token does not pass the\n * filter then undefined will be returned.\n *\n * @function\n * @implements {lunr.PipelineFunction}\n * @params {lunr.Token} token - A token to check for being a stop word.\n * @returns {lunr.Token}\n * @see {@link lunr.Pipeline}\n */\nlunr.stopWordFilter = lunr.generateStopWordFilter([\n 'a',\n 'able',\n 'about',\n 'across',\n 'after',\n 'all',\n 'almost',\n 'also',\n 'am',\n 'among',\n 'an',\n 'and',\n 'any',\n 'are',\n 'as',\n 'at',\n 'be',\n 'because',\n 'been',\n 'but',\n 'by',\n 'can',\n 'cannot',\n 'could',\n 'dear',\n 'did',\n 'do',\n 'does',\n 'either',\n 'else',\n 'ever',\n 'every',\n 'for',\n 'from',\n 'get',\n 'got',\n 'had',\n 'has',\n 'have',\n 'he',\n 'her',\n 'hers',\n 'him',\n 'his',\n 'how',\n 'however',\n 'i',\n 'if',\n 'in',\n 'into',\n 'is',\n 'it',\n 'its',\n 'just',\n 'least',\n 'let',\n 'like',\n 'likely',\n 'may',\n 'me',\n 'might',\n 'most',\n 'must',\n 'my',\n 'neither',\n 'no',\n 'nor',\n 'not',\n 'of',\n 'off',\n 'often',\n 'on',\n 'only',\n 'or',\n 'other',\n 'our',\n 'own',\n 'rather',\n 'said',\n 'say',\n 'says',\n 'she',\n 'should',\n 'since',\n 'so',\n 'some',\n 'than',\n 'that',\n 'the',\n 'their',\n 'them',\n 'then',\n 'there',\n 'these',\n 'they',\n 'this',\n 'tis',\n 'to',\n 'too',\n 'twas',\n 'us',\n 'wants',\n 'was',\n 'we',\n 'were',\n 'what',\n 'when',\n 'where',\n 'which',\n 'while',\n 'who',\n 'whom',\n 'why',\n 'will',\n 'with',\n 'would',\n 'yet',\n 'you',\n 'your'\n])\n\nlunr.Pipeline.registerFunction(lunr.stopWordFilter, 'stopWordFilter')\n/*!\n * lunr.trimmer\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.trimmer is a pipeline function for trimming non word\n * characters from the beginning and end of tokens before they\n * enter the index.\n *\n * This implementation may not work correctly for non latin\n * characters and should either be removed or adapted for use\n * with languages with non-latin characters.\n *\n * @static\n * @implements {lunr.PipelineFunction}\n * @param {lunr.Token} token The token to pass through the filter\n * @returns {lunr.Token}\n * @see lunr.Pipeline\n */\nlunr.trimmer = function (token) {\n return token.update(function (s) {\n return s.replace(/^\\W+/, '').replace(/\\W+$/, '')\n })\n}\n\nlunr.Pipeline.registerFunction(lunr.trimmer, 'trimmer')\n/*!\n * lunr.TokenSet\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A token set is used to store the unique list of all tokens\n * within an index. Token sets are also used to represent an\n * incoming query to the index, this query token set and index\n * token set are then intersected to find which tokens to look\n * up in the inverted index.\n *\n * A token set can hold multiple tokens, as in the case of the\n * index token set, or it can hold a single token as in the\n * case of a simple query token set.\n *\n * Additionally token sets are used to perform wildcard matching.\n * Leading, contained and trailing wildcards are supported, and\n * from this edit distance matching can also be provided.\n *\n * Token sets are implemented as a minimal finite state automata,\n * where both common prefixes and suffixes are shared between tokens.\n * This helps to reduce the space used for storing the token set.\n *\n * @constructor\n */\nlunr.TokenSet = function () {\n this.final = false\n this.edges = {}\n this.id = lunr.TokenSet._nextId\n lunr.TokenSet._nextId += 1\n}\n\n/**\n * Keeps track of the next, auto increment, identifier to assign\n * to a new tokenSet.\n *\n * TokenSets require a unique identifier to be correctly minimised.\n *\n * @private\n */\nlunr.TokenSet._nextId = 1\n\n/**\n * Creates a TokenSet instance from the given sorted array of words.\n *\n * @param {String[]} arr - A sorted array of strings to create the set from.\n * @returns {lunr.TokenSet}\n * @throws Will throw an error if the input array is not sorted.\n */\nlunr.TokenSet.fromArray = function (arr) {\n var builder = new lunr.TokenSet.Builder\n\n for (var i = 0, len = arr.length; i < len; i++) {\n builder.insert(arr[i])\n }\n\n builder.finish()\n return builder.root\n}\n\n/**\n * Creates a token set from a query clause.\n *\n * @private\n * @param {Object} clause - A single clause from lunr.Query.\n * @param {string} clause.term - The query clause term.\n * @param {number} [clause.editDistance] - The optional edit distance for the term.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.fromClause = function (clause) {\n if ('editDistance' in clause) {\n return lunr.TokenSet.fromFuzzyString(clause.term, clause.editDistance)\n } else {\n return lunr.TokenSet.fromString(clause.term)\n }\n}\n\n/**\n * Creates a token set representing a single string with a specified\n * edit distance.\n *\n * Insertions, deletions, substitutions and transpositions are each\n * treated as an edit distance of 1.\n *\n * Increasing the allowed edit distance will have a dramatic impact\n * on the performance of both creating and intersecting these TokenSets.\n * It is advised to keep the edit distance less than 3.\n *\n * @param {string} str - The string to create the token set from.\n * @param {number} editDistance - The allowed edit distance to match.\n * @returns {lunr.Vector}\n */\nlunr.TokenSet.fromFuzzyString = function (str, editDistance) {\n var root = new lunr.TokenSet\n\n var stack = [{\n node: root,\n editsRemaining: editDistance,\n str: str\n }]\n\n while (stack.length) {\n var frame = stack.pop()\n\n // no edit\n if (frame.str.length > 0) {\n var char = frame.str.charAt(0),\n noEditNode\n\n if (char in frame.node.edges) {\n noEditNode = frame.node.edges[char]\n } else {\n noEditNode = new lunr.TokenSet\n frame.node.edges[char] = noEditNode\n }\n\n if (frame.str.length == 1) {\n noEditNode.final = true\n }\n\n stack.push({\n node: noEditNode,\n editsRemaining: frame.editsRemaining,\n str: frame.str.slice(1)\n })\n }\n\n if (frame.editsRemaining == 0) {\n continue\n }\n\n // insertion\n if (\"*\" in frame.node.edges) {\n var insertionNode = frame.node.edges[\"*\"]\n } else {\n var insertionNode = new lunr.TokenSet\n frame.node.edges[\"*\"] = insertionNode\n }\n\n if (frame.str.length == 0) {\n insertionNode.final = true\n }\n\n stack.push({\n node: insertionNode,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str\n })\n\n // deletion\n // can only do a deletion if we have enough edits remaining\n // and if there are characters left to delete in the string\n if (frame.str.length > 1) {\n stack.push({\n node: frame.node,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str.slice(1)\n })\n }\n\n // deletion\n // just removing the last character from the str\n if (frame.str.length == 1) {\n frame.node.final = true\n }\n\n // substitution\n // can only do a substitution if we have enough edits remaining\n // and if there are characters left to substitute\n if (frame.str.length >= 1) {\n if (\"*\" in frame.node.edges) {\n var substitutionNode = frame.node.edges[\"*\"]\n } else {\n var substitutionNode = new lunr.TokenSet\n frame.node.edges[\"*\"] = substitutionNode\n }\n\n if (frame.str.length == 1) {\n substitutionNode.final = true\n }\n\n stack.push({\n node: substitutionNode,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str.slice(1)\n })\n }\n\n // transposition\n // can only do a transposition if there are edits remaining\n // and there are enough characters to transpose\n if (frame.str.length > 1) {\n var charA = frame.str.charAt(0),\n charB = frame.str.charAt(1),\n transposeNode\n\n if (charB in frame.node.edges) {\n transposeNode = frame.node.edges[charB]\n } else {\n transposeNode = new lunr.TokenSet\n frame.node.edges[charB] = transposeNode\n }\n\n if (frame.str.length == 1) {\n transposeNode.final = true\n }\n\n stack.push({\n node: transposeNode,\n editsRemaining: frame.editsRemaining - 1,\n str: charA + frame.str.slice(2)\n })\n }\n }\n\n return root\n}\n\n/**\n * Creates a TokenSet from a string.\n *\n * The string may contain one or more wildcard characters (*)\n * that will allow wildcard matching when intersecting with\n * another TokenSet.\n *\n * @param {string} str - The string to create a TokenSet from.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.fromString = function (str) {\n var node = new lunr.TokenSet,\n root = node\n\n /*\n * Iterates through all characters within the passed string\n * appending a node for each character.\n *\n * When a wildcard character is found then a self\n * referencing edge is introduced to continually match\n * any number of any characters.\n */\n for (var i = 0, len = str.length; i < len; i++) {\n var char = str[i],\n final = (i == len - 1)\n\n if (char == \"*\") {\n node.edges[char] = node\n node.final = final\n\n } else {\n var next = new lunr.TokenSet\n next.final = final\n\n node.edges[char] = next\n node = next\n }\n }\n\n return root\n}\n\n/**\n * Converts this TokenSet into an array of strings\n * contained within the TokenSet.\n *\n * This is not intended to be used on a TokenSet that\n * contains wildcards, in these cases the results are\n * undefined and are likely to cause an infinite loop.\n *\n * @returns {string[]}\n */\nlunr.TokenSet.prototype.toArray = function () {\n var words = []\n\n var stack = [{\n prefix: \"\",\n node: this\n }]\n\n while (stack.length) {\n var frame = stack.pop(),\n edges = Object.keys(frame.node.edges),\n len = edges.length\n\n if (frame.node.final) {\n /* In Safari, at this point the prefix is sometimes corrupted, see:\n * https://github.com/olivernn/lunr.js/issues/279 Calling any\n * String.prototype method forces Safari to \"cast\" this string to what\n * it's supposed to be, fixing the bug. */\n frame.prefix.charAt(0)\n words.push(frame.prefix)\n }\n\n for (var i = 0; i < len; i++) {\n var edge = edges[i]\n\n stack.push({\n prefix: frame.prefix.concat(edge),\n node: frame.node.edges[edge]\n })\n }\n }\n\n return words\n}\n\n/**\n * Generates a string representation of a TokenSet.\n *\n * This is intended to allow TokenSets to be used as keys\n * in objects, largely to aid the construction and minimisation\n * of a TokenSet. As such it is not designed to be a human\n * friendly representation of the TokenSet.\n *\n * @returns {string}\n */\nlunr.TokenSet.prototype.toString = function () {\n // NOTE: Using Object.keys here as this.edges is very likely\n // to enter 'hash-mode' with many keys being added\n //\n // avoiding a for-in loop here as it leads to the function\n // being de-optimised (at least in V8). From some simple\n // benchmarks the performance is comparable, but allowing\n // V8 to optimize may mean easy performance wins in the future.\n\n if (this._str) {\n return this._str\n }\n\n var str = this.final ? '1' : '0',\n labels = Object.keys(this.edges).sort(),\n len = labels.length\n\n for (var i = 0; i < len; i++) {\n var label = labels[i],\n node = this.edges[label]\n\n str = str + label + node.id\n }\n\n return str\n}\n\n/**\n * Returns a new TokenSet that is the intersection of\n * this TokenSet and the passed TokenSet.\n *\n * This intersection will take into account any wildcards\n * contained within the TokenSet.\n *\n * @param {lunr.TokenSet} b - An other TokenSet to intersect with.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.prototype.intersect = function (b) {\n var output = new lunr.TokenSet,\n frame = undefined\n\n var stack = [{\n qNode: b,\n output: output,\n node: this\n }]\n\n while (stack.length) {\n frame = stack.pop()\n\n // NOTE: As with the #toString method, we are using\n // Object.keys and a for loop instead of a for-in loop\n // as both of these objects enter 'hash' mode, causing\n // the function to be de-optimised in V8\n var qEdges = Object.keys(frame.qNode.edges),\n qLen = qEdges.length,\n nEdges = Object.keys(frame.node.edges),\n nLen = nEdges.length\n\n for (var q = 0; q < qLen; q++) {\n var qEdge = qEdges[q]\n\n for (var n = 0; n < nLen; n++) {\n var nEdge = nEdges[n]\n\n if (nEdge == qEdge || qEdge == '*') {\n var node = frame.node.edges[nEdge],\n qNode = frame.qNode.edges[qEdge],\n final = node.final && qNode.final,\n next = undefined\n\n if (nEdge in frame.output.edges) {\n // an edge already exists for this character\n // no need to create a new node, just set the finality\n // bit unless this node is already final\n next = frame.output.edges[nEdge]\n next.final = next.final || final\n\n } else {\n // no edge exists yet, must create one\n // set the finality bit and insert it\n // into the output\n next = new lunr.TokenSet\n next.final = final\n frame.output.edges[nEdge] = next\n }\n\n stack.push({\n qNode: qNode,\n output: next,\n node: node\n })\n }\n }\n }\n }\n\n return output\n}\nlunr.TokenSet.Builder = function () {\n this.previousWord = \"\"\n this.root = new lunr.TokenSet\n this.uncheckedNodes = []\n this.minimizedNodes = {}\n}\n\nlunr.TokenSet.Builder.prototype.insert = function (word) {\n var node,\n commonPrefix = 0\n\n if (word < this.previousWord) {\n throw new Error (\"Out of order word insertion\")\n }\n\n for (var i = 0; i < word.length && i < this.previousWord.length; i++) {\n if (word[i] != this.previousWord[i]) break\n commonPrefix++\n }\n\n this.minimize(commonPrefix)\n\n if (this.uncheckedNodes.length == 0) {\n node = this.root\n } else {\n node = this.uncheckedNodes[this.uncheckedNodes.length - 1].child\n }\n\n for (var i = commonPrefix; i < word.length; i++) {\n var nextNode = new lunr.TokenSet,\n char = word[i]\n\n node.edges[char] = nextNode\n\n this.uncheckedNodes.push({\n parent: node,\n char: char,\n child: nextNode\n })\n\n node = nextNode\n }\n\n node.final = true\n this.previousWord = word\n}\n\nlunr.TokenSet.Builder.prototype.finish = function () {\n this.minimize(0)\n}\n\nlunr.TokenSet.Builder.prototype.minimize = function (downTo) {\n for (var i = this.uncheckedNodes.length - 1; i >= downTo; i--) {\n var node = this.uncheckedNodes[i],\n childKey = node.child.toString()\n\n if (childKey in this.minimizedNodes) {\n node.parent.edges[node.char] = this.minimizedNodes[childKey]\n } else {\n // Cache the key for this node since\n // we know it can't change anymore\n node.child._str = childKey\n\n this.minimizedNodes[childKey] = node.child\n }\n\n this.uncheckedNodes.pop()\n }\n}\n/*!\n * lunr.Index\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * An index contains the built index of all documents and provides a query interface\n * to the index.\n *\n * Usually instances of lunr.Index will not be created using this constructor, instead\n * lunr.Builder should be used to construct new indexes, or lunr.Index.load should be\n * used to load previously built and serialized indexes.\n *\n * @constructor\n * @param {Object} attrs - The attributes of the built search index.\n * @param {Object} attrs.invertedIndex - An index of term/field to document reference.\n * @param {Object<string, lunr.Vector>} attrs.fieldVectors - Field vectors\n * @param {lunr.TokenSet} attrs.tokenSet - An set of all corpus tokens.\n * @param {string[]} attrs.fields - The names of indexed document fields.\n * @param {lunr.Pipeline} attrs.pipeline - The pipeline to use for search terms.\n */\nlunr.Index = function (attrs) {\n this.invertedIndex = attrs.invertedIndex\n this.fieldVectors = attrs.fieldVectors\n this.tokenSet = attrs.tokenSet\n this.fields = attrs.fields\n this.pipeline = attrs.pipeline\n}\n\n/**\n * A result contains details of a document matching a search query.\n * @typedef {Object} lunr.Index~Result\n * @property {string} ref - The reference of the document this result represents.\n * @property {number} score - A number between 0 and 1 representing how similar this document is to the query.\n * @property {lunr.MatchData} matchData - Contains metadata about this match including which term(s) caused the match.\n */\n\n/**\n * Although lunr provides the ability to create queries using lunr.Query, it also provides a simple\n * query language which itself is parsed into an instance of lunr.Query.\n *\n * For programmatically building queries it is advised to directly use lunr.Query, the query language\n * is best used for human entered text rather than program generated text.\n *\n * At its simplest queries can just be a single term, e.g. `hello`, multiple terms are also supported\n * and will be combined with OR, e.g `hello world` will match documents that contain either 'hello'\n * or 'world', though those that contain both will rank higher in the results.\n *\n * Wildcards can be included in terms to match one or more unspecified characters, these wildcards can\n * be inserted anywhere within the term, and more than one wildcard can exist in a single term. Adding\n * wildcards will increase the number of documents that will be found but can also have a negative\n * impact on query performance, especially with wildcards at the beginning of a term.\n *\n * Terms can be restricted to specific fields, e.g. `title:hello`, only documents with the term\n * hello in the title field will match this query. Using a field not present in the index will lead\n * to an error being thrown.\n *\n * Modifiers can also be added to terms, lunr supports edit distance and boost modifiers on terms. A term\n * boost will make documents matching that term score higher, e.g. `foo^5`. Edit distance is also supported\n * to provide fuzzy matching, e.g. 'hello~2' will match documents with hello with an edit distance of 2.\n * Avoid large values for edit distance to improve query performance.\n *\n * Each term also supports a presence modifier. By default a term's presence in document is optional, however\n * this can be changed to either required or prohibited. For a term's presence to be required in a document the\n * term should be prefixed with a '+', e.g. `+foo bar` is a search for documents that must contain 'foo' and\n * optionally contain 'bar'. Conversely a leading '-' sets the terms presence to prohibited, i.e. it must not\n * appear in a document, e.g. `-foo bar` is a search for documents that do not contain 'foo' but may contain 'bar'.\n *\n * To escape special characters the backslash character '\\' can be used, this allows searches to include\n * characters that would normally be considered modifiers, e.g. `foo\\~2` will search for a term \"foo~2\" instead\n * of attempting to apply a boost of 2 to the search term \"foo\".\n *\n * @typedef {string} lunr.Index~QueryString\n * @example <caption>Simple single term query</caption>\n * hello\n * @example <caption>Multiple term query</caption>\n * hello world\n * @example <caption>term scoped to a field</caption>\n * title:hello\n * @example <caption>term with a boost of 10</caption>\n * hello^10\n * @example <caption>term with an edit distance of 2</caption>\n * hello~2\n * @example <caption>terms with presence modifiers</caption>\n * -foo +bar baz\n */\n\n/**\n * Performs a search against the index using lunr query syntax.\n *\n * Results will be returned sorted by their score, the most relevant results\n * will be returned first. For details on how the score is calculated, please see\n * the {@link https://lunrjs.com/guides/searching.html#scoring|guide}.\n *\n * For more programmatic querying use lunr.Index#query.\n *\n * @param {lunr.Index~QueryString} queryString - A string containing a lunr query.\n * @throws {lunr.QueryParseError} If the passed query string cannot be parsed.\n * @returns {lunr.Index~Result[]}\n */\nlunr.Index.prototype.search = function (queryString) {\n return this.query(function (query) {\n var parser = new lunr.QueryParser(queryString, query)\n parser.parse()\n })\n}\n\n/**\n * A query builder callback provides a query object to be used to express\n * the query to perform on the index.\n *\n * @callback lunr.Index~queryBuilder\n * @param {lunr.Query} query - The query object to build up.\n * @this lunr.Query\n */\n\n/**\n * Performs a query against the index using the yielded lunr.Query object.\n *\n * If performing programmatic queries against the index, this method is preferred\n * over lunr.Index#search so as to avoid the additional query parsing overhead.\n *\n * A query object is yielded to the supplied function which should be used to\n * express the query to be run against the index.\n *\n * Note that although this function takes a callback parameter it is _not_ an\n * asynchronous operation, the callback is just yielded a query object to be\n * customized.\n *\n * @param {lunr.Index~queryBuilder} fn - A function that is used to build the query.\n * @returns {lunr.Index~Result[]}\n */\nlunr.Index.prototype.query = function (fn) {\n // for each query clause\n // * process terms\n // * expand terms from token set\n // * find matching documents and metadata\n // * get document vectors\n // * score documents\n\n var query = new lunr.Query(this.fields),\n matchingFields = Object.create(null),\n queryVectors = Object.create(null),\n termFieldCache = Object.create(null),\n requiredMatches = Object.create(null),\n prohibitedMatches = Object.create(null)\n\n /*\n * To support field level boosts a query vector is created per\n * field. An empty vector is eagerly created to support negated\n * queries.\n */\n for (var i = 0; i < this.fields.length; i++) {\n queryVectors[this.fields[i]] = new lunr.Vector\n }\n\n fn.call(query, query)\n\n for (var i = 0; i < query.clauses.length; i++) {\n /*\n * Unless the pipeline has been disabled for this term, which is\n * the case for terms with wildcards, we need to pass the clause\n * term through the search pipeline. A pipeline returns an array\n * of processed terms. Pipeline functions may expand the passed\n * term, which means we may end up performing multiple index lookups\n * for a single query term.\n */\n var clause = query.clauses[i],\n terms = null,\n clauseMatches = lunr.Set.empty\n\n if (clause.usePipeline) {\n terms = this.pipeline.runString(clause.term, {\n fields: clause.fields\n })\n } else {\n terms = [clause.term]\n }\n\n for (var m = 0; m < terms.length; m++) {\n var term = terms[m]\n\n /*\n * Each term returned from the pipeline needs to use the same query\n * clause object, e.g. the same boost and or edit distance. The\n * simplest way to do this is to re-use the clause object but mutate\n * its term property.\n */\n clause.term = term\n\n /*\n * From the term in the clause we create a token set which will then\n * be used to intersect the indexes token set to get a list of terms\n * to lookup in the inverted index\n */\n var termTokenSet = lunr.TokenSet.fromClause(clause),\n expandedTerms = this.tokenSet.intersect(termTokenSet).toArray()\n\n /*\n * If a term marked as required does not exist in the tokenSet it is\n * impossible for the search to return any matches. We set all the field\n * scoped required matches set to empty and stop examining any further\n * clauses.\n */\n if (expandedTerms.length === 0 && clause.presence === lunr.Query.presence.REQUIRED) {\n for (var k = 0; k < clause.fields.length; k++) {\n var field = clause.fields[k]\n requiredMatches[field] = lunr.Set.empty\n }\n\n break\n }\n\n for (var j = 0; j < expandedTerms.length; j++) {\n /*\n * For each term get the posting and termIndex, this is required for\n * building the query vector.\n */\n var expandedTerm = expandedTerms[j],\n posting = this.invertedIndex[expandedTerm],\n termIndex = posting._index\n\n for (var k = 0; k < clause.fields.length; k++) {\n /*\n * For each field that this query term is scoped by (by default\n * all fields are in scope) we need to get all the document refs\n * that have this term in that field.\n *\n * The posting is the entry in the invertedIndex for the matching\n * term from above.\n */\n var field = clause.fields[k],\n fieldPosting = posting[field],\n matchingDocumentRefs = Object.keys(fieldPosting),\n termField = expandedTerm + \"/\" + field,\n matchingDocumentsSet = new lunr.Set(matchingDocumentRefs)\n\n /*\n * if the presence of this term is required ensure that the matching\n * documents are added to the set of required matches for this clause.\n *\n */\n if (clause.presence == lunr.Query.presence.REQUIRED) {\n clauseMatches = clauseMatches.union(matchingDocumentsSet)\n\n if (requiredMatches[field] === undefined) {\n requiredMatches[field] = lunr.Set.complete\n }\n }\n\n /*\n * if the presence of this term is prohibited ensure that the matching\n * documents are added to the set of prohibited matches for this field,\n * creating that set if it does not yet exist.\n */\n if (clause.presence == lunr.Query.presence.PROHIBITED) {\n if (prohibitedMatches[field] === undefined) {\n prohibitedMatches[field] = lunr.Set.empty\n }\n\n prohibitedMatches[field] = prohibitedMatches[field].union(matchingDocumentsSet)\n\n /*\n * Prohibited matches should not be part of the query vector used for\n * similarity scoring and no metadata should be extracted so we continue\n * to the next field\n */\n continue\n }\n\n /*\n * The query field vector is populated using the termIndex found for\n * the term and a unit value with the appropriate boost applied.\n * Using upsert because there could already be an entry in the vector\n * for the term we are working with. In that case we just add the scores\n * together.\n */\n queryVectors[field].upsert(termIndex, clause.boost, function (a, b) { return a + b })\n\n /**\n * If we've already seen this term, field combo then we've already collected\n * the matching documents and metadata, no need to go through all that again\n */\n if (termFieldCache[termField]) {\n continue\n }\n\n for (var l = 0; l < matchingDocumentRefs.length; l++) {\n /*\n * All metadata for this term/field/document triple\n * are then extracted and collected into an instance\n * of lunr.MatchData ready to be returned in the query\n * results\n */\n var matchingDocumentRef = matchingDocumentRefs[l],\n matchingFieldRef = new lunr.FieldRef (matchingDocumentRef, field),\n metadata = fieldPosting[matchingDocumentRef],\n fieldMatch\n\n if ((fieldMatch = matchingFields[matchingFieldRef]) === undefined) {\n matchingFields[matchingFieldRef] = new lunr.MatchData (expandedTerm, field, metadata)\n } else {\n fieldMatch.add(expandedTerm, field, metadata)\n }\n\n }\n\n termFieldCache[termField] = true\n }\n }\n }\n\n /**\n * If the presence was required we need to update the requiredMatches field sets.\n * We do this after all fields for the term have collected their matches because\n * the clause terms presence is required in _any_ of the fields not _all_ of the\n * fields.\n */\n if (clause.presence === lunr.Query.presence.REQUIRED) {\n for (var k = 0; k < clause.fields.length; k++) {\n var field = clause.fields[k]\n requiredMatches[field] = requiredMatches[field].intersect(clauseMatches)\n }\n }\n }\n\n /**\n * Need to combine the field scoped required and prohibited\n * matching documents into a global set of required and prohibited\n * matches\n */\n var allRequiredMatches = lunr.Set.complete,\n allProhibitedMatches = lunr.Set.empty\n\n for (var i = 0; i < this.fields.length; i++) {\n var field = this.fields[i]\n\n if (requiredMatches[field]) {\n allRequiredMatches = allRequiredMatches.intersect(requiredMatches[field])\n }\n\n if (prohibitedMatches[field]) {\n allProhibitedMatches = allProhibitedMatches.union(prohibitedMatches[field])\n }\n }\n\n var matchingFieldRefs = Object.keys(matchingFields),\n results = [],\n matches = Object.create(null)\n\n /*\n * If the query is negated (contains only prohibited terms)\n * we need to get _all_ fieldRefs currently existing in the\n * index. This is only done when we know that the query is\n * entirely prohibited terms to avoid any cost of getting all\n * fieldRefs unnecessarily.\n *\n * Additionally, blank MatchData must be created to correctly\n * populate the results.\n */\n if (query.isNegated()) {\n matchingFieldRefs = Object.keys(this.fieldVectors)\n\n for (var i = 0; i < matchingFieldRefs.length; i++) {\n var matchingFieldRef = matchingFieldRefs[i]\n var fieldRef = lunr.FieldRef.fromString(matchingFieldRef)\n matchingFields[matchingFieldRef] = new lunr.MatchData\n }\n }\n\n for (var i = 0; i < matchingFieldRefs.length; i++) {\n /*\n * Currently we have document fields that match the query, but we\n * need to return documents. The matchData and scores are combined\n * from multiple fields belonging to the same document.\n *\n * Scores are calculated by field, using the query vectors created\n * above, and combined into a final document score using addition.\n */\n var fieldRef = lunr.FieldRef.fromString(matchingFieldRefs[i]),\n docRef = fieldRef.docRef\n\n if (!allRequiredMatches.contains(docRef)) {\n continue\n }\n\n if (allProhibitedMatches.contains(docRef)) {\n continue\n }\n\n var fieldVector = this.fieldVectors[fieldRef],\n score = queryVectors[fieldRef.fieldName].similarity(fieldVector),\n docMatch\n\n if ((docMatch = matches[docRef]) !== undefined) {\n docMatch.score += score\n docMatch.matchData.combine(matchingFields[fieldRef])\n } else {\n var match = {\n ref: docRef,\n score: score,\n matchData: matchingFields[fieldRef]\n }\n matches[docRef] = match\n results.push(match)\n }\n }\n\n /*\n * Sort the results objects by score, highest first.\n */\n return results.sort(function (a, b) {\n return b.score - a.score\n })\n}\n\n/**\n * Prepares the index for JSON serialization.\n *\n * The schema for this JSON blob will be described in a\n * separate JSON schema file.\n *\n * @returns {Object}\n */\nlunr.Index.prototype.toJSON = function () {\n var invertedIndex = Object.keys(this.invertedIndex)\n .sort()\n .map(function (term) {\n return [term, this.invertedIndex[term]]\n }, this)\n\n var fieldVectors = Object.keys(this.fieldVectors)\n .map(function (ref) {\n return [ref, this.fieldVectors[ref].toJSON()]\n }, this)\n\n return {\n version: lunr.version,\n fields: this.fields,\n fieldVectors: fieldVectors,\n invertedIndex: invertedIndex,\n pipeline: this.pipeline.toJSON()\n }\n}\n\n/**\n * Loads a previously serialized lunr.Index\n *\n * @param {Object} serializedIndex - A previously serialized lunr.Index\n * @returns {lunr.Index}\n */\nlunr.Index.load = function (serializedIndex) {\n var attrs = {},\n fieldVectors = {},\n serializedVectors = serializedIndex.fieldVectors,\n invertedIndex = Object.create(null),\n serializedInvertedIndex = serializedIndex.invertedIndex,\n tokenSetBuilder = new lunr.TokenSet.Builder,\n pipeline = lunr.Pipeline.load(serializedIndex.pipeline)\n\n if (serializedIndex.version != lunr.version) {\n lunr.utils.warn(\"Version mismatch when loading serialised index. Current version of lunr '\" + lunr.version + \"' does not match serialized index '\" + serializedIndex.version + \"'\")\n }\n\n for (var i = 0; i < serializedVectors.length; i++) {\n var tuple = serializedVectors[i],\n ref = tuple[0],\n elements = tuple[1]\n\n fieldVectors[ref] = new lunr.Vector(elements)\n }\n\n for (var i = 0; i < serializedInvertedIndex.length; i++) {\n var tuple = serializedInvertedIndex[i],\n term = tuple[0],\n posting = tuple[1]\n\n tokenSetBuilder.insert(term)\n invertedIndex[term] = posting\n }\n\n tokenSetBuilder.finish()\n\n attrs.fields = serializedIndex.fields\n\n attrs.fieldVectors = fieldVectors\n attrs.invertedIndex = invertedIndex\n attrs.tokenSet = tokenSetBuilder.root\n attrs.pipeline = pipeline\n\n return new lunr.Index(attrs)\n}\n/*!\n * lunr.Builder\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.Builder performs indexing on a set of documents and\n * returns instances of lunr.Index ready for querying.\n *\n * All configuration of the index is done via the builder, the\n * fields to index, the document reference, the text processing\n * pipeline and document scoring parameters are all set on the\n * builder before indexing.\n *\n * @constructor\n * @property {string} _ref - Internal reference to the document reference field.\n * @property {string[]} _fields - Internal reference to the document fields to index.\n * @property {object} invertedIndex - The inverted index maps terms to document fields.\n * @property {object} documentTermFrequencies - Keeps track of document term frequencies.\n * @property {object} documentLengths - Keeps track of the length of documents added to the index.\n * @property {lunr.tokenizer} tokenizer - Function for splitting strings into tokens for indexing.\n * @property {lunr.Pipeline} pipeline - The pipeline performs text processing on tokens before indexing.\n * @property {lunr.Pipeline} searchPipeline - A pipeline for processing search terms before querying the index.\n * @property {number} documentCount - Keeps track of the total number of documents indexed.\n * @property {number} _b - A parameter to control field length normalization, setting this to 0 disabled normalization, 1 fully normalizes field lengths, the default value is 0.75.\n * @property {number} _k1 - A parameter to control how quickly an increase in term frequency results in term frequency saturation, the default value is 1.2.\n * @property {number} termIndex - A counter incremented for each unique term, used to identify a terms position in the vector space.\n * @property {array} metadataWhitelist - A list of metadata keys that have been whitelisted for entry in the index.\n */\nlunr.Builder = function () {\n this._ref = \"id\"\n this._fields = Object.create(null)\n this._documents = Object.create(null)\n this.invertedIndex = Object.create(null)\n this.fieldTermFrequencies = {}\n this.fieldLengths = {}\n this.tokenizer = lunr.tokenizer\n this.pipeline = new lunr.Pipeline\n this.searchPipeline = new lunr.Pipeline\n this.documentCount = 0\n this._b = 0.75\n this._k1 = 1.2\n this.termIndex = 0\n this.metadataWhitelist = []\n}\n\n/**\n * Sets the document field used as the document reference. Every document must have this field.\n * The type of this field in the document should be a string, if it is not a string it will be\n * coerced into a string by calling toString.\n *\n * The default ref is 'id'.\n *\n * The ref should _not_ be changed during indexing, it should be set before any documents are\n * added to the index. Changing it during indexing can lead to inconsistent results.\n *\n * @param {string} ref - The name of the reference field in the document.\n */\nlunr.Builder.prototype.ref = function (ref) {\n this._ref = ref\n}\n\n/**\n * A function that is used to extract a field from a document.\n *\n * Lunr expects a field to be at the top level of a document, if however the field\n * is deeply nested within a document an extractor function can be used to extract\n * the right field for indexing.\n *\n * @callback fieldExtractor\n * @param {object} doc - The document being added to the index.\n * @returns {?(string|object|object[])} obj - The object that will be indexed for this field.\n * @example <caption>Extracting a nested field</caption>\n * function (doc) { return doc.nested.field }\n */\n\n/**\n * Adds a field to the list of document fields that will be indexed. Every document being\n * indexed should have this field. Null values for this field in indexed documents will\n * not cause errors but will limit the chance of that document being retrieved by searches.\n *\n * All fields should be added before adding documents to the index. Adding fields after\n * a document has been indexed will have no effect on already indexed documents.\n *\n * Fields can be boosted at build time. This allows terms within that field to have more\n * importance when ranking search results. Use a field boost to specify that matches within\n * one field are more important than other fields.\n *\n * @param {string} fieldName - The name of a field to index in all documents.\n * @param {object} attributes - Optional attributes associated with this field.\n * @param {number} [attributes.boost=1] - Boost applied to all terms within this field.\n * @param {fieldExtractor} [attributes.extractor] - Function to extract a field from a document.\n * @throws {RangeError} fieldName cannot contain unsupported characters '/'\n */\nlunr.Builder.prototype.field = function (fieldName, attributes) {\n if (/\\//.test(fieldName)) {\n throw new RangeError (\"Field '\" + fieldName + \"' contains illegal character '/'\")\n }\n\n this._fields[fieldName] = attributes || {}\n}\n\n/**\n * A parameter to tune the amount of field length normalisation that is applied when\n * calculating relevance scores. A value of 0 will completely disable any normalisation\n * and a value of 1 will fully normalise field lengths. The default is 0.75. Values of b\n * will be clamped to the range 0 - 1.\n *\n * @param {number} number - The value to set for this tuning parameter.\n */\nlunr.Builder.prototype.b = function (number) {\n if (number < 0) {\n this._b = 0\n } else if (number > 1) {\n this._b = 1\n } else {\n this._b = number\n }\n}\n\n/**\n * A parameter that controls the speed at which a rise in term frequency results in term\n * frequency saturation. The default value is 1.2. Setting this to a higher value will give\n * slower saturation levels, a lower value will result in quicker saturation.\n *\n * @param {number} number - The value to set for this tuning parameter.\n */\nlunr.Builder.prototype.k1 = function (number) {\n this._k1 = number\n}\n\n/**\n * Adds a document to the index.\n *\n * Before adding fields to the index the index should have been fully setup, with the document\n * ref and all fields to index already having been specified.\n *\n * The document must have a field name as specified by the ref (by default this is 'id') and\n * it should have all fields defined for indexing, though null or undefined values will not\n * cause errors.\n *\n * Entire documents can be boosted at build time. Applying a boost to a document indicates that\n * this document should rank higher in search results than other documents.\n *\n * @param {object} doc - The document to add to the index.\n * @param {object} attributes - Optional attributes associated with this document.\n * @param {number} [attributes.boost=1] - Boost applied to all terms within this document.\n */\nlunr.Builder.prototype.add = function (doc, attributes) {\n var docRef = doc[this._ref],\n fields = Object.keys(this._fields)\n\n this._documents[docRef] = attributes || {}\n this.documentCount += 1\n\n for (var i = 0; i < fields.length; i++) {\n var fieldName = fields[i],\n extractor = this._fields[fieldName].extractor,\n field = extractor ? extractor(doc) : doc[fieldName],\n tokens = this.tokenizer(field, {\n fields: [fieldName]\n }),\n terms = this.pipeline.run(tokens),\n fieldRef = new lunr.FieldRef (docRef, fieldName),\n fieldTerms = Object.create(null)\n\n this.fieldTermFrequencies[fieldRef] = fieldTerms\n this.fieldLengths[fieldRef] = 0\n\n // store the length of this field for this document\n this.fieldLengths[fieldRef] += terms.length\n\n // calculate term frequencies for this field\n for (var j = 0; j < terms.length; j++) {\n var term = terms[j]\n\n if (fieldTerms[term] == undefined) {\n fieldTerms[term] = 0\n }\n\n fieldTerms[term] += 1\n\n // add to inverted index\n // create an initial posting if one doesn't exist\n if (this.invertedIndex[term] == undefined) {\n var posting = Object.create(null)\n posting[\"_index\"] = this.termIndex\n this.termIndex += 1\n\n for (var k = 0; k < fields.length; k++) {\n posting[fields[k]] = Object.create(null)\n }\n\n this.invertedIndex[term] = posting\n }\n\n // add an entry for this term/fieldName/docRef to the invertedIndex\n if (this.invertedIndex[term][fieldName][docRef] == undefined) {\n this.invertedIndex[term][fieldName][docRef] = Object.create(null)\n }\n\n // store all whitelisted metadata about this token in the\n // inverted index\n for (var l = 0; l < this.metadataWhitelist.length; l++) {\n var metadataKey = this.metadataWhitelist[l],\n metadata = term.metadata[metadataKey]\n\n if (this.invertedIndex[term][fieldName][docRef][metadataKey] == undefined) {\n this.invertedIndex[term][fieldName][docRef][metadataKey] = []\n }\n\n this.invertedIndex[term][fieldName][docRef][metadataKey].push(metadata)\n }\n }\n\n }\n}\n\n/**\n * Calculates the average document length for this index\n *\n * @private\n */\nlunr.Builder.prototype.calculateAverageFieldLengths = function () {\n\n var fieldRefs = Object.keys(this.fieldLengths),\n numberOfFields = fieldRefs.length,\n accumulator = {},\n documentsWithField = {}\n\n for (var i = 0; i < numberOfFields; i++) {\n var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]),\n field = fieldRef.fieldName\n\n documentsWithField[field] || (documentsWithField[field] = 0)\n documentsWithField[field] += 1\n\n accumulator[field] || (accumulator[field] = 0)\n accumulator[field] += this.fieldLengths[fieldRef]\n }\n\n var fields = Object.keys(this._fields)\n\n for (var i = 0; i < fields.length; i++) {\n var fieldName = fields[i]\n accumulator[fieldName] = accumulator[fieldName] / documentsWithField[fieldName]\n }\n\n this.averageFieldLength = accumulator\n}\n\n/**\n * Builds a vector space model of every document using lunr.Vector\n *\n * @private\n */\nlunr.Builder.prototype.createFieldVectors = function () {\n var fieldVectors = {},\n fieldRefs = Object.keys(this.fieldTermFrequencies),\n fieldRefsLength = fieldRefs.length,\n termIdfCache = Object.create(null)\n\n for (var i = 0; i < fieldRefsLength; i++) {\n var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]),\n fieldName = fieldRef.fieldName,\n fieldLength = this.fieldLengths[fieldRef],\n fieldVector = new lunr.Vector,\n termFrequencies = this.fieldTermFrequencies[fieldRef],\n terms = Object.keys(termFrequencies),\n termsLength = terms.length\n\n\n var fieldBoost = this._fields[fieldName].boost || 1,\n docBoost = this._documents[fieldRef.docRef].boost || 1\n\n for (var j = 0; j < termsLength; j++) {\n var term = terms[j],\n tf = termFrequencies[term],\n termIndex = this.invertedIndex[term]._index,\n idf, score, scoreWithPrecision\n\n if (termIdfCache[term] === undefined) {\n idf = lunr.idf(this.invertedIndex[term], this.documentCount)\n termIdfCache[term] = idf\n } else {\n idf = termIdfCache[term]\n }\n\n score = idf * ((this._k1 + 1) * tf) / (this._k1 * (1 - this._b + this._b * (fieldLength / this.averageFieldLength[fieldName])) + tf)\n score *= fieldBoost\n score *= docBoost\n scoreWithPrecision = Math.round(score * 1000) / 1000\n // Converts 1.23456789 to 1.234.\n // Reducing the precision so that the vectors take up less\n // space when serialised. Doing it now so that they behave\n // the same before and after serialisation. Also, this is\n // the fastest approach to reducing a number's precision in\n // JavaScript.\n\n fieldVector.insert(termIndex, scoreWithPrecision)\n }\n\n fieldVectors[fieldRef] = fieldVector\n }\n\n this.fieldVectors = fieldVectors\n}\n\n/**\n * Creates a token set of all tokens in the index using lunr.TokenSet\n *\n * @private\n */\nlunr.Builder.prototype.createTokenSet = function () {\n this.tokenSet = lunr.TokenSet.fromArray(\n Object.keys(this.invertedIndex).sort()\n )\n}\n\n/**\n * Builds the index, creating an instance of lunr.Index.\n *\n * This completes the indexing process and should only be called\n * once all documents have been added to the index.\n *\n * @returns {lunr.Index}\n */\nlunr.Builder.prototype.build = function () {\n this.calculateAverageFieldLengths()\n this.createFieldVectors()\n this.createTokenSet()\n\n return new lunr.Index({\n invertedIndex: this.invertedIndex,\n fieldVectors: this.fieldVectors,\n tokenSet: this.tokenSet,\n fields: Object.keys(this._fields),\n pipeline: this.searchPipeline\n })\n}\n\n/**\n * Applies a plugin to the index builder.\n *\n * A plugin is a function that is called with the index builder as its context.\n * Plugins can be used to customise or extend the behaviour of the index\n * in some way. A plugin is just a function, that encapsulated the custom\n * behaviour that should be applied when building the index.\n *\n * The plugin function will be called with the index builder as its argument, additional\n * arguments can also be passed when calling use. The function will be called\n * with the index builder as its context.\n *\n * @param {Function} plugin The plugin to apply.\n */\nlunr.Builder.prototype.use = function (fn) {\n var args = Array.prototype.slice.call(arguments, 1)\n args.unshift(this)\n fn.apply(this, args)\n}\n/**\n * Contains and collects metadata about a matching document.\n * A single instance of lunr.MatchData is returned as part of every\n * lunr.Index~Result.\n *\n * @constructor\n * @param {string} term - The term this match data is associated with\n * @param {string} field - The field in which the term was found\n * @param {object} metadata - The metadata recorded about this term in this field\n * @property {object} metadata - A cloned collection of metadata associated with this document.\n * @see {@link lunr.Index~Result}\n */\nlunr.MatchData = function (term, field, metadata) {\n var clonedMetadata = Object.create(null),\n metadataKeys = Object.keys(metadata || {})\n\n // Cloning the metadata to prevent the original\n // being mutated during match data combination.\n // Metadata is kept in an array within the inverted\n // index so cloning the data can be done with\n // Array#slice\n for (var i = 0; i < metadataKeys.length; i++) {\n var key = metadataKeys[i]\n clonedMetadata[key] = metadata[key].slice()\n }\n\n this.metadata = Object.create(null)\n\n if (term !== undefined) {\n this.metadata[term] = Object.create(null)\n this.metadata[term][field] = clonedMetadata\n }\n}\n\n/**\n * An instance of lunr.MatchData will be created for every term that matches a\n * document. However only one instance is required in a lunr.Index~Result. This\n * method combines metadata from another instance of lunr.MatchData with this\n * objects metadata.\n *\n * @param {lunr.MatchData} otherMatchData - Another instance of match data to merge with this one.\n * @see {@link lunr.Index~Result}\n */\nlunr.MatchData.prototype.combine = function (otherMatchData) {\n var terms = Object.keys(otherMatchData.metadata)\n\n for (var i = 0; i < terms.length; i++) {\n var term = terms[i],\n fields = Object.keys(otherMatchData.metadata[term])\n\n if (this.metadata[term] == undefined) {\n this.metadata[term] = Object.create(null)\n }\n\n for (var j = 0; j < fields.length; j++) {\n var field = fields[j],\n keys = Object.keys(otherMatchData.metadata[term][field])\n\n if (this.metadata[term][field] == undefined) {\n this.metadata[term][field] = Object.create(null)\n }\n\n for (var k = 0; k < keys.length; k++) {\n var key = keys[k]\n\n if (this.metadata[term][field][key] == undefined) {\n this.metadata[term][field][key] = otherMatchData.metadata[term][field][key]\n } else {\n this.metadata[term][field][key] = this.metadata[term][field][key].concat(otherMatchData.metadata[term][field][key])\n }\n\n }\n }\n }\n}\n\n/**\n * Add metadata for a term/field pair to this instance of match data.\n *\n * @param {string} term - The term this match data is associated with\n * @param {string} field - The field in which the term was found\n * @param {object} metadata - The metadata recorded about this term in this field\n */\nlunr.MatchData.prototype.add = function (term, field, metadata) {\n if (!(term in this.metadata)) {\n this.metadata[term] = Object.create(null)\n this.metadata[term][field] = metadata\n return\n }\n\n if (!(field in this.metadata[term])) {\n this.metadata[term][field] = metadata\n return\n }\n\n var metadataKeys = Object.keys(metadata)\n\n for (var i = 0; i < metadataKeys.length; i++) {\n var key = metadataKeys[i]\n\n if (key in this.metadata[term][field]) {\n this.metadata[term][field][key] = this.metadata[term][field][key].concat(metadata[key])\n } else {\n this.metadata[term][field][key] = metadata[key]\n }\n }\n}\n/**\n * A lunr.Query provides a programmatic way of defining queries to be performed\n * against a {@link lunr.Index}.\n *\n * Prefer constructing a lunr.Query using the {@link lunr.Index#query} method\n * so the query object is pre-initialized with the right index fields.\n *\n * @constructor\n * @property {lunr.Query~Clause[]} clauses - An array of query clauses.\n * @property {string[]} allFields - An array of all available fields in a lunr.Index.\n */\nlunr.Query = function (allFields) {\n this.clauses = []\n this.allFields = allFields\n}\n\n/**\n * Constants for indicating what kind of automatic wildcard insertion will be used when constructing a query clause.\n *\n * This allows wildcards to be added to the beginning and end of a term without having to manually do any string\n * concatenation.\n *\n * The wildcard constants can be bitwise combined to select both leading and trailing wildcards.\n *\n * @constant\n * @default\n * @property {number} wildcard.NONE - The term will have no wildcards inserted, this is the default behaviour\n * @property {number} wildcard.LEADING - Prepend the term with a wildcard, unless a leading wildcard already exists\n * @property {number} wildcard.TRAILING - Append a wildcard to the term, unless a trailing wildcard already exists\n * @see lunr.Query~Clause\n * @see lunr.Query#clause\n * @see lunr.Query#term\n * @example <caption>query term with trailing wildcard</caption>\n * query.term('foo', { wildcard: lunr.Query.wildcard.TRAILING })\n * @example <caption>query term with leading and trailing wildcard</caption>\n * query.term('foo', {\n * wildcard: lunr.Query.wildcard.LEADING | lunr.Query.wildcard.TRAILING\n * })\n */\n\nlunr.Query.wildcard = new String (\"*\")\nlunr.Query.wildcard.NONE = 0\nlunr.Query.wildcard.LEADING = 1\nlunr.Query.wildcard.TRAILING = 2\n\n/**\n * Constants for indicating what kind of presence a term must have in matching documents.\n *\n * @constant\n * @enum {number}\n * @see lunr.Query~Clause\n * @see lunr.Query#clause\n * @see lunr.Query#term\n * @example <caption>query term with required presence</caption>\n * query.term('foo', { presence: lunr.Query.presence.REQUIRED })\n */\nlunr.Query.presence = {\n /**\n * Term's presence in a document is optional, this is the default value.\n */\n OPTIONAL: 1,\n\n /**\n * Term's presence in a document is required, documents that do not contain\n * this term will not be returned.\n */\n REQUIRED: 2,\n\n /**\n * Term's presence in a document is prohibited, documents that do contain\n * this term will not be returned.\n */\n PROHIBITED: 3\n}\n\n/**\n * A single clause in a {@link lunr.Query} contains a term and details on how to\n * match that term against a {@link lunr.Index}.\n *\n * @typedef {Object} lunr.Query~Clause\n * @property {string[]} fields - The fields in an index this clause should be matched against.\n * @property {number} [boost=1] - Any boost that should be applied when matching this clause.\n * @property {number} [editDistance] - Whether the term should have fuzzy matching applied, and how fuzzy the match should be.\n * @property {boolean} [usePipeline] - Whether the term should be passed through the search pipeline.\n * @property {number} [wildcard=lunr.Query.wildcard.NONE] - Whether the term should have wildcards appended or prepended.\n * @property {number} [presence=lunr.Query.presence.OPTIONAL] - The terms presence in any matching documents.\n */\n\n/**\n * Adds a {@link lunr.Query~Clause} to this query.\n *\n * Unless the clause contains the fields to be matched all fields will be matched. In addition\n * a default boost of 1 is applied to the clause.\n *\n * @param {lunr.Query~Clause} clause - The clause to add to this query.\n * @see lunr.Query~Clause\n * @returns {lunr.Query}\n */\nlunr.Query.prototype.clause = function (clause) {\n if (!('fields' in clause)) {\n clause.fields = this.allFields\n }\n\n if (!('boost' in clause)) {\n clause.boost = 1\n }\n\n if (!('usePipeline' in clause)) {\n clause.usePipeline = true\n }\n\n if (!('wildcard' in clause)) {\n clause.wildcard = lunr.Query.wildcard.NONE\n }\n\n if ((clause.wildcard & lunr.Query.wildcard.LEADING) && (clause.term.charAt(0) != lunr.Query.wildcard)) {\n clause.term = \"*\" + clause.term\n }\n\n if ((clause.wildcard & lunr.Query.wildcard.TRAILING) && (clause.term.slice(-1) != lunr.Query.wildcard)) {\n clause.term = \"\" + clause.term + \"*\"\n }\n\n if (!('presence' in clause)) {\n clause.presence = lunr.Query.presence.OPTIONAL\n }\n\n this.clauses.push(clause)\n\n return this\n}\n\n/**\n * A negated query is one in which every clause has a presence of\n * prohibited. These queries require some special processing to return\n * the expected results.\n *\n * @returns boolean\n */\nlunr.Query.prototype.isNegated = function () {\n for (var i = 0; i < this.clauses.length; i++) {\n if (this.clauses[i].presence != lunr.Query.presence.PROHIBITED) {\n return false\n }\n }\n\n return true\n}\n\n/**\n * Adds a term to the current query, under the covers this will create a {@link lunr.Query~Clause}\n * to the list of clauses that make up this query.\n *\n * The term is used as is, i.e. no tokenization will be performed by this method. Instead conversion\n * to a token or token-like string should be done before calling this method.\n *\n * The term will be converted to a string by calling `toString`. Multiple terms can be passed as an\n * array, each term in the array will share the same options.\n *\n * @param {object|object[]} term - The term(s) to add to the query.\n * @param {object} [options] - Any additional properties to add to the query clause.\n * @returns {lunr.Query}\n * @see lunr.Query#clause\n * @see lunr.Query~Clause\n * @example <caption>adding a single term to a query</caption>\n * query.term(\"foo\")\n * @example <caption>adding a single term to a query and specifying search fields, term boost and automatic trailing wildcard</caption>\n * query.term(\"foo\", {\n * fields: [\"title\"],\n * boost: 10,\n * wildcard: lunr.Query.wildcard.TRAILING\n * })\n * @example <caption>using lunr.tokenizer to convert a string to tokens before using them as terms</caption>\n * query.term(lunr.tokenizer(\"foo bar\"))\n */\nlunr.Query.prototype.term = function (term, options) {\n if (Array.isArray(term)) {\n term.forEach(function (t) { this.term(t, lunr.utils.clone(options)) }, this)\n return this\n }\n\n var clause = options || {}\n clause.term = term.toString()\n\n this.clause(clause)\n\n return this\n}\nlunr.QueryParseError = function (message, start, end) {\n this.name = \"QueryParseError\"\n this.message = message\n this.start = start\n this.end = end\n}\n\nlunr.QueryParseError.prototype = new Error\nlunr.QueryLexer = function (str) {\n this.lexemes = []\n this.str = str\n this.length = str.length\n this.pos = 0\n this.start = 0\n this.escapeCharPositions = []\n}\n\nlunr.QueryLexer.prototype.run = function () {\n var state = lunr.QueryLexer.lexText\n\n while (state) {\n state = state(this)\n }\n}\n\nlunr.QueryLexer.prototype.sliceString = function () {\n var subSlices = [],\n sliceStart = this.start,\n sliceEnd = this.pos\n\n for (var i = 0; i < this.escapeCharPositions.length; i++) {\n sliceEnd = this.escapeCharPositions[i]\n subSlices.push(this.str.slice(sliceStart, sliceEnd))\n sliceStart = sliceEnd + 1\n }\n\n subSlices.push(this.str.slice(sliceStart, this.pos))\n this.escapeCharPositions.length = 0\n\n return subSlices.join('')\n}\n\nlunr.QueryLexer.prototype.emit = function (type) {\n this.lexemes.push({\n type: type,\n str: this.sliceString(),\n start: this.start,\n end: this.pos\n })\n\n this.start = this.pos\n}\n\nlunr.QueryLexer.prototype.escapeCharacter = function () {\n this.escapeCharPositions.push(this.pos - 1)\n this.pos += 1\n}\n\nlunr.QueryLexer.prototype.next = function () {\n if (this.pos >= this.length) {\n return lunr.QueryLexer.EOS\n }\n\n var char = this.str.charAt(this.pos)\n this.pos += 1\n return char\n}\n\nlunr.QueryLexer.prototype.width = function () {\n return this.pos - this.start\n}\n\nlunr.QueryLexer.prototype.ignore = function () {\n if (this.start == this.pos) {\n this.pos += 1\n }\n\n this.start = this.pos\n}\n\nlunr.QueryLexer.prototype.backup = function () {\n this.pos -= 1\n}\n\nlunr.QueryLexer.prototype.acceptDigitRun = function () {\n var char, charCode\n\n do {\n char = this.next()\n charCode = char.charCodeAt(0)\n } while (charCode > 47 && charCode < 58)\n\n if (char != lunr.QueryLexer.EOS) {\n this.backup()\n }\n}\n\nlunr.QueryLexer.prototype.more = function () {\n return this.pos < this.length\n}\n\nlunr.QueryLexer.EOS = 'EOS'\nlunr.QueryLexer.FIELD = 'FIELD'\nlunr.QueryLexer.TERM = 'TERM'\nlunr.QueryLexer.EDIT_DISTANCE = 'EDIT_DISTANCE'\nlunr.QueryLexer.BOOST = 'BOOST'\nlunr.QueryLexer.PRESENCE = 'PRESENCE'\n\nlunr.QueryLexer.lexField = function (lexer) {\n lexer.backup()\n lexer.emit(lunr.QueryLexer.FIELD)\n lexer.ignore()\n return lunr.QueryLexer.lexText\n}\n\nlunr.QueryLexer.lexTerm = function (lexer) {\n if (lexer.width() > 1) {\n lexer.backup()\n lexer.emit(lunr.QueryLexer.TERM)\n }\n\n lexer.ignore()\n\n if (lexer.more()) {\n return lunr.QueryLexer.lexText\n }\n}\n\nlunr.QueryLexer.lexEditDistance = function (lexer) {\n lexer.ignore()\n lexer.acceptDigitRun()\n lexer.emit(lunr.QueryLexer.EDIT_DISTANCE)\n return lunr.QueryLexer.lexText\n}\n\nlunr.QueryLexer.lexBoost = function (lexer) {\n lexer.ignore()\n lexer.acceptDigitRun()\n lexer.emit(lunr.QueryLexer.BOOST)\n return lunr.QueryLexer.lexText\n}\n\nlunr.QueryLexer.lexEOS = function (lexer) {\n if (lexer.width() > 0) {\n lexer.emit(lunr.QueryLexer.TERM)\n }\n}\n\n// This matches the separator used when tokenising fields\n// within a document. These should match otherwise it is\n// not possible to search for some tokens within a document.\n//\n// It is possible for the user to change the separator on the\n// tokenizer so it _might_ clash with any other of the special\n// characters already used within the search string, e.g. :.\n//\n// This means that it is possible to change the separator in\n// such a way that makes some words unsearchable using a search\n// string.\nlunr.QueryLexer.termSeparator = lunr.tokenizer.separator\n\nlunr.QueryLexer.lexText = function (lexer) {\n while (true) {\n var char = lexer.next()\n\n if (char == lunr.QueryLexer.EOS) {\n return lunr.QueryLexer.lexEOS\n }\n\n // Escape character is '\\'\n if (char.charCodeAt(0) == 92) {\n lexer.escapeCharacter()\n continue\n }\n\n if (char == \":\") {\n return lunr.QueryLexer.lexField\n }\n\n if (char == \"~\") {\n lexer.backup()\n if (lexer.width() > 0) {\n lexer.emit(lunr.QueryLexer.TERM)\n }\n return lunr.QueryLexer.lexEditDistance\n }\n\n if (char == \"^\") {\n lexer.backup()\n if (lexer.width() > 0) {\n lexer.emit(lunr.QueryLexer.TERM)\n }\n return lunr.QueryLexer.lexBoost\n }\n\n // \"+\" indicates term presence is required\n // checking for length to ensure that only\n // leading \"+\" are considered\n if (char == \"+\" && lexer.width() === 1) {\n lexer.emit(lunr.QueryLexer.PRESENCE)\n return lunr.QueryLexer.lexText\n }\n\n // \"-\" indicates term presence is prohibited\n // checking for length to ensure that only\n // leading \"-\" are considered\n if (char == \"-\" && lexer.width() === 1) {\n lexer.emit(lunr.QueryLexer.PRESENCE)\n return lunr.QueryLexer.lexText\n }\n\n if (char.match(lunr.QueryLexer.termSeparator)) {\n return lunr.QueryLexer.lexTerm\n }\n }\n}\n\nlunr.QueryParser = function (str, query) {\n this.lexer = new lunr.QueryLexer (str)\n this.query = query\n this.currentClause = {}\n this.lexemeIdx = 0\n}\n\nlunr.QueryParser.prototype.parse = function () {\n this.lexer.run()\n this.lexemes = this.lexer.lexemes\n\n var state = lunr.QueryParser.parseClause\n\n while (state) {\n state = state(this)\n }\n\n return this.query\n}\n\nlunr.QueryParser.prototype.peekLexeme = function () {\n return this.lexemes[this.lexemeIdx]\n}\n\nlunr.QueryParser.prototype.consumeLexeme = function () {\n var lexeme = this.peekLexeme()\n this.lexemeIdx += 1\n return lexeme\n}\n\nlunr.QueryParser.prototype.nextClause = function () {\n var completedClause = this.currentClause\n this.query.clause(completedClause)\n this.currentClause = {}\n}\n\nlunr.QueryParser.parseClause = function (parser) {\n var lexeme = parser.peekLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n switch (lexeme.type) {\n case lunr.QueryLexer.PRESENCE:\n return lunr.QueryParser.parsePresence\n case lunr.QueryLexer.FIELD:\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.TERM:\n return lunr.QueryParser.parseTerm\n default:\n var errorMessage = \"expected either a field or a term, found \" + lexeme.type\n\n if (lexeme.str.length >= 1) {\n errorMessage += \" with value '\" + lexeme.str + \"'\"\n }\n\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n}\n\nlunr.QueryParser.parsePresence = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n switch (lexeme.str) {\n case \"-\":\n parser.currentClause.presence = lunr.Query.presence.PROHIBITED\n break\n case \"+\":\n parser.currentClause.presence = lunr.Query.presence.REQUIRED\n break\n default:\n var errorMessage = \"unrecognised presence operator'\" + lexeme.str + \"'\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n var errorMessage = \"expecting term or field, found nothing\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.FIELD:\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.TERM:\n return lunr.QueryParser.parseTerm\n default:\n var errorMessage = \"expecting term or field, found '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseField = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n if (parser.query.allFields.indexOf(lexeme.str) == -1) {\n var possibleFields = parser.query.allFields.map(function (f) { return \"'\" + f + \"'\" }).join(', '),\n errorMessage = \"unrecognised field '\" + lexeme.str + \"', possible fields: \" + possibleFields\n\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n parser.currentClause.fields = [lexeme.str]\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n var errorMessage = \"expecting term, found nothing\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n return lunr.QueryParser.parseTerm\n default:\n var errorMessage = \"expecting term, found '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseTerm = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n parser.currentClause.term = lexeme.str.toLowerCase()\n\n if (lexeme.str.indexOf(\"*\") != -1) {\n parser.currentClause.usePipeline = false\n }\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n parser.nextClause()\n return\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n parser.nextClause()\n return lunr.QueryParser.parseTerm\n case lunr.QueryLexer.FIELD:\n parser.nextClause()\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.EDIT_DISTANCE:\n return lunr.QueryParser.parseEditDistance\n case lunr.QueryLexer.BOOST:\n return lunr.QueryParser.parseBoost\n case lunr.QueryLexer.PRESENCE:\n parser.nextClause()\n return lunr.QueryParser.parsePresence\n default:\n var errorMessage = \"Unexpected lexeme type '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseEditDistance = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n var editDistance = parseInt(lexeme.str, 10)\n\n if (isNaN(editDistance)) {\n var errorMessage = \"edit distance must be numeric\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n parser.currentClause.editDistance = editDistance\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n parser.nextClause()\n return\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n parser.nextClause()\n return lunr.QueryParser.parseTerm\n case lunr.QueryLexer.FIELD:\n parser.nextClause()\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.EDIT_DISTANCE:\n return lunr.QueryParser.parseEditDistance\n case lunr.QueryLexer.BOOST:\n return lunr.QueryParser.parseBoost\n case lunr.QueryLexer.PRESENCE:\n parser.nextClause()\n return lunr.QueryParser.parsePresence\n default:\n var errorMessage = \"Unexpected lexeme type '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseBoost = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n var boost = parseInt(lexeme.str, 10)\n\n if (isNaN(boost)) {\n var errorMessage = \"boost must be numeric\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n parser.currentClause.boost = boost\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n parser.nextClause()\n return\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n parser.nextClause()\n return lunr.QueryParser.parseTerm\n case lunr.QueryLexer.FIELD:\n parser.nextClause()\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.EDIT_DISTANCE:\n return lunr.QueryParser.parseEditDistance\n case lunr.QueryLexer.BOOST:\n return lunr.QueryParser.parseBoost\n case lunr.QueryLexer.PRESENCE:\n parser.nextClause()\n return lunr.QueryParser.parsePresence\n default:\n var errorMessage = \"Unexpected lexeme type '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\n /**\n * export the module via AMD, CommonJS or as a browser global\n * Export code from https://github.com/umdjs/umd/blob/master/returnExports.js\n */\n ;(function (root, factory) {\n if (true) {\n // AMD. Register as an anonymous module.\n !(__WEBPACK_AMD_DEFINE_FACTORY__ = (factory),\n\t\t__WEBPACK_AMD_DEFINE_RESULT__ = (typeof __WEBPACK_AMD_DEFINE_FACTORY__ === 'function' ?\n\t\t(__WEBPACK_AMD_DEFINE_FACTORY__.call(exports, __webpack_require__, exports, module)) :\n\t\t__WEBPACK_AMD_DEFINE_FACTORY__),\n\t\t__WEBPACK_AMD_DEFINE_RESULT__ !== undefined && (module.exports = __WEBPACK_AMD_DEFINE_RESULT__))\n } else {}\n }(this, function () {\n /**\n * Just return a value to define the module export.\n * This example returns an object, but the module\n * can return a function as the exported value.\n */\n return lunr\n }))\n})();\n\n\n//# sourceURL=webpack:///../node_modules/lunr/lunr.js?");
+
+/***/ }),
+
+/***/ "./default/assets/css/main.sass":
+/*!**************************************!*\
+ !*** ./default/assets/css/main.sass ***!
+ \**************************************/
+/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
+
+"use strict";
+eval("__webpack_require__.r(__webpack_exports__);\n// extracted by mini-css-extract-plugin\n\n\n//# sourceURL=webpack:///./default/assets/css/main.sass?");
+
+/***/ }),
+
+/***/ "./default/assets/js/src/bootstrap.ts":
+/*!********************************************!*\
+ !*** ./default/assets/js/src/bootstrap.ts ***!
+ \********************************************/
+/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
+
+"use strict";
+eval("__webpack_require__.r(__webpack_exports__);\n/* harmony import */ var _typedoc_Application__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./typedoc/Application */ \"./default/assets/js/src/typedoc/Application.ts\");\n/* harmony import */ var _typedoc_components_MenuHighlight__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ./typedoc/components/MenuHighlight */ \"./default/assets/js/src/typedoc/components/MenuHighlight.ts\");\n/* harmony import */ var _typedoc_components_Search__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! ./typedoc/components/Search */ \"./default/assets/js/src/typedoc/components/Search.ts\");\n/* harmony import */ var _typedoc_components_Signature__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(/*! ./typedoc/components/Signature */ \"./default/assets/js/src/typedoc/components/Signature.ts\");\n/* harmony import */ var _typedoc_components_Toggle__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(/*! ./typedoc/components/Toggle */ \"./default/assets/js/src/typedoc/components/Toggle.ts\");\n/* harmony import */ var _typedoc_components_Filter__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(/*! ./typedoc/components/Filter */ \"./default/assets/js/src/typedoc/components/Filter.ts\");\n/* harmony import */ var _css_main_sass__WEBPACK_IMPORTED_MODULE_6__ = __webpack_require__(/*! ../../css/main.sass */ \"./default/assets/css/main.sass\");\n\n\n\n\n\n\n\n(0,_typedoc_components_Search__WEBPACK_IMPORTED_MODULE_2__.initSearch)();\n(0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_MenuHighlight__WEBPACK_IMPORTED_MODULE_1__.MenuHighlight, \".menu-highlight\");\n(0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_Signature__WEBPACK_IMPORTED_MODULE_3__.Signature, \".tsd-signatures\");\n(0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_Toggle__WEBPACK_IMPORTED_MODULE_4__.Toggle, \"a[data-toggle]\");\nif (_typedoc_components_Filter__WEBPACK_IMPORTED_MODULE_5__.Filter.isSupported()) {\n (0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_Filter__WEBPACK_IMPORTED_MODULE_5__.Filter, \"#tsd-filter\");\n}\nelse {\n document.documentElement.classList.add(\"no-filter\");\n}\nvar app = new _typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.Application();\nObject.defineProperty(window, \"app\", { value: app });\n\n\n//# sourceURL=webpack:///./default/assets/js/src/bootstrap.ts?");
+
+/***/ }),
+
+/***/ "./default/assets/js/src/typedoc/Application.ts":
+/*!******************************************************!*\
+ !*** ./default/assets/js/src/typedoc/Application.ts ***!
+ \******************************************************/
+/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
+
+"use strict";
+eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"registerComponent\": () => /* binding */ registerComponent,\n/* harmony export */ \"Application\": () => /* binding */ Application\n/* harmony export */ });\n/**\n * List of all known components.\n */\nvar components = [];\n/**\n * Register a new component.\n */\nfunction registerComponent(constructor, selector) {\n components.push({\n selector: selector,\n constructor: constructor,\n });\n}\n/**\n * TypeDoc application class.\n */\nvar Application = /** @class */ (function () {\n /**\n * Create a new Application instance.\n */\n function Application() {\n this.createComponents(document.body);\n }\n /**\n * Create all components beneath the given jQuery element.\n */\n Application.prototype.createComponents = function (context) {\n components.forEach(function (c) {\n context.querySelectorAll(c.selector).forEach(function (el) {\n if (!el.dataset.hasInstance) {\n new c.constructor({ el: el });\n el.dataset.hasInstance = String(true);\n }\n });\n });\n };\n return Application;\n}());\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/Application.ts?");
+
+/***/ }),
+
+/***/ "./default/assets/js/src/typedoc/Component.ts":
+/*!****************************************************!*\
+ !*** ./default/assets/js/src/typedoc/Component.ts ***!
+ \****************************************************/
+/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
+
+"use strict";
+eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Component\": () => /* binding */ Component\n/* harmony export */ });\n/**\n * TypeDoc component class.\n */\nvar Component = /** @class */ (function () {\n function Component(options) {\n this.el = options.el;\n }\n return Component;\n}());\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/Component.ts?");
+
+/***/ }),
+
+/***/ "./default/assets/js/src/typedoc/EventTarget.ts":
+/*!******************************************************!*\
+ !*** ./default/assets/js/src/typedoc/EventTarget.ts ***!
+ \******************************************************/
+/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
+
+"use strict";
+eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"EventTarget\": () => /* binding */ EventTarget\n/* harmony export */ });\n/**\n * TypeDoc event target class.\n */\nvar EventTarget = /** @class */ (function () {\n function EventTarget() {\n this.listeners = {};\n }\n EventTarget.prototype.addEventListener = function (type, callback) {\n if (!(type in this.listeners)) {\n this.listeners[type] = [];\n }\n this.listeners[type].push(callback);\n };\n EventTarget.prototype.removeEventListener = function (type, callback) {\n if (!(type in this.listeners)) {\n return;\n }\n var stack = this.listeners[type];\n for (var i = 0, l = stack.length; i < l; i++) {\n if (stack[i] === callback) {\n stack.splice(i, 1);\n return;\n }\n }\n };\n EventTarget.prototype.dispatchEvent = function (event) {\n if (!(event.type in this.listeners)) {\n return true;\n }\n var stack = this.listeners[event.type].slice();\n for (var i = 0, l = stack.length; i < l; i++) {\n stack[i].call(this, event);\n }\n return !event.defaultPrevented;\n };\n return EventTarget;\n}());\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/EventTarget.ts?");
+
+/***/ }),
+
+/***/ "./default/assets/js/src/typedoc/components/Filter.ts":
+/*!************************************************************!*\
+ !*** ./default/assets/js/src/typedoc/components/Filter.ts ***!
+ \************************************************************/
+/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
+
+"use strict";
+eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Filter\": () => /* binding */ Filter\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _utils_pointer__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../utils/pointer */ \"./default/assets/js/src/typedoc/utils/pointer.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\nvar FilterItem = /** @class */ (function () {\n function FilterItem(key, value) {\n this.key = key;\n this.value = value;\n this.defaultValue = value;\n this.initialize();\n if (window.localStorage[this.key]) {\n this.setValue(this.fromLocalStorage(window.localStorage[this.key]));\n }\n }\n FilterItem.prototype.initialize = function () { };\n FilterItem.prototype.setValue = function (value) {\n if (this.value == value)\n return;\n var oldValue = this.value;\n this.value = value;\n window.localStorage[this.key] = this.toLocalStorage(value);\n this.handleValueChange(oldValue, value);\n };\n return FilterItem;\n}());\nvar FilterItemCheckbox = /** @class */ (function (_super) {\n __extends(FilterItemCheckbox, _super);\n function FilterItemCheckbox() {\n return _super !== null && _super.apply(this, arguments) || this;\n }\n FilterItemCheckbox.prototype.initialize = function () {\n var _this = this;\n var checkbox = document.querySelector(\"#tsd-filter-\" + this.key);\n if (!checkbox)\n return;\n this.checkbox = checkbox;\n this.checkbox.addEventListener(\"change\", function () {\n _this.setValue(_this.checkbox.checked);\n });\n };\n FilterItemCheckbox.prototype.handleValueChange = function (oldValue, newValue) {\n if (!this.checkbox)\n return;\n this.checkbox.checked = this.value;\n document.documentElement.classList.toggle(\"toggle-\" + this.key, this.value != this.defaultValue);\n };\n FilterItemCheckbox.prototype.fromLocalStorage = function (value) {\n return value == \"true\";\n };\n FilterItemCheckbox.prototype.toLocalStorage = function (value) {\n return value ? \"true\" : \"false\";\n };\n return FilterItemCheckbox;\n}(FilterItem));\nvar FilterItemSelect = /** @class */ (function (_super) {\n __extends(FilterItemSelect, _super);\n function FilterItemSelect() {\n return _super !== null && _super.apply(this, arguments) || this;\n }\n FilterItemSelect.prototype.initialize = function () {\n var _this = this;\n document.documentElement.classList.add(\"toggle-\" + this.key + this.value);\n var select = document.querySelector(\"#tsd-filter-\" + this.key);\n if (!select)\n return;\n this.select = select;\n var onActivate = function () {\n _this.select.classList.add(\"active\");\n };\n var onDeactivate = function () {\n _this.select.classList.remove(\"active\");\n };\n this.select.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerDown, onActivate);\n this.select.addEventListener(\"mouseover\", onActivate);\n this.select.addEventListener(\"mouseleave\", onDeactivate);\n this.select.querySelectorAll(\"li\").forEach(function (el) {\n el.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerUp, function (e) {\n select.classList.remove(\"active\");\n _this.setValue(e.target.dataset.value || \"\");\n });\n });\n document.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerDown, function (e) {\n if (_this.select.contains(e.target))\n return;\n _this.select.classList.remove(\"active\");\n });\n };\n FilterItemSelect.prototype.handleValueChange = function (oldValue, newValue) {\n this.select.querySelectorAll(\"li.selected\").forEach(function (el) {\n el.classList.remove(\"selected\");\n });\n var selected = this.select.querySelector('li[data-value=\"' + newValue + '\"]');\n var label = this.select.querySelector(\".tsd-select-label\");\n if (selected && label) {\n selected.classList.add(\"selected\");\n label.textContent = selected.textContent;\n }\n document.documentElement.classList.remove(\"toggle-\" + oldValue);\n document.documentElement.classList.add(\"toggle-\" + newValue);\n };\n FilterItemSelect.prototype.fromLocalStorage = function (value) {\n return value;\n };\n FilterItemSelect.prototype.toLocalStorage = function (value) {\n return value;\n };\n return FilterItemSelect;\n}(FilterItem));\nvar Filter = /** @class */ (function (_super) {\n __extends(Filter, _super);\n function Filter(options) {\n var _this = _super.call(this, options) || this;\n _this.optionVisibility = new FilterItemSelect(\"visibility\", \"private\");\n _this.optionInherited = new FilterItemCheckbox(\"inherited\", true);\n _this.optionExternals = new FilterItemCheckbox(\"externals\", true);\n return _this;\n }\n Filter.isSupported = function () {\n try {\n return typeof window.localStorage != \"undefined\";\n }\n catch (e) {\n return false;\n }\n };\n return Filter;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Filter.ts?");
+
+/***/ }),
+
+/***/ "./default/assets/js/src/typedoc/components/MenuHighlight.ts":
+/*!*******************************************************************!*\
+ !*** ./default/assets/js/src/typedoc/components/MenuHighlight.ts ***!
+ \*******************************************************************/
+/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
+
+"use strict";
+eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"MenuHighlight\": () => /* binding */ MenuHighlight\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _services_Viewport__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../services/Viewport */ \"./default/assets/js/src/typedoc/services/Viewport.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\n/**\n * Manages the sticky state of the navigation and moves the highlight\n * to the current navigation item.\n */\nvar MenuHighlight = /** @class */ (function (_super) {\n __extends(MenuHighlight, _super);\n /**\n * Create a new MenuHighlight instance.\n *\n * @param options Backbone view constructor options.\n */\n function MenuHighlight(options) {\n var _this = _super.call(this, options) || this;\n /**\n * List of all discovered anchors.\n */\n _this.anchors = [];\n /**\n * Index of the currently highlighted anchor.\n */\n _this.index = -1;\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.addEventListener(\"resize\", function () { return _this.onResize(); });\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.addEventListener(\"scroll\", function (e) { return _this.onScroll(e); });\n _this.createAnchors();\n return _this;\n }\n /**\n * Find all anchors on the current page.\n */\n MenuHighlight.prototype.createAnchors = function () {\n var _this = this;\n var base = window.location.href;\n if (base.indexOf(\"#\") != -1) {\n base = base.substr(0, base.indexOf(\"#\"));\n }\n this.el.querySelectorAll(\"a\").forEach(function (el) {\n var href = el.href;\n if (href.indexOf(\"#\") == -1)\n return;\n if (href.substr(0, base.length) != base)\n return;\n var hash = href.substr(href.indexOf(\"#\") + 1);\n var anchor = document.querySelector(\"a.tsd-anchor[name=\" + hash + \"]\");\n var link = el.parentNode;\n if (!anchor || !link)\n return;\n _this.anchors.push({\n link: link,\n anchor: anchor,\n position: 0,\n });\n });\n this.onResize();\n };\n /**\n * Triggered after the viewport was resized.\n */\n MenuHighlight.prototype.onResize = function () {\n var anchor;\n for (var index = 0, count = this.anchors.length; index < count; index++) {\n anchor = this.anchors[index];\n var rect = anchor.anchor.getBoundingClientRect();\n anchor.position = rect.top + document.body.scrollTop;\n }\n this.anchors.sort(function (a, b) {\n return a.position - b.position;\n });\n var event = new CustomEvent(\"scroll\", {\n detail: {\n scrollTop: _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.scrollTop,\n },\n });\n this.onScroll(event);\n };\n /**\n * Triggered after the viewport was scrolled.\n *\n * @param event The custom event with the current vertical scroll position.\n */\n MenuHighlight.prototype.onScroll = function (event) {\n var scrollTop = event.detail.scrollTop + 5;\n var anchors = this.anchors;\n var count = anchors.length - 1;\n var index = this.index;\n while (index > -1 && anchors[index].position > scrollTop) {\n index -= 1;\n }\n while (index < count && anchors[index + 1].position < scrollTop) {\n index += 1;\n }\n if (this.index != index) {\n if (this.index > -1)\n this.anchors[this.index].link.classList.remove(\"focus\");\n this.index = index;\n if (this.index > -1)\n this.anchors[this.index].link.classList.add(\"focus\");\n }\n };\n return MenuHighlight;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/MenuHighlight.ts?");
+
+/***/ }),
+
+/***/ "./default/assets/js/src/typedoc/components/Search.ts":
+/*!************************************************************!*\
+ !*** ./default/assets/js/src/typedoc/components/Search.ts ***!
+ \************************************************************/
+/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
+
+"use strict";
+eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"initSearch\": () => /* binding */ initSearch\n/* harmony export */ });\n/* harmony import */ var _utils_debounce__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../utils/debounce */ \"./default/assets/js/src/typedoc/utils/debounce.ts\");\n/* harmony import */ var lunr__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! lunr */ \"../node_modules/lunr/lunr.js\");\n/* harmony import */ var lunr__WEBPACK_IMPORTED_MODULE_1___default = /*#__PURE__*/__webpack_require__.n(lunr__WEBPACK_IMPORTED_MODULE_1__);\n\n\nfunction initSearch() {\n var searchEl = document.getElementById(\"tsd-search\");\n if (!searchEl)\n return;\n var searchScript = document.getElementById(\"search-script\");\n searchEl.classList.add(\"loading\");\n if (searchScript) {\n searchScript.addEventListener(\"error\", function () {\n searchEl.classList.remove(\"loading\");\n searchEl.classList.add(\"failure\");\n });\n searchScript.addEventListener(\"load\", function () {\n searchEl.classList.remove(\"loading\");\n searchEl.classList.add(\"ready\");\n });\n if (window.searchData) {\n searchEl.classList.remove(\"loading\");\n }\n }\n var field = document.querySelector(\"#tsd-search-field\");\n var results = document.querySelector(\".results\");\n if (!field || !results) {\n throw new Error(\"The input field or the result list wrapper was not found\");\n }\n var resultClicked = false;\n results.addEventListener(\"mousedown\", function () { return (resultClicked = true); });\n results.addEventListener(\"mouseup\", function () {\n resultClicked = false;\n searchEl.classList.remove(\"has-focus\");\n });\n field.addEventListener(\"focus\", function () { return searchEl.classList.add(\"has-focus\"); });\n field.addEventListener(\"blur\", function () {\n if (!resultClicked) {\n resultClicked = false;\n searchEl.classList.remove(\"has-focus\");\n }\n });\n var state = {\n base: searchEl.dataset.base + \"/\",\n };\n bindEvents(searchEl, results, field, state);\n}\nfunction bindEvents(searchEl, results, field, state) {\n field.addEventListener(\"input\", (0,_utils_debounce__WEBPACK_IMPORTED_MODULE_0__.debounce)(function () {\n updateResults(searchEl, results, field, state);\n }, 200));\n var preventPress = false;\n field.addEventListener(\"keydown\", function (e) {\n preventPress = true;\n if (e.key == \"Enter\") {\n gotoCurrentResult(results, field);\n }\n else if (e.key == \"Escape\") {\n field.blur();\n }\n else if (e.key == \"ArrowUp\") {\n setCurrentResult(results, -1);\n }\n else if (e.key === \"ArrowDown\") {\n setCurrentResult(results, 1);\n }\n else {\n preventPress = false;\n }\n });\n field.addEventListener(\"keypress\", function (e) {\n if (preventPress)\n e.preventDefault();\n });\n /**\n * Start searching by pressing slash.\n */\n document.body.addEventListener(\"keydown\", function (e) {\n if (e.altKey || e.ctrlKey || e.metaKey)\n return;\n if (!field.matches(\":focus\") && e.key === \"/\") {\n field.focus();\n e.preventDefault();\n }\n });\n}\nfunction checkIndex(state, searchEl) {\n if (state.index)\n return;\n if (window.searchData) {\n searchEl.classList.remove(\"loading\");\n searchEl.classList.add(\"ready\");\n state.data = window.searchData;\n state.index = lunr__WEBPACK_IMPORTED_MODULE_1__.Index.load(window.searchData.index);\n }\n}\nfunction updateResults(searchEl, results, query, state) {\n checkIndex(state, searchEl);\n // Don't clear results if loading state is not ready,\n // because loading or error message can be removed.\n if (!state.index || !state.data)\n return;\n results.textContent = \"\";\n var searchText = query.value.trim();\n // Perform a wildcard search\n var res = state.index.search(\"*\" + searchText + \"*\");\n for (var i = 0, c = Math.min(10, res.length); i < c; i++) {\n var row = state.data.rows[Number(res[i].ref)];\n // Bold the matched part of the query in the search results\n var name_1 = boldMatches(row.name, searchText);\n if (row.parent) {\n name_1 = \"<span class=\\\"parent\\\">\" + boldMatches(row.parent, searchText) + \".</span>\" + name_1;\n }\n var item = document.createElement(\"li\");\n item.classList.value = row.classes;\n var anchor = document.createElement(\"a\");\n anchor.href = state.base + row.url;\n anchor.classList.add(\"tsd-kind-icon\");\n anchor.innerHTML = name_1;\n item.append(anchor);\n results.appendChild(item);\n }\n}\n/**\n * Move the highlight within the result set.\n */\nfunction setCurrentResult(results, dir) {\n var current = results.querySelector(\".current\");\n if (!current) {\n current = results.querySelector(dir == 1 ? \"li:first-child\" : \"li:last-child\");\n if (current) {\n current.classList.add(\"current\");\n }\n }\n else {\n var rel = dir == 1\n ? current.nextElementSibling\n : current.previousElementSibling;\n if (rel) {\n current.classList.remove(\"current\");\n rel.classList.add(\"current\");\n }\n }\n}\n/**\n * Navigate to the highlighted result.\n */\nfunction gotoCurrentResult(results, field) {\n var current = results.querySelector(\".current\");\n if (!current) {\n current = results.querySelector(\"li:first-child\");\n }\n if (current) {\n var link = current.querySelector(\"a\");\n if (link) {\n window.location.href = link.href;\n }\n field.blur();\n }\n}\nfunction boldMatches(text, search) {\n if (search === \"\") {\n return text;\n }\n var lowerText = text.toLocaleLowerCase();\n var lowerSearch = search.toLocaleLowerCase();\n var parts = [];\n var lastIndex = 0;\n var index = lowerText.indexOf(lowerSearch);\n while (index != -1) {\n parts.push(escapeHtml(text.substring(lastIndex, index)), \"<b>\" + escapeHtml(text.substring(index, index + lowerSearch.length)) + \"</b>\");\n lastIndex = index + lowerSearch.length;\n index = lowerText.indexOf(lowerSearch, lastIndex);\n }\n parts.push(escapeHtml(text.substring(lastIndex)));\n return parts.join(\"\");\n}\nvar SPECIAL_HTML = {\n \"&\": \"&\",\n \"<\": \"<\",\n \">\": \">\",\n \"'\": \"'\",\n '\"': \""\",\n};\nfunction escapeHtml(text) {\n return text.replace(/[&<>\"'\"]/g, function (match) { return SPECIAL_HTML[match]; });\n}\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Search.ts?");
+
+/***/ }),
+
+/***/ "./default/assets/js/src/typedoc/components/Signature.ts":
+/*!***************************************************************!*\
+ !*** ./default/assets/js/src/typedoc/components/Signature.ts ***!
+ \***************************************************************/
+/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
+
+"use strict";
+eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Signature\": () => /* binding */ Signature\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _services_Viewport__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../services/Viewport */ \"./default/assets/js/src/typedoc/services/Viewport.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\n/**\n * Holds a signature and its description.\n */\nvar SignatureGroup = /** @class */ (function () {\n /**\n * Create a new SignatureGroup instance.\n *\n * @param signature The target signature.\n * @param description The description for the signature.\n */\n function SignatureGroup(signature, description) {\n this.signature = signature;\n this.description = description;\n }\n /**\n * Add the given class to all elements of the group.\n *\n * @param className The class name to add.\n */\n SignatureGroup.prototype.addClass = function (className) {\n this.signature.classList.add(className);\n this.description.classList.add(className);\n return this;\n };\n /**\n * Remove the given class from all elements of the group.\n *\n * @param className The class name to remove.\n */\n SignatureGroup.prototype.removeClass = function (className) {\n this.signature.classList.remove(className);\n this.description.classList.remove(className);\n return this;\n };\n return SignatureGroup;\n}());\n/**\n * Controls the tab like behaviour of methods and functions with multiple signatures.\n */\nvar Signature = /** @class */ (function (_super) {\n __extends(Signature, _super);\n /**\n * Create a new Signature instance.\n *\n * @param options Backbone view constructor options.\n */\n function Signature(options) {\n var _this = _super.call(this, options) || this;\n /**\n * List of found signature groups.\n */\n _this.groups = [];\n /**\n * The index of the currently displayed signature.\n */\n _this.index = -1;\n _this.createGroups();\n if (_this.container) {\n _this.el.classList.add(\"active\");\n Array.from(_this.el.children).forEach(function (signature) {\n signature.addEventListener(\"touchstart\", function (event) {\n return _this.onClick(event);\n });\n signature.addEventListener(\"click\", function (event) {\n return _this.onClick(event);\n });\n });\n _this.container.classList.add(\"active\");\n _this.setIndex(0);\n }\n return _this;\n }\n /**\n * Set the index of the active signature.\n *\n * @param index The index of the signature to activate.\n */\n Signature.prototype.setIndex = function (index) {\n if (index < 0)\n index = 0;\n if (index > this.groups.length - 1)\n index = this.groups.length - 1;\n if (this.index == index)\n return;\n var to = this.groups[index];\n if (this.index > -1) {\n var from_1 = this.groups[this.index];\n from_1.removeClass(\"current\").addClass(\"fade-out\");\n to.addClass(\"current\");\n to.addClass(\"fade-in\");\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.triggerResize();\n setTimeout(function () {\n from_1.removeClass(\"fade-out\");\n to.removeClass(\"fade-in\");\n }, 300);\n }\n else {\n to.addClass(\"current\");\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.triggerResize();\n }\n this.index = index;\n };\n /**\n * Find all signature/description groups.\n */\n Signature.prototype.createGroups = function () {\n var signatures = this.el.children;\n if (signatures.length < 2)\n return;\n this.container = this.el.nextElementSibling;\n var descriptions = this.container.children;\n this.groups = [];\n for (var index = 0; index < signatures.length; index++) {\n this.groups.push(new SignatureGroup(signatures[index], descriptions[index]));\n }\n };\n /**\n * Triggered when the user clicks onto a signature header.\n *\n * @param e The related event object.\n */\n Signature.prototype.onClick = function (e) {\n var _this = this;\n this.groups.forEach(function (group, index) {\n if (group.signature === e.currentTarget) {\n _this.setIndex(index);\n }\n });\n };\n return Signature;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Signature.ts?");
+
+/***/ }),
+
+/***/ "./default/assets/js/src/typedoc/components/Toggle.ts":
+/*!************************************************************!*\
+ !*** ./default/assets/js/src/typedoc/components/Toggle.ts ***!
+ \************************************************************/
+/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
+
+"use strict";
+eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Toggle\": () => /* binding */ Toggle\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _utils_pointer__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../utils/pointer */ \"./default/assets/js/src/typedoc/utils/pointer.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\nvar Toggle = /** @class */ (function (_super) {\n __extends(Toggle, _super);\n function Toggle(options) {\n var _this = _super.call(this, options) || this;\n _this.className = _this.el.dataset.toggle || \"\";\n _this.el.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerUp, function (e) { return _this.onPointerUp(e); });\n _this.el.addEventListener(\"click\", function (e) { return e.preventDefault(); });\n document.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerDown, function (e) {\n return _this.onDocumentPointerDown(e);\n });\n document.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerUp, function (e) {\n return _this.onDocumentPointerUp(e);\n });\n return _this;\n }\n Toggle.prototype.setActive = function (value) {\n if (this.active == value)\n return;\n this.active = value;\n document.documentElement.classList.toggle(\"has-\" + this.className, value);\n this.el.classList.toggle(\"active\", value);\n var transition = (this.active ? \"to-has-\" : \"from-has-\") + this.className;\n document.documentElement.classList.add(transition);\n setTimeout(function () { return document.documentElement.classList.remove(transition); }, 500);\n };\n Toggle.prototype.onPointerUp = function (event) {\n if (_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.hasPointerMoved)\n return;\n this.setActive(true);\n event.preventDefault();\n };\n Toggle.prototype.onDocumentPointerDown = function (e) {\n if (this.active) {\n if (e.target.closest(\".col-menu, .tsd-filter-group\")) {\n return;\n }\n this.setActive(false);\n }\n };\n Toggle.prototype.onDocumentPointerUp = function (e) {\n var _this = this;\n if (_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.hasPointerMoved)\n return;\n if (this.active) {\n if (e.target.closest(\".col-menu\")) {\n var link = e.target.closest(\"a\");\n if (link) {\n var href = window.location.href;\n if (href.indexOf(\"#\") != -1) {\n href = href.substr(0, href.indexOf(\"#\"));\n }\n if (link.href.substr(0, href.length) == href) {\n setTimeout(function () { return _this.setActive(false); }, 250);\n }\n }\n }\n }\n };\n return Toggle;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Toggle.ts?");
+
+/***/ }),
+
+/***/ "./default/assets/js/src/typedoc/services/Viewport.ts":
+/*!************************************************************!*\
+ !*** ./default/assets/js/src/typedoc/services/Viewport.ts ***!
+ \************************************************************/
+/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
+
+"use strict";
+eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Viewport\": () => /* binding */ Viewport\n/* harmony export */ });\n/* harmony import */ var _EventTarget__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../EventTarget */ \"./default/assets/js/src/typedoc/EventTarget.ts\");\n/* harmony import */ var _utils_trottle__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../utils/trottle */ \"./default/assets/js/src/typedoc/utils/trottle.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\n/**\n * A global service that monitors the window size and scroll position.\n */\nvar Viewport = /** @class */ (function (_super) {\n __extends(Viewport, _super);\n /**\n * Create new Viewport instance.\n */\n function Viewport() {\n var _this = _super.call(this) || this;\n /**\n * The current scroll position.\n */\n _this.scrollTop = 0;\n /**\n * The previous scrollTop.\n */\n _this.lastY = 0;\n /**\n * The width of the window.\n */\n _this.width = 0;\n /**\n * The height of the window.\n */\n _this.height = 0;\n /**\n * Boolean indicating whether the toolbar is shown.\n */\n _this.showToolbar = true;\n _this.toolbar = (document.querySelector(\".tsd-page-toolbar\"));\n _this.secondaryNav = (document.querySelector(\".tsd-navigation.secondary\"));\n window.addEventListener(\"scroll\", (0,_utils_trottle__WEBPACK_IMPORTED_MODULE_1__.throttle)(function () { return _this.onScroll(); }, 10));\n window.addEventListener(\"resize\", (0,_utils_trottle__WEBPACK_IMPORTED_MODULE_1__.throttle)(function () { return _this.onResize(); }, 10));\n _this.onResize();\n _this.onScroll();\n return _this;\n }\n /**\n * Trigger a resize event.\n */\n Viewport.prototype.triggerResize = function () {\n var event = new CustomEvent(\"resize\", {\n detail: {\n width: this.width,\n height: this.height,\n },\n });\n this.dispatchEvent(event);\n };\n /**\n * Triggered when the size of the window has changed.\n */\n Viewport.prototype.onResize = function () {\n this.width = window.innerWidth || 0;\n this.height = window.innerHeight || 0;\n var event = new CustomEvent(\"resize\", {\n detail: {\n width: this.width,\n height: this.height,\n },\n });\n this.dispatchEvent(event);\n };\n /**\n * Triggered when the user scrolled the viewport.\n */\n Viewport.prototype.onScroll = function () {\n this.scrollTop = window.scrollY || 0;\n var event = new CustomEvent(\"scroll\", {\n detail: {\n scrollTop: this.scrollTop,\n },\n });\n this.dispatchEvent(event);\n this.hideShowToolbar();\n };\n /**\n * Handle hiding/showing of the toolbar.\n */\n Viewport.prototype.hideShowToolbar = function () {\n var isShown = this.showToolbar;\n this.showToolbar = this.lastY >= this.scrollTop || this.scrollTop === 0;\n if (isShown !== this.showToolbar) {\n this.toolbar.classList.toggle(\"tsd-page-toolbar--hide\");\n this.secondaryNav.classList.toggle(\"tsd-navigation--toolbar-hide\");\n }\n this.lastY = this.scrollTop;\n };\n Viewport.instance = new Viewport();\n return Viewport;\n}(_EventTarget__WEBPACK_IMPORTED_MODULE_0__.EventTarget));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/services/Viewport.ts?");
+
+/***/ }),
+
+/***/ "./default/assets/js/src/typedoc/utils/debounce.ts":
+/*!*********************************************************!*\
+ !*** ./default/assets/js/src/typedoc/utils/debounce.ts ***!
+ \*********************************************************/
+/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
+
+"use strict";
+eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"debounce\": () => /* binding */ debounce\n/* harmony export */ });\nvar debounce = function (fn, wait) {\n if (wait === void 0) { wait = 100; }\n var timeout;\n return function () {\n var args = [];\n for (var _i = 0; _i < arguments.length; _i++) {\n args[_i] = arguments[_i];\n }\n clearTimeout(timeout);\n timeout = setTimeout(function () { return fn(args); }, wait);\n };\n};\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/utils/debounce.ts?");
+
+/***/ }),
+
+/***/ "./default/assets/js/src/typedoc/utils/pointer.ts":
+/*!********************************************************!*\
+ !*** ./default/assets/js/src/typedoc/utils/pointer.ts ***!
+ \********************************************************/
+/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
+
+"use strict";
+eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"pointerDown\": () => /* binding */ pointerDown,\n/* harmony export */ \"pointerMove\": () => /* binding */ pointerMove,\n/* harmony export */ \"pointerUp\": () => /* binding */ pointerUp,\n/* harmony export */ \"pointerDownPosition\": () => /* binding */ pointerDownPosition,\n/* harmony export */ \"preventNextClick\": () => /* binding */ preventNextClick,\n/* harmony export */ \"isPointerDown\": () => /* binding */ isPointerDown,\n/* harmony export */ \"isPointerTouch\": () => /* binding */ isPointerTouch,\n/* harmony export */ \"hasPointerMoved\": () => /* binding */ hasPointerMoved,\n/* harmony export */ \"isMobile\": () => /* binding */ isMobile\n/* harmony export */ });\n/**\n * Event name of the pointer down event.\n */\nvar pointerDown = \"mousedown\";\n/**\n * Event name of the pointer move event.\n */\nvar pointerMove = \"mousemove\";\n/**\n * Event name of the pointer up event.\n */\nvar pointerUp = \"mouseup\";\n/**\n * Position the pointer was pressed at.\n */\nvar pointerDownPosition = { x: 0, y: 0 };\n/**\n * Should the next click on the document be supressed?\n */\nvar preventNextClick = false;\n/**\n * Is the pointer down?\n */\nvar isPointerDown = false;\n/**\n * Is the pointer a touch point?\n */\nvar isPointerTouch = false;\n/**\n * Did the pointer move since the last down event?\n */\nvar hasPointerMoved = false;\n/**\n * Is the user agent a mobile agent?\n */\nvar isMobile = /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);\ndocument.documentElement.classList.add(isMobile ? \"is-mobile\" : \"not-mobile\");\nif (isMobile && \"ontouchstart\" in document.documentElement) {\n isPointerTouch = true;\n pointerDown = \"touchstart\";\n pointerMove = \"touchmove\";\n pointerUp = \"touchend\";\n}\ndocument.addEventListener(pointerDown, function (e) {\n isPointerDown = true;\n hasPointerMoved = false;\n var t = pointerDown == \"touchstart\"\n ? e.targetTouches[0]\n : e;\n pointerDownPosition.y = t.pageY || 0;\n pointerDownPosition.x = t.pageX || 0;\n});\ndocument.addEventListener(pointerMove, function (e) {\n if (!isPointerDown)\n return;\n if (!hasPointerMoved) {\n var t = pointerDown == \"touchstart\"\n ? e.targetTouches[0]\n : e;\n var x = pointerDownPosition.x - (t.pageX || 0);\n var y = pointerDownPosition.y - (t.pageY || 0);\n hasPointerMoved = Math.sqrt(x * x + y * y) > 10;\n }\n});\ndocument.addEventListener(pointerUp, function () {\n isPointerDown = false;\n});\ndocument.addEventListener(\"click\", function (e) {\n if (preventNextClick) {\n e.preventDefault();\n e.stopImmediatePropagation();\n preventNextClick = false;\n }\n});\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/utils/pointer.ts?");
+
+/***/ }),
+
+/***/ "./default/assets/js/src/typedoc/utils/trottle.ts":
+/*!********************************************************!*\
+ !*** ./default/assets/js/src/typedoc/utils/trottle.ts ***!
+ \********************************************************/
+/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
+
+"use strict";
+eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"throttle\": () => /* binding */ throttle\n/* harmony export */ });\nvar throttle = function (fn, wait) {\n if (wait === void 0) { wait = 100; }\n var time = Date.now();\n return function () {\n var args = [];\n for (var _i = 0; _i < arguments.length; _i++) {\n args[_i] = arguments[_i];\n }\n if (time + wait - Date.now() < 0) {\n fn.apply(void 0, args);\n time = Date.now();\n }\n };\n};\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/utils/trottle.ts?");
+
+/***/ })
+
+/******/ });
+/************************************************************************/
+/******/ // The module cache
+/******/ var __webpack_module_cache__ = {};
+/******/
+/******/ // The require function
+/******/ function __webpack_require__(moduleId) {
+/******/ // Check if module is in cache
+/******/ if(__webpack_module_cache__[moduleId]) {
+/******/ return __webpack_module_cache__[moduleId].exports;
+/******/ }
+/******/ // Create a new module (and put it into the cache)
+/******/ var module = __webpack_module_cache__[moduleId] = {
+/******/ // no module.id needed
+/******/ // no module.loaded needed
+/******/ exports: {}
+/******/ };
+/******/
+/******/ // Execute the module function
+/******/ __webpack_modules__[moduleId](module, module.exports, __webpack_require__);
+/******/
+/******/ // Return the exports of the module
+/******/ return module.exports;
+/******/ }
+/******/
+/************************************************************************/
+/******/ /* webpack/runtime/compat get default export */
+/******/ (() => {
+/******/ // getDefaultExport function for compatibility with non-harmony modules
+/******/ __webpack_require__.n = (module) => {
+/******/ var getter = module && module.__esModule ?
+/******/ () => module['default'] :
+/******/ () => module;
+/******/ __webpack_require__.d(getter, { a: getter });
+/******/ return getter;
+/******/ };
+/******/ })();
+/******/
+/******/ /* webpack/runtime/define property getters */
+/******/ (() => {
+/******/ // define getter functions for harmony exports
+/******/ __webpack_require__.d = (exports, definition) => {
+/******/ for(var key in definition) {
+/******/ if(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {
+/******/ Object.defineProperty(exports, key, { enumerable: true, get: definition[key] });
+/******/ }
+/******/ }
+/******/ };
+/******/ })();
+/******/
+/******/ /* webpack/runtime/hasOwnProperty shorthand */
+/******/ (() => {
+/******/ __webpack_require__.o = (obj, prop) => Object.prototype.hasOwnProperty.call(obj, prop)
+/******/ })();
+/******/
+/******/ /* webpack/runtime/make namespace object */
+/******/ (() => {
+/******/ // define __esModule on exports
+/******/ __webpack_require__.r = (exports) => {
+/******/ if(typeof Symbol !== 'undefined' && Symbol.toStringTag) {
+/******/ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+/******/ }
+/******/ Object.defineProperty(exports, '__esModule', { value: true });
+/******/ };
+/******/ })();
+/******/
+/************************************************************************/
+/******/ // startup
+/******/ // Load entry module
+/******/ __webpack_require__("./default/assets/js/src/bootstrap.ts");
+/******/ // This entry module used 'exports' so it can't be inlined
+/******/ })()
+;
\ No newline at end of file
--- /dev/null
+window.searchData = {"kinds":{"32":"Variable","128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method","65536":"Type literal","262144":"Accessor","4194304":"Type alias"},"rows":[{"id":0,"kind":4194304,"name":"ErrorHandler","url":"index.html#errorhandler","classes":"tsd-kind-type-alias tsd-has-type-parameter"},{"id":1,"kind":65536,"name":"__type","url":"index.html#errorhandler.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"ErrorHandler"},{"id":2,"kind":4194304,"name":"ExitHandler","url":"index.html#exithandler","classes":"tsd-kind-type-alias tsd-has-type-parameter"},{"id":3,"kind":65536,"name":"__type","url":"index.html#exithandler.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"ExitHandler"},{"id":4,"kind":256,"name":"IWorker","url":"interfaces/iworker.html","classes":"tsd-kind-interface"},{"id":5,"kind":2048,"name":"on","url":"interfaces/iworker.html#on","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"IWorker"},{"id":6,"kind":2048,"name":"once","url":"interfaces/iworker.html#once","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"IWorker"},{"id":7,"kind":4194304,"name":"OnlineHandler","url":"index.html#onlinehandler","classes":"tsd-kind-type-alias tsd-has-type-parameter"},{"id":8,"kind":65536,"name":"__type","url":"index.html#onlinehandler.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"OnlineHandler"},{"id":9,"kind":256,"name":"PoolOptions","url":"interfaces/pooloptions.html","classes":"tsd-kind-interface tsd-has-type-parameter"},{"id":10,"kind":1024,"name":"errorHandler","url":"interfaces/pooloptions.html#errorhandler","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"PoolOptions"},{"id":11,"kind":1024,"name":"onlineHandler","url":"interfaces/pooloptions.html#onlinehandler","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"PoolOptions"},{"id":12,"kind":1024,"name":"exitHandler","url":"interfaces/pooloptions.html#exithandler","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"PoolOptions"},{"id":13,"kind":1024,"name":"workerChoiceStrategy","url":"interfaces/pooloptions.html#workerchoicestrategy","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"PoolOptions"},{"id":14,"kind":128,"name":"DynamicClusterPool","url":"classes/dynamicclusterpool.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":15,"kind":512,"name":"constructor","url":"classes/dynamicclusterpool.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited","parent":"DynamicClusterPool"},{"id":16,"kind":1024,"name":"max","url":"classes/dynamicclusterpool.html#max","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DynamicClusterPool"},{"id":17,"kind":262144,"name":"dynamic","url":"classes/dynamicclusterpool.html#dynamic","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"DynamicClusterPool"},{"id":18,"kind":1024,"name":"opts","url":"classes/dynamicclusterpool.html#opts","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"DynamicClusterPool"},{"id":19,"kind":2048,"name":"setupHook","url":"classes/dynamicclusterpool.html#setuphook","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicClusterPool"},{"id":20,"kind":2048,"name":"isMain","url":"classes/dynamicclusterpool.html#ismain","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicClusterPool"},{"id":21,"kind":2048,"name":"destroyWorker","url":"classes/dynamicclusterpool.html#destroyworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"DynamicClusterPool"},{"id":22,"kind":2048,"name":"sendToWorker","url":"classes/dynamicclusterpool.html#sendtoworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicClusterPool"},{"id":23,"kind":2048,"name":"registerWorkerMessageListener","url":"classes/dynamicclusterpool.html#registerworkermessagelistener","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited","parent":"DynamicClusterPool"},{"id":24,"kind":2048,"name":"createWorker","url":"classes/dynamicclusterpool.html#createworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicClusterPool"},{"id":25,"kind":2048,"name":"afterWorkerSetup","url":"classes/dynamicclusterpool.html#afterworkersetup","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicClusterPool"},{"id":26,"kind":1024,"name":"workers","url":"classes/dynamicclusterpool.html#workers","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"DynamicClusterPool"},{"id":27,"kind":1024,"name":"tasks","url":"classes/dynamicclusterpool.html#tasks","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"DynamicClusterPool"},{"id":28,"kind":1024,"name":"emitter","url":"classes/dynamicclusterpool.html#emitter","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"DynamicClusterPool"},{"id":29,"kind":1024,"name":"promiseMap","url":"classes/dynamicclusterpool.html#promisemap","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicClusterPool"},{"id":30,"kind":1024,"name":"nextMessageId","url":"classes/dynamicclusterpool.html#nextmessageid","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicClusterPool"},{"id":31,"kind":1024,"name":"workerChoiceStrategyContext","url":"classes/dynamicclusterpool.html#workerchoicestrategycontext","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicClusterPool"},{"id":32,"kind":1024,"name":"numberOfWorkers","url":"classes/dynamicclusterpool.html#numberofworkers","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"DynamicClusterPool"},{"id":33,"kind":1024,"name":"filePath","url":"classes/dynamicclusterpool.html#filepath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"DynamicClusterPool"},{"id":34,"kind":2048,"name":"setWorkerChoiceStrategy","url":"classes/dynamicclusterpool.html#setworkerchoicestrategy","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"DynamicClusterPool"},{"id":35,"kind":2048,"name":"execute","url":"classes/dynamicclusterpool.html#execute","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"DynamicClusterPool"},{"id":36,"kind":2048,"name":"destroy","url":"classes/dynamicclusterpool.html#destroy","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"DynamicClusterPool"},{"id":37,"kind":2048,"name":"increaseWorkersTask","url":"classes/dynamicclusterpool.html#increaseworkerstask","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicClusterPool"},{"id":38,"kind":2048,"name":"decreaseWorkersTasks","url":"classes/dynamicclusterpool.html#decreaseworkerstasks","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicClusterPool"},{"id":39,"kind":2048,"name":"removeWorker","url":"classes/dynamicclusterpool.html#removeworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicClusterPool"},{"id":40,"kind":2048,"name":"chooseWorker","url":"classes/dynamicclusterpool.html#chooseworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicClusterPool"},{"id":41,"kind":2048,"name":"internalExecute","url":"classes/dynamicclusterpool.html#internalexecute","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicClusterPool"},{"id":42,"kind":2048,"name":"createAndSetupWorker","url":"classes/dynamicclusterpool.html#createandsetupworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicClusterPool"},{"id":43,"kind":2048,"name":"workerListener","url":"classes/dynamicclusterpool.html#workerlistener","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicClusterPool"},{"id":44,"kind":128,"name":"FixedClusterPool","url":"classes/fixedclusterpool.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":45,"kind":512,"name":"constructor","url":"classes/fixedclusterpool.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter","parent":"FixedClusterPool"},{"id":46,"kind":1024,"name":"opts","url":"classes/fixedclusterpool.html#opts","classes":"tsd-kind-property tsd-parent-kind-class","parent":"FixedClusterPool"},{"id":47,"kind":2048,"name":"setupHook","url":"classes/fixedclusterpool.html#setuphook","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"FixedClusterPool"},{"id":48,"kind":2048,"name":"isMain","url":"classes/fixedclusterpool.html#ismain","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"FixedClusterPool"},{"id":49,"kind":2048,"name":"destroyWorker","url":"classes/fixedclusterpool.html#destroyworker","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FixedClusterPool"},{"id":50,"kind":2048,"name":"sendToWorker","url":"classes/fixedclusterpool.html#sendtoworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"FixedClusterPool"},{"id":51,"kind":2048,"name":"registerWorkerMessageListener","url":"classes/fixedclusterpool.html#registerworkermessagelistener","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"FixedClusterPool"},{"id":52,"kind":2048,"name":"createWorker","url":"classes/fixedclusterpool.html#createworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"FixedClusterPool"},{"id":53,"kind":2048,"name":"afterWorkerSetup","url":"classes/fixedclusterpool.html#afterworkersetup","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"FixedClusterPool"},{"id":54,"kind":1024,"name":"workers","url":"classes/fixedclusterpool.html#workers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"FixedClusterPool"},{"id":55,"kind":1024,"name":"tasks","url":"classes/fixedclusterpool.html#tasks","classes":"tsd-kind-property tsd-parent-kind-class","parent":"FixedClusterPool"},{"id":56,"kind":1024,"name":"emitter","url":"classes/fixedclusterpool.html#emitter","classes":"tsd-kind-property tsd-parent-kind-class","parent":"FixedClusterPool"},{"id":57,"kind":1024,"name":"promiseMap","url":"classes/fixedclusterpool.html#promisemap","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"FixedClusterPool"},{"id":58,"kind":1024,"name":"nextMessageId","url":"classes/fixedclusterpool.html#nextmessageid","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"FixedClusterPool"},{"id":59,"kind":1024,"name":"workerChoiceStrategyContext","url":"classes/fixedclusterpool.html#workerchoicestrategycontext","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"FixedClusterPool"},{"id":60,"kind":1024,"name":"numberOfWorkers","url":"classes/fixedclusterpool.html#numberofworkers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"FixedClusterPool"},{"id":61,"kind":1024,"name":"filePath","url":"classes/fixedclusterpool.html#filepath","classes":"tsd-kind-property tsd-parent-kind-class","parent":"FixedClusterPool"},{"id":62,"kind":262144,"name":"dynamic","url":"classes/fixedclusterpool.html#dynamic","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"FixedClusterPool"},{"id":63,"kind":2048,"name":"setWorkerChoiceStrategy","url":"classes/fixedclusterpool.html#setworkerchoicestrategy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FixedClusterPool"},{"id":64,"kind":2048,"name":"execute","url":"classes/fixedclusterpool.html#execute","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FixedClusterPool"},{"id":65,"kind":2048,"name":"destroy","url":"classes/fixedclusterpool.html#destroy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FixedClusterPool"},{"id":66,"kind":2048,"name":"increaseWorkersTask","url":"classes/fixedclusterpool.html#increaseworkerstask","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"FixedClusterPool"},{"id":67,"kind":2048,"name":"decreaseWorkersTasks","url":"classes/fixedclusterpool.html#decreaseworkerstasks","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"FixedClusterPool"},{"id":68,"kind":2048,"name":"removeWorker","url":"classes/fixedclusterpool.html#removeworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"FixedClusterPool"},{"id":69,"kind":2048,"name":"chooseWorker","url":"classes/fixedclusterpool.html#chooseworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"FixedClusterPool"},{"id":70,"kind":2048,"name":"internalExecute","url":"classes/fixedclusterpool.html#internalexecute","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"FixedClusterPool"},{"id":71,"kind":2048,"name":"createAndSetupWorker","url":"classes/fixedclusterpool.html#createandsetupworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"FixedClusterPool"},{"id":72,"kind":2048,"name":"workerListener","url":"classes/fixedclusterpool.html#workerlistener","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"FixedClusterPool"},{"id":73,"kind":256,"name":"ClusterPoolOptions","url":"interfaces/clusterpooloptions.html","classes":"tsd-kind-interface"},{"id":74,"kind":1024,"name":"env","url":"interfaces/clusterpooloptions.html#env","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ClusterPoolOptions"},{"id":75,"kind":1024,"name":"errorHandler","url":"interfaces/clusterpooloptions.html#errorhandler","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ClusterPoolOptions"},{"id":76,"kind":1024,"name":"onlineHandler","url":"interfaces/clusterpooloptions.html#onlinehandler","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ClusterPoolOptions"},{"id":77,"kind":1024,"name":"exitHandler","url":"interfaces/clusterpooloptions.html#exithandler","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ClusterPoolOptions"},{"id":78,"kind":1024,"name":"workerChoiceStrategy","url":"interfaces/clusterpooloptions.html#workerchoicestrategy","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ClusterPoolOptions"},{"id":79,"kind":256,"name":"IPool","url":"interfaces/ipool.html","classes":"tsd-kind-interface tsd-has-type-parameter"},{"id":80,"kind":2048,"name":"execute","url":"interfaces/ipool.html#execute","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"IPool"},{"id":81,"kind":2048,"name":"destroy","url":"interfaces/ipool.html#destroy","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"IPool"},{"id":82,"kind":2048,"name":"setWorkerChoiceStrategy","url":"interfaces/ipool.html#setworkerchoicestrategy","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"IPool"},{"id":83,"kind":32,"name":"WorkerChoiceStrategies","url":"index.html#workerchoicestrategies","classes":"tsd-kind-variable"},{"id":84,"kind":4194304,"name":"WorkerChoiceStrategy","url":"index.html#workerchoicestrategy","classes":"tsd-kind-type-alias"},{"id":85,"kind":128,"name":"DynamicThreadPool","url":"classes/dynamicthreadpool.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":86,"kind":512,"name":"constructor","url":"classes/dynamicthreadpool.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited","parent":"DynamicThreadPool"},{"id":87,"kind":1024,"name":"max","url":"classes/dynamicthreadpool.html#max","classes":"tsd-kind-property tsd-parent-kind-class","parent":"DynamicThreadPool"},{"id":88,"kind":262144,"name":"dynamic","url":"classes/dynamicthreadpool.html#dynamic","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"DynamicThreadPool"},{"id":89,"kind":2048,"name":"isMain","url":"classes/dynamicthreadpool.html#ismain","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicThreadPool"},{"id":90,"kind":2048,"name":"destroyWorker","url":"classes/dynamicthreadpool.html#destroyworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"DynamicThreadPool"},{"id":91,"kind":2048,"name":"sendToWorker","url":"classes/dynamicthreadpool.html#sendtoworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicThreadPool"},{"id":92,"kind":2048,"name":"registerWorkerMessageListener","url":"classes/dynamicthreadpool.html#registerworkermessagelistener","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited","parent":"DynamicThreadPool"},{"id":93,"kind":2048,"name":"createWorker","url":"classes/dynamicthreadpool.html#createworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicThreadPool"},{"id":94,"kind":2048,"name":"afterWorkerSetup","url":"classes/dynamicthreadpool.html#afterworkersetup","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicThreadPool"},{"id":95,"kind":1024,"name":"workers","url":"classes/dynamicthreadpool.html#workers","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"DynamicThreadPool"},{"id":96,"kind":1024,"name":"tasks","url":"classes/dynamicthreadpool.html#tasks","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"DynamicThreadPool"},{"id":97,"kind":1024,"name":"emitter","url":"classes/dynamicthreadpool.html#emitter","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"DynamicThreadPool"},{"id":98,"kind":1024,"name":"promiseMap","url":"classes/dynamicthreadpool.html#promisemap","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicThreadPool"},{"id":99,"kind":1024,"name":"nextMessageId","url":"classes/dynamicthreadpool.html#nextmessageid","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicThreadPool"},{"id":100,"kind":1024,"name":"workerChoiceStrategyContext","url":"classes/dynamicthreadpool.html#workerchoicestrategycontext","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicThreadPool"},{"id":101,"kind":1024,"name":"numberOfWorkers","url":"classes/dynamicthreadpool.html#numberofworkers","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"DynamicThreadPool"},{"id":102,"kind":1024,"name":"filePath","url":"classes/dynamicthreadpool.html#filepath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"DynamicThreadPool"},{"id":103,"kind":1024,"name":"opts","url":"classes/dynamicthreadpool.html#opts","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"DynamicThreadPool"},{"id":104,"kind":2048,"name":"setWorkerChoiceStrategy","url":"classes/dynamicthreadpool.html#setworkerchoicestrategy","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"DynamicThreadPool"},{"id":105,"kind":2048,"name":"execute","url":"classes/dynamicthreadpool.html#execute","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"DynamicThreadPool"},{"id":106,"kind":2048,"name":"destroy","url":"classes/dynamicthreadpool.html#destroy","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"DynamicThreadPool"},{"id":107,"kind":2048,"name":"setupHook","url":"classes/dynamicthreadpool.html#setuphook","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicThreadPool"},{"id":108,"kind":2048,"name":"increaseWorkersTask","url":"classes/dynamicthreadpool.html#increaseworkerstask","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicThreadPool"},{"id":109,"kind":2048,"name":"decreaseWorkersTasks","url":"classes/dynamicthreadpool.html#decreaseworkerstasks","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicThreadPool"},{"id":110,"kind":2048,"name":"removeWorker","url":"classes/dynamicthreadpool.html#removeworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicThreadPool"},{"id":111,"kind":2048,"name":"chooseWorker","url":"classes/dynamicthreadpool.html#chooseworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicThreadPool"},{"id":112,"kind":2048,"name":"internalExecute","url":"classes/dynamicthreadpool.html#internalexecute","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicThreadPool"},{"id":113,"kind":2048,"name":"createAndSetupWorker","url":"classes/dynamicthreadpool.html#createandsetupworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicThreadPool"},{"id":114,"kind":2048,"name":"workerListener","url":"classes/dynamicthreadpool.html#workerlistener","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"DynamicThreadPool"},{"id":115,"kind":128,"name":"FixedThreadPool","url":"classes/fixedthreadpool.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":116,"kind":512,"name":"constructor","url":"classes/fixedthreadpool.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter","parent":"FixedThreadPool"},{"id":117,"kind":2048,"name":"isMain","url":"classes/fixedthreadpool.html#ismain","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"FixedThreadPool"},{"id":118,"kind":2048,"name":"destroyWorker","url":"classes/fixedthreadpool.html#destroyworker","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FixedThreadPool"},{"id":119,"kind":2048,"name":"sendToWorker","url":"classes/fixedthreadpool.html#sendtoworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"FixedThreadPool"},{"id":120,"kind":2048,"name":"registerWorkerMessageListener","url":"classes/fixedthreadpool.html#registerworkermessagelistener","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"FixedThreadPool"},{"id":121,"kind":2048,"name":"createWorker","url":"classes/fixedthreadpool.html#createworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"FixedThreadPool"},{"id":122,"kind":2048,"name":"afterWorkerSetup","url":"classes/fixedthreadpool.html#afterworkersetup","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"FixedThreadPool"},{"id":123,"kind":1024,"name":"workers","url":"classes/fixedthreadpool.html#workers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"FixedThreadPool"},{"id":124,"kind":1024,"name":"tasks","url":"classes/fixedthreadpool.html#tasks","classes":"tsd-kind-property tsd-parent-kind-class","parent":"FixedThreadPool"},{"id":125,"kind":1024,"name":"emitter","url":"classes/fixedthreadpool.html#emitter","classes":"tsd-kind-property tsd-parent-kind-class","parent":"FixedThreadPool"},{"id":126,"kind":1024,"name":"promiseMap","url":"classes/fixedthreadpool.html#promisemap","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"FixedThreadPool"},{"id":127,"kind":1024,"name":"nextMessageId","url":"classes/fixedthreadpool.html#nextmessageid","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"FixedThreadPool"},{"id":128,"kind":1024,"name":"workerChoiceStrategyContext","url":"classes/fixedthreadpool.html#workerchoicestrategycontext","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"FixedThreadPool"},{"id":129,"kind":1024,"name":"numberOfWorkers","url":"classes/fixedthreadpool.html#numberofworkers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"FixedThreadPool"},{"id":130,"kind":1024,"name":"filePath","url":"classes/fixedthreadpool.html#filepath","classes":"tsd-kind-property tsd-parent-kind-class","parent":"FixedThreadPool"},{"id":131,"kind":1024,"name":"opts","url":"classes/fixedthreadpool.html#opts","classes":"tsd-kind-property tsd-parent-kind-class","parent":"FixedThreadPool"},{"id":132,"kind":262144,"name":"dynamic","url":"classes/fixedthreadpool.html#dynamic","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"FixedThreadPool"},{"id":133,"kind":2048,"name":"setWorkerChoiceStrategy","url":"classes/fixedthreadpool.html#setworkerchoicestrategy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FixedThreadPool"},{"id":134,"kind":2048,"name":"execute","url":"classes/fixedthreadpool.html#execute","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FixedThreadPool"},{"id":135,"kind":2048,"name":"destroy","url":"classes/fixedthreadpool.html#destroy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"FixedThreadPool"},{"id":136,"kind":2048,"name":"setupHook","url":"classes/fixedthreadpool.html#setuphook","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"FixedThreadPool"},{"id":137,"kind":2048,"name":"increaseWorkersTask","url":"classes/fixedthreadpool.html#increaseworkerstask","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"FixedThreadPool"},{"id":138,"kind":2048,"name":"decreaseWorkersTasks","url":"classes/fixedthreadpool.html#decreaseworkerstasks","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"FixedThreadPool"},{"id":139,"kind":2048,"name":"removeWorker","url":"classes/fixedthreadpool.html#removeworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"FixedThreadPool"},{"id":140,"kind":2048,"name":"chooseWorker","url":"classes/fixedthreadpool.html#chooseworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"FixedThreadPool"},{"id":141,"kind":2048,"name":"internalExecute","url":"classes/fixedthreadpool.html#internalexecute","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"FixedThreadPool"},{"id":142,"kind":2048,"name":"createAndSetupWorker","url":"classes/fixedthreadpool.html#createandsetupworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"FixedThreadPool"},{"id":143,"kind":2048,"name":"workerListener","url":"classes/fixedthreadpool.html#workerlistener","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"FixedThreadPool"},{"id":144,"kind":4194304,"name":"ThreadWorkerWithMessageChannel","url":"index.html#threadworkerwithmessagechannel","classes":"tsd-kind-type-alias"},{"id":145,"kind":128,"name":"AbstractWorker","url":"classes/abstractworker.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":146,"kind":512,"name":"constructor","url":"classes/abstractworker.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter","parent":"AbstractWorker"},{"id":147,"kind":1024,"name":"maxInactiveTime","url":"classes/abstractworker.html#maxinactivetime","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"AbstractWorker"},{"id":148,"kind":1024,"name":"killBehavior","url":"classes/abstractworker.html#killbehavior","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"AbstractWorker"},{"id":149,"kind":1024,"name":"async","url":"classes/abstractworker.html#async","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"AbstractWorker"},{"id":150,"kind":1024,"name":"lastTask","url":"classes/abstractworker.html#lasttask","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"AbstractWorker"},{"id":151,"kind":1024,"name":"interval","url":"classes/abstractworker.html#interval","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"AbstractWorker"},{"id":152,"kind":1024,"name":"mainWorker","url":"classes/abstractworker.html#mainworker","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"AbstractWorker"},{"id":153,"kind":1024,"name":"opts","url":"classes/abstractworker.html#opts","classes":"tsd-kind-property tsd-parent-kind-class","parent":"AbstractWorker"},{"id":154,"kind":2048,"name":"checkFunctionInput","url":"classes/abstractworker.html#checkfunctioninput","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"AbstractWorker"},{"id":155,"kind":2048,"name":"getMainWorker","url":"classes/abstractworker.html#getmainworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"AbstractWorker"},{"id":156,"kind":2048,"name":"sendToMainWorker","url":"classes/abstractworker.html#sendtomainworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"AbstractWorker"},{"id":157,"kind":2048,"name":"checkAlive","url":"classes/abstractworker.html#checkalive","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"AbstractWorker"},{"id":158,"kind":2048,"name":"handleError","url":"classes/abstractworker.html#handleerror","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"AbstractWorker"},{"id":159,"kind":2048,"name":"run","url":"classes/abstractworker.html#run","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"AbstractWorker"},{"id":160,"kind":2048,"name":"runAsync","url":"classes/abstractworker.html#runasync","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-protected","parent":"AbstractWorker"},{"id":161,"kind":128,"name":"ClusterWorker","url":"classes/clusterworker.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":162,"kind":512,"name":"constructor","url":"classes/clusterworker.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited","parent":"ClusterWorker"},{"id":163,"kind":2048,"name":"sendToMainWorker","url":"classes/clusterworker.html#sendtomainworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"ClusterWorker"},{"id":164,"kind":2048,"name":"handleError","url":"classes/clusterworker.html#handleerror","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"ClusterWorker"},{"id":165,"kind":1024,"name":"maxInactiveTime","url":"classes/clusterworker.html#maxinactivetime","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"ClusterWorker"},{"id":166,"kind":1024,"name":"killBehavior","url":"classes/clusterworker.html#killbehavior","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"ClusterWorker"},{"id":167,"kind":1024,"name":"async","url":"classes/clusterworker.html#async","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"ClusterWorker"},{"id":168,"kind":1024,"name":"lastTask","url":"classes/clusterworker.html#lasttask","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"ClusterWorker"},{"id":169,"kind":1024,"name":"interval","url":"classes/clusterworker.html#interval","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"ClusterWorker"},{"id":170,"kind":1024,"name":"mainWorker","url":"classes/clusterworker.html#mainworker","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"ClusterWorker"},{"id":171,"kind":1024,"name":"opts","url":"classes/clusterworker.html#opts","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"ClusterWorker"},{"id":172,"kind":2048,"name":"getMainWorker","url":"classes/clusterworker.html#getmainworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"ClusterWorker"},{"id":173,"kind":2048,"name":"checkAlive","url":"classes/clusterworker.html#checkalive","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"ClusterWorker"},{"id":174,"kind":2048,"name":"run","url":"classes/clusterworker.html#run","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"ClusterWorker"},{"id":175,"kind":2048,"name":"runAsync","url":"classes/clusterworker.html#runasync","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"ClusterWorker"},{"id":176,"kind":128,"name":"ThreadWorker","url":"classes/threadworker.html","classes":"tsd-kind-class tsd-has-type-parameter"},{"id":177,"kind":512,"name":"constructor","url":"classes/threadworker.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited","parent":"ThreadWorker"},{"id":178,"kind":2048,"name":"sendToMainWorker","url":"classes/threadworker.html#sendtomainworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected","parent":"ThreadWorker"},{"id":179,"kind":1024,"name":"maxInactiveTime","url":"classes/threadworker.html#maxinactivetime","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"ThreadWorker"},{"id":180,"kind":1024,"name":"killBehavior","url":"classes/threadworker.html#killbehavior","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"ThreadWorker"},{"id":181,"kind":1024,"name":"async","url":"classes/threadworker.html#async","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"ThreadWorker"},{"id":182,"kind":1024,"name":"lastTask","url":"classes/threadworker.html#lasttask","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"ThreadWorker"},{"id":183,"kind":1024,"name":"interval","url":"classes/threadworker.html#interval","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"ThreadWorker"},{"id":184,"kind":1024,"name":"mainWorker","url":"classes/threadworker.html#mainworker","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"ThreadWorker"},{"id":185,"kind":1024,"name":"opts","url":"classes/threadworker.html#opts","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"ThreadWorker"},{"id":186,"kind":2048,"name":"getMainWorker","url":"classes/threadworker.html#getmainworker","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"ThreadWorker"},{"id":187,"kind":2048,"name":"checkAlive","url":"classes/threadworker.html#checkalive","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"ThreadWorker"},{"id":188,"kind":2048,"name":"handleError","url":"classes/threadworker.html#handleerror","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"ThreadWorker"},{"id":189,"kind":2048,"name":"run","url":"classes/threadworker.html#run","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"ThreadWorker"},{"id":190,"kind":2048,"name":"runAsync","url":"classes/threadworker.html#runasync","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"ThreadWorker"},{"id":191,"kind":32,"name":"KillBehaviors","url":"index.html#killbehaviors","classes":"tsd-kind-variable"},{"id":192,"kind":4194304,"name":"KillBehavior","url":"index.html#killbehavior","classes":"tsd-kind-type-alias"},{"id":193,"kind":256,"name":"WorkerOptions","url":"interfaces/workeroptions.html","classes":"tsd-kind-interface"},{"id":194,"kind":1024,"name":"maxInactiveTime","url":"interfaces/workeroptions.html#maxinactivetime","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WorkerOptions"},{"id":195,"kind":1024,"name":"async","url":"interfaces/workeroptions.html#async","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WorkerOptions"},{"id":196,"kind":1024,"name":"killBehavior","url":"interfaces/workeroptions.html#killbehavior","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WorkerOptions"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,37.842]],["parent/0",[]],["name/1",[1,40.355]],["parent/1",[0,3.617]],["name/2",[2,37.842]],["parent/2",[]],["name/3",[1,40.355]],["parent/3",[2,3.617]],["name/4",[3,40.355]],["parent/4",[]],["name/5",[4,48.828]],["parent/5",[3,3.857]],["name/6",[5,48.828]],["parent/6",[3,3.857]],["name/7",[6,37.842]],["parent/7",[]],["name/8",[1,40.355]],["parent/8",[6,3.617]],["name/9",[7,35.835]],["parent/9",[]],["name/10",[0,37.842]],["parent/10",[7,3.425]],["name/11",[6,37.842]],["parent/11",[7,3.425]],["name/12",[2,37.842]],["parent/12",[7,3.425]],["name/13",[8,40.355]],["parent/13",[7,3.425]],["name/14",[9,18.705]],["parent/14",[]],["name/15",[10,32.734]],["parent/15",[9,1.788]],["name/16",[11,43.72]],["parent/16",[9,1.788]],["name/17",[12,37.842]],["parent/17",[9,1.788]],["name/18",[13,32.734]],["parent/18",[9,1.788]],["name/19",[14,37.842]],["parent/19",[9,1.788]],["name/20",[15,37.842]],["parent/20",[9,1.788]],["name/21",[16,37.842]],["parent/21",[9,1.788]],["name/22",[17,37.842]],["parent/22",[9,1.788]],["name/23",[18,37.842]],["parent/23",[9,1.788]],["name/24",[19,37.842]],["parent/24",[9,1.788]],["name/25",[20,37.842]],["parent/25",[9,1.788]],["name/26",[21,37.842]],["parent/26",[9,1.788]],["name/27",[22,37.842]],["parent/27",[9,1.788]],["name/28",[23,37.842]],["parent/28",[9,1.788]],["name/29",[24,37.842]],["parent/29",[9,1.788]],["name/30",[25,37.842]],["parent/30",[9,1.788]],["name/31",[26,37.842]],["parent/31",[9,1.788]],["name/32",[27,37.842]],["parent/32",[9,1.788]],["name/33",[28,37.842]],["parent/33",[9,1.788]],["name/34",[29,35.835]],["parent/34",[9,1.788]],["name/35",[30,35.835]],["parent/35",[9,1.788]],["name/36",[31,35.835]],["parent/36",[9,1.788]],["name/37",[32,37.842]],["parent/37",[9,1.788]],["name/38",[33,37.842]],["parent/38",[9,1.788]],["name/39",[34,37.842]],["parent/39",[9,1.788]],["name/40",[35,37.842]],["parent/40",[9,1.788]],["name/41",[36,37.842]],["parent/41",[9,1.788]],["name/42",[37,37.842]],["parent/42",[9,1.788]],["name/43",[38,37.842]],["parent/43",[9,1.788]],["name/44",[39,19.039]],["parent/44",[]],["name/45",[10,32.734]],["parent/45",[39,1.82]],["name/46",[13,32.734]],["parent/46",[39,1.82]],["name/47",[14,37.842]],["parent/47",[39,1.82]],["name/48",[15,37.842]],["parent/48",[39,1.82]],["name/49",[16,37.842]],["parent/49",[39,1.82]],["name/50",[17,37.842]],["parent/50",[39,1.82]],["name/51",[18,37.842]],["parent/51",[39,1.82]],["name/52",[19,37.842]],["parent/52",[39,1.82]],["name/53",[20,37.842]],["parent/53",[39,1.82]],["name/54",[21,37.842]],["parent/54",[39,1.82]],["name/55",[22,37.842]],["parent/55",[39,1.82]],["name/56",[23,37.842]],["parent/56",[39,1.82]],["name/57",[24,37.842]],["parent/57",[39,1.82]],["name/58",[25,37.842]],["parent/58",[39,1.82]],["name/59",[26,37.842]],["parent/59",[39,1.82]],["name/60",[27,37.842]],["parent/60",[39,1.82]],["name/61",[28,37.842]],["parent/61",[39,1.82]],["name/62",[12,37.842]],["parent/62",[39,1.82]],["name/63",[29,35.835]],["parent/63",[39,1.82]],["name/64",[30,35.835]],["parent/64",[39,1.82]],["name/65",[31,35.835]],["parent/65",[39,1.82]],["name/66",[32,37.842]],["parent/66",[39,1.82]],["name/67",[33,37.842]],["parent/67",[39,1.82]],["name/68",[34,37.842]],["parent/68",[39,1.82]],["name/69",[35,37.842]],["parent/69",[39,1.82]],["name/70",[36,37.842]],["parent/70",[39,1.82]],["name/71",[37,37.842]],["parent/71",[39,1.82]],["name/72",[38,37.842]],["parent/72",[39,1.82]],["name/73",[40,34.165]],["parent/73",[]],["name/74",[41,48.828]],["parent/74",[40,3.266]],["name/75",[0,37.842]],["parent/75",[40,3.266]],["name/76",[6,37.842]],["parent/76",[40,3.266]],["name/77",[2,37.842]],["parent/77",[40,3.266]],["name/78",[8,40.355]],["parent/78",[40,3.266]],["name/79",[42,37.842]],["parent/79",[]],["name/80",[30,35.835]],["parent/80",[42,3.617]],["name/81",[31,35.835]],["parent/81",[42,3.617]],["name/82",[29,35.835]],["parent/82",[42,3.617]],["name/83",[43,48.828]],["parent/83",[]],["name/84",[8,40.355]],["parent/84",[]],["name/85",[44,18.705]],["parent/85",[]],["name/86",[10,32.734]],["parent/86",[44,1.788]],["name/87",[11,43.72]],["parent/87",[44,1.788]],["name/88",[12,37.842]],["parent/88",[44,1.788]],["name/89",[15,37.842]],["parent/89",[44,1.788]],["name/90",[16,37.842]],["parent/90",[44,1.788]],["name/91",[17,37.842]],["parent/91",[44,1.788]],["name/92",[18,37.842]],["parent/92",[44,1.788]],["name/93",[19,37.842]],["parent/93",[44,1.788]],["name/94",[20,37.842]],["parent/94",[44,1.788]],["name/95",[21,37.842]],["parent/95",[44,1.788]],["name/96",[22,37.842]],["parent/96",[44,1.788]],["name/97",[23,37.842]],["parent/97",[44,1.788]],["name/98",[24,37.842]],["parent/98",[44,1.788]],["name/99",[25,37.842]],["parent/99",[44,1.788]],["name/100",[26,37.842]],["parent/100",[44,1.788]],["name/101",[27,37.842]],["parent/101",[44,1.788]],["name/102",[28,37.842]],["parent/102",[44,1.788]],["name/103",[13,32.734]],["parent/103",[44,1.788]],["name/104",[29,35.835]],["parent/104",[44,1.788]],["name/105",[30,35.835]],["parent/105",[44,1.788]],["name/106",[31,35.835]],["parent/106",[44,1.788]],["name/107",[14,37.842]],["parent/107",[44,1.788]],["name/108",[32,37.842]],["parent/108",[44,1.788]],["name/109",[33,37.842]],["parent/109",[44,1.788]],["name/110",[34,37.842]],["parent/110",[44,1.788]],["name/111",[35,37.842]],["parent/111",[44,1.788]],["name/112",[36,37.842]],["parent/112",[44,1.788]],["name/113",[37,37.842]],["parent/113",[44,1.788]],["name/114",[38,37.842]],["parent/114",[44,1.788]],["name/115",[45,19.039]],["parent/115",[]],["name/116",[10,32.734]],["parent/116",[45,1.82]],["name/117",[15,37.842]],["parent/117",[45,1.82]],["name/118",[16,37.842]],["parent/118",[45,1.82]],["name/119",[17,37.842]],["parent/119",[45,1.82]],["name/120",[18,37.842]],["parent/120",[45,1.82]],["name/121",[19,37.842]],["parent/121",[45,1.82]],["name/122",[20,37.842]],["parent/122",[45,1.82]],["name/123",[21,37.842]],["parent/123",[45,1.82]],["name/124",[22,37.842]],["parent/124",[45,1.82]],["name/125",[23,37.842]],["parent/125",[45,1.82]],["name/126",[24,37.842]],["parent/126",[45,1.82]],["name/127",[25,37.842]],["parent/127",[45,1.82]],["name/128",[26,37.842]],["parent/128",[45,1.82]],["name/129",[27,37.842]],["parent/129",[45,1.82]],["name/130",[28,37.842]],["parent/130",[45,1.82]],["name/131",[13,32.734]],["parent/131",[45,1.82]],["name/132",[12,37.842]],["parent/132",[45,1.82]],["name/133",[29,35.835]],["parent/133",[45,1.82]],["name/134",[30,35.835]],["parent/134",[45,1.82]],["name/135",[31,35.835]],["parent/135",[45,1.82]],["name/136",[14,37.842]],["parent/136",[45,1.82]],["name/137",[32,37.842]],["parent/137",[45,1.82]],["name/138",[33,37.842]],["parent/138",[45,1.82]],["name/139",[34,37.842]],["parent/139",[45,1.82]],["name/140",[35,37.842]],["parent/140",[45,1.82]],["name/141",[36,37.842]],["parent/141",[45,1.82]],["name/142",[37,37.842]],["parent/142",[45,1.82]],["name/143",[38,37.842]],["parent/143",[45,1.82]],["name/144",[46,48.828]],["parent/144",[]],["name/145",[47,24.849]],["parent/145",[]],["name/146",[10,32.734]],["parent/146",[47,2.375]],["name/147",[48,37.842]],["parent/147",[47,2.375]],["name/148",[49,35.835]],["parent/148",[47,2.375]],["name/149",[50,37.842]],["parent/149",[47,2.375]],["name/150",[51,40.355]],["parent/150",[47,2.375]],["name/151",[52,40.355]],["parent/151",[47,2.375]],["name/152",[53,40.355]],["parent/152",[47,2.375]],["name/153",[13,32.734]],["parent/153",[47,2.375]],["name/154",[54,48.828]],["parent/154",[47,2.375]],["name/155",[55,40.355]],["parent/155",[47,2.375]],["name/156",[56,40.355]],["parent/156",[47,2.375]],["name/157",[57,40.355]],["parent/157",[47,2.375]],["name/158",[58,40.355]],["parent/158",[47,2.375]],["name/159",[59,40.355]],["parent/159",[47,2.375]],["name/160",[60,40.355]],["parent/160",[47,2.375]],["name/161",[61,25.474]],["parent/161",[]],["name/162",[10,32.734]],["parent/162",[61,2.435]],["name/163",[56,40.355]],["parent/163",[61,2.435]],["name/164",[58,40.355]],["parent/164",[61,2.435]],["name/165",[48,37.842]],["parent/165",[61,2.435]],["name/166",[49,35.835]],["parent/166",[61,2.435]],["name/167",[50,37.842]],["parent/167",[61,2.435]],["name/168",[51,40.355]],["parent/168",[61,2.435]],["name/169",[52,40.355]],["parent/169",[61,2.435]],["name/170",[53,40.355]],["parent/170",[61,2.435]],["name/171",[13,32.734]],["parent/171",[61,2.435]],["name/172",[55,40.355]],["parent/172",[61,2.435]],["name/173",[57,40.355]],["parent/173",[61,2.435]],["name/174",[59,40.355]],["parent/174",[61,2.435]],["name/175",[60,40.355]],["parent/175",[61,2.435]],["name/176",[62,25.474]],["parent/176",[]],["name/177",[10,32.734]],["parent/177",[62,2.435]],["name/178",[56,40.355]],["parent/178",[62,2.435]],["name/179",[48,37.842]],["parent/179",[62,2.435]],["name/180",[49,35.835]],["parent/180",[62,2.435]],["name/181",[50,37.842]],["parent/181",[62,2.435]],["name/182",[51,40.355]],["parent/182",[62,2.435]],["name/183",[52,40.355]],["parent/183",[62,2.435]],["name/184",[53,40.355]],["parent/184",[62,2.435]],["name/185",[13,32.734]],["parent/185",[62,2.435]],["name/186",[55,40.355]],["parent/186",[62,2.435]],["name/187",[57,40.355]],["parent/187",[62,2.435]],["name/188",[58,40.355]],["parent/188",[62,2.435]],["name/189",[59,40.355]],["parent/189",[62,2.435]],["name/190",[60,40.355]],["parent/190",[62,2.435]],["name/191",[63,48.828]],["parent/191",[]],["name/192",[49,35.835]],["parent/192",[]],["name/193",[64,37.842]],["parent/193",[]],["name/194",[48,37.842]],["parent/194",[64,3.617]],["name/195",[50,37.842]],["parent/195",[64,3.617]],["name/196",[49,35.835]],["parent/196",[64,3.617]]],"invertedIndex":[["__type",{"_index":1,"name":{"1":{},"3":{},"8":{}},"parent":{}}],["abstractworker",{"_index":47,"name":{"145":{}},"parent":{"146":{},"147":{},"148":{},"149":{},"150":{},"151":{},"152":{},"153":{},"154":{},"155":{},"156":{},"157":{},"158":{},"159":{},"160":{}}}],["afterworkersetup",{"_index":20,"name":{"25":{},"53":{},"94":{},"122":{}},"parent":{}}],["async",{"_index":50,"name":{"149":{},"167":{},"181":{},"195":{}},"parent":{}}],["checkalive",{"_index":57,"name":{"157":{},"173":{},"187":{}},"parent":{}}],["checkfunctioninput",{"_index":54,"name":{"154":{}},"parent":{}}],["chooseworker",{"_index":35,"name":{"40":{},"69":{},"111":{},"140":{}},"parent":{}}],["clusterpooloptions",{"_index":40,"name":{"73":{}},"parent":{"74":{},"75":{},"76":{},"77":{},"78":{}}}],["clusterworker",{"_index":61,"name":{"161":{}},"parent":{"162":{},"163":{},"164":{},"165":{},"166":{},"167":{},"168":{},"169":{},"170":{},"171":{},"172":{},"173":{},"174":{},"175":{}}}],["constructor",{"_index":10,"name":{"15":{},"45":{},"86":{},"116":{},"146":{},"162":{},"177":{}},"parent":{}}],["createandsetupworker",{"_index":37,"name":{"42":{},"71":{},"113":{},"142":{}},"parent":{}}],["createworker",{"_index":19,"name":{"24":{},"52":{},"93":{},"121":{}},"parent":{}}],["decreaseworkerstasks",{"_index":33,"name":{"38":{},"67":{},"109":{},"138":{}},"parent":{}}],["destroy",{"_index":31,"name":{"36":{},"65":{},"81":{},"106":{},"135":{}},"parent":{}}],["destroyworker",{"_index":16,"name":{"21":{},"49":{},"90":{},"118":{}},"parent":{}}],["dynamic",{"_index":12,"name":{"17":{},"62":{},"88":{},"132":{}},"parent":{}}],["dynamicclusterpool",{"_index":9,"name":{"14":{}},"parent":{"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"41":{},"42":{},"43":{}}}],["dynamicthreadpool",{"_index":44,"name":{"85":{}},"parent":{"86":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"100":{},"101":{},"102":{},"103":{},"104":{},"105":{},"106":{},"107":{},"108":{},"109":{},"110":{},"111":{},"112":{},"113":{},"114":{}}}],["emitter",{"_index":23,"name":{"28":{},"56":{},"97":{},"125":{}},"parent":{}}],["env",{"_index":41,"name":{"74":{}},"parent":{}}],["errorhandler",{"_index":0,"name":{"0":{},"10":{},"75":{}},"parent":{"1":{}}}],["execute",{"_index":30,"name":{"35":{},"64":{},"80":{},"105":{},"134":{}},"parent":{}}],["exithandler",{"_index":2,"name":{"2":{},"12":{},"77":{}},"parent":{"3":{}}}],["filepath",{"_index":28,"name":{"33":{},"61":{},"102":{},"130":{}},"parent":{}}],["fixedclusterpool",{"_index":39,"name":{"44":{}},"parent":{"45":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{},"54":{},"55":{},"56":{},"57":{},"58":{},"59":{},"60":{},"61":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"69":{},"70":{},"71":{},"72":{}}}],["fixedthreadpool",{"_index":45,"name":{"115":{}},"parent":{"116":{},"117":{},"118":{},"119":{},"120":{},"121":{},"122":{},"123":{},"124":{},"125":{},"126":{},"127":{},"128":{},"129":{},"130":{},"131":{},"132":{},"133":{},"134":{},"135":{},"136":{},"137":{},"138":{},"139":{},"140":{},"141":{},"142":{},"143":{}}}],["getmainworker",{"_index":55,"name":{"155":{},"172":{},"186":{}},"parent":{}}],["handleerror",{"_index":58,"name":{"158":{},"164":{},"188":{}},"parent":{}}],["increaseworkerstask",{"_index":32,"name":{"37":{},"66":{},"108":{},"137":{}},"parent":{}}],["internalexecute",{"_index":36,"name":{"41":{},"70":{},"112":{},"141":{}},"parent":{}}],["interval",{"_index":52,"name":{"151":{},"169":{},"183":{}},"parent":{}}],["ipool",{"_index":42,"name":{"79":{}},"parent":{"80":{},"81":{},"82":{}}}],["ismain",{"_index":15,"name":{"20":{},"48":{},"89":{},"117":{}},"parent":{}}],["iworker",{"_index":3,"name":{"4":{}},"parent":{"5":{},"6":{}}}],["killbehavior",{"_index":49,"name":{"148":{},"166":{},"180":{},"192":{},"196":{}},"parent":{}}],["killbehaviors",{"_index":63,"name":{"191":{}},"parent":{}}],["lasttask",{"_index":51,"name":{"150":{},"168":{},"182":{}},"parent":{}}],["mainworker",{"_index":53,"name":{"152":{},"170":{},"184":{}},"parent":{}}],["max",{"_index":11,"name":{"16":{},"87":{}},"parent":{}}],["maxinactivetime",{"_index":48,"name":{"147":{},"165":{},"179":{},"194":{}},"parent":{}}],["nextmessageid",{"_index":25,"name":{"30":{},"58":{},"99":{},"127":{}},"parent":{}}],["numberofworkers",{"_index":27,"name":{"32":{},"60":{},"101":{},"129":{}},"parent":{}}],["on",{"_index":4,"name":{"5":{}},"parent":{}}],["once",{"_index":5,"name":{"6":{}},"parent":{}}],["onlinehandler",{"_index":6,"name":{"7":{},"11":{},"76":{}},"parent":{"8":{}}}],["opts",{"_index":13,"name":{"18":{},"46":{},"103":{},"131":{},"153":{},"171":{},"185":{}},"parent":{}}],["pooloptions",{"_index":7,"name":{"9":{}},"parent":{"10":{},"11":{},"12":{},"13":{}}}],["promisemap",{"_index":24,"name":{"29":{},"57":{},"98":{},"126":{}},"parent":{}}],["registerworkermessagelistener",{"_index":18,"name":{"23":{},"51":{},"92":{},"120":{}},"parent":{}}],["removeworker",{"_index":34,"name":{"39":{},"68":{},"110":{},"139":{}},"parent":{}}],["run",{"_index":59,"name":{"159":{},"174":{},"189":{}},"parent":{}}],["runasync",{"_index":60,"name":{"160":{},"175":{},"190":{}},"parent":{}}],["sendtomainworker",{"_index":56,"name":{"156":{},"163":{},"178":{}},"parent":{}}],["sendtoworker",{"_index":17,"name":{"22":{},"50":{},"91":{},"119":{}},"parent":{}}],["setuphook",{"_index":14,"name":{"19":{},"47":{},"107":{},"136":{}},"parent":{}}],["setworkerchoicestrategy",{"_index":29,"name":{"34":{},"63":{},"82":{},"104":{},"133":{}},"parent":{}}],["tasks",{"_index":22,"name":{"27":{},"55":{},"96":{},"124":{}},"parent":{}}],["threadworker",{"_index":62,"name":{"176":{}},"parent":{"177":{},"178":{},"179":{},"180":{},"181":{},"182":{},"183":{},"184":{},"185":{},"186":{},"187":{},"188":{},"189":{},"190":{}}}],["threadworkerwithmessagechannel",{"_index":46,"name":{"144":{}},"parent":{}}],["workerchoicestrategies",{"_index":43,"name":{"83":{}},"parent":{}}],["workerchoicestrategy",{"_index":8,"name":{"13":{},"78":{},"84":{}},"parent":{}}],["workerchoicestrategycontext",{"_index":26,"name":{"31":{},"59":{},"100":{},"128":{}},"parent":{}}],["workerlistener",{"_index":38,"name":{"43":{},"72":{},"114":{},"143":{}},"parent":{}}],["workeroptions",{"_index":64,"name":{"193":{}},"parent":{"194":{},"195":{},"196":{}}}],["workers",{"_index":21,"name":{"26":{},"54":{},"95":{},"123":{}},"parent":{}}]],"pipeline":[]}}
\ No newline at end of file
--- /dev/null
+<!doctype html>
+<html class="default no-js">
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <title>AbstractWorker | 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="abstractworker.html">AbstractWorker</a>
+ </li>
+ </ul>
+ <h1>Class AbstractWorker<MainWorker, 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>Base class containing some shared logic for all poolifier workers.</p>
+ </div>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-type-parameters">
+ <h3>Type parameters</h3>
+ <ul class="tsd-type-parameters">
+ <li>
+ <h4>MainWorker<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Worker</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MessagePort</span></h4>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Type of main worker.</p>
+ </div>
+ </div>
+ </li>
+ <li>
+ <h4>Data = <span class="tsd-signature-type">unknown</span></h4>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Type of data this worker receives from pool's execution. 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 the worker sends back to the main worker. 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>
+ <span class="tsd-signature-type">AsyncResource</span>
+ <ul class="tsd-hierarchy">
+ <li>
+ <span class="target">AbstractWorker</span>
+ <ul class="tsd-hierarchy">
+ <li>
+ <a href="clusterworker.html" class="tsd-signature-type" data-tsd-kind="Class">ClusterWorker</a>
+ </li>
+ <li>
+ <a href="threadworker.html" class="tsd-signature-type" data-tsd-kind="Class">ThreadWorker</a>
+ </li>
+ </ul>
+ </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"><a href="abstractworker.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-protected"><a href="abstractworker.html#async" class="tsd-kind-icon">async</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="abstractworker.html#interval" class="tsd-kind-icon">interval</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="abstractworker.html#killbehavior" class="tsd-kind-icon">kill<wbr>Behavior</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="abstractworker.html#lasttask" class="tsd-kind-icon">last<wbr>Task</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="abstractworker.html#mainworker" class="tsd-kind-icon">main<wbr>Worker</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="abstractworker.html#maxinactivetime" class="tsd-kind-icon">max<wbr>Inactive<wbr>Time</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="abstractworker.html#opts" class="tsd-kind-icon">opts</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-external"><a href="abstractworker.html#asyncid" class="tsd-kind-icon">async<wbr>Id</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-external"><a href="abstractworker.html#bind" class="tsd-kind-icon">bind</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="abstractworker.html#checkalive" class="tsd-kind-icon">check<wbr>Alive</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="abstractworker.html#checkfunctioninput" class="tsd-kind-icon">check<wbr>Function<wbr>Input</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="abstractworker.html#emitdestroy" class="tsd-kind-icon">emit<wbr>Destroy</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="abstractworker.html#getmainworker" class="tsd-kind-icon">get<wbr>Main<wbr>Worker</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="abstractworker.html#handleerror" class="tsd-kind-icon">handle<wbr>Error</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="abstractworker.html#run" class="tsd-kind-icon">run</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="abstractworker.html#runasync" class="tsd-kind-icon">run<wbr>Async</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-external"><a href="abstractworker.html#runinasyncscope" class="tsd-kind-icon">run<wbr>InAsync<wbr>Scope</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="abstractworker.html#sendtomainworker" class="tsd-kind-icon">send<wbr>ToMain<wbr>Worker</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="abstractworker.html#triggerasyncid" class="tsd-kind-icon">trigger<wbr>Async<wbr>Id</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static tsd-is-external"><a href="abstractworker.html#bind-1" class="tsd-kind-icon">bind</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">
+ <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">
+ <li class="tsd-signature tsd-kind-icon">new <wbr>Abstract<wbr>Worker<MainWorker, Data, Response><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, isMain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, fn<span class="tsd-signature-symbol">: </span><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">Response</span>, mainWorker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MainWorker</span>, opts<span class="tsd-signature-symbol">?: </span><a href="../interfaces/workeroptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkerOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="abstractworker.html" class="tsd-signature-type" data-tsd-kind="Class">AbstractWorker</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MainWorker</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></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/worker/abstract-worker.ts#L42">src/worker/abstract-worker.ts:42</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Constructs a new poolifier worker.</p>
+ </div>
+ </div>
+ <h4 class="tsd-type-parameters-title">Type parameters</h4>
+ <ul class="tsd-type-parameters">
+ <li>
+ <h4>MainWorker<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Worker</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MessagePort</span></h4>
+ </li>
+ <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>type: <span class="tsd-signature-type">string</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>The type of async event.</p>
+ </div>
+ </li>
+ <li>
+ <h5>isMain: <span class="tsd-signature-type">boolean</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>Whether this is the main worker or not.</p>
+ </div>
+ </li>
+ <li>
+ <h5>fn: <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">Response</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>Function processed by the worker when the pool's <code>execution</code> function is invoked.</p>
+ </div>
+ <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>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">Response</span></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <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">Response</span></h4>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> mainWorker: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MainWorker</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>Reference to main worker.</p>
+ </div>
+ </li>
+ <li>
+ <h5>opts: <a href="../interfaces/workeroptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkerOptions</a><span class="tsd-signature-symbol"> = ...</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>Options for the worker.</p>
+ </div>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <a href="abstractworker.html" class="tsd-signature-type" data-tsd-kind="Class">AbstractWorker</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MainWorker</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></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-protected">
+ <a name="async" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> async</h3>
+ <div class="tsd-signature tsd-kind-icon">async<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/5d4101b/src/worker/abstract-worker.ts#L34">src/worker/abstract-worker.ts:34</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Whether the worker is working asynchronously or not.</p>
+ </div>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
+ <a name="interval" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> interval</h3>
+ <div class="tsd-signature tsd-kind-icon">interval<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Timeout</span></div>
+ <aside class="tsd-sources">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L42">src/worker/abstract-worker.ts:42</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Handler ID of the <code>interval</code> alive check.</p>
+ </div>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
+ <a name="killbehavior" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> kill<wbr>Behavior</h3>
+ <div class="tsd-signature tsd-kind-icon">kill<wbr>Behavior<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"SOFT"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"HARD"</span></div>
+ <aside class="tsd-sources">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L30">src/worker/abstract-worker.ts:30</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>The kill behavior set as option on the Worker constructor or a default value.</p>
+ </div>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
+ <a name="lasttask" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> last<wbr>Task</h3>
+ <div class="tsd-signature tsd-kind-icon">last<wbr>Task<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
+ <aside class="tsd-sources">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L38">src/worker/abstract-worker.ts:38</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Timestamp of the last task processed by this worker.</p>
+ </div>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
+ <a name="mainworker" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagOptional">Optional</span> main<wbr>Worker</h3>
+ <div class="tsd-signature tsd-kind-icon">main<wbr>Worker<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MainWorker</span></div>
+ <aside class="tsd-sources">
+ </aside>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
+ <a name="maxinactivetime" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> max<wbr>Inactive<wbr>Time</h3>
+ <div class="tsd-signature tsd-kind-icon">max<wbr>Inactive<wbr>Time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
+ <aside class="tsd-sources">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L26">src/worker/abstract-worker.ts:26</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>The maximum time to keep this worker alive while idle. The pool automatically checks and terminates this worker when the time expires.</p>
+ </div>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
+ <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/workeroptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkerOptions</a><span class="tsd-signature-symbol"> = ...</span></div>
+ <aside class="tsd-sources">
+ </aside>
+ </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-external">
+ <a name="asyncid" class="tsd-anchor"></a>
+ <h3>async<wbr>Id</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
+ <li class="tsd-signature tsd-kind-icon">async<wbr>Id<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <aside class="tsd-sources">
+ <ul>
+ <li>Defined in node_modules/@types/node/async_hooks.d.ts:159</li>
+ </ul>
+ </aside>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
+ <p>the unique ID assigned to this AsyncResource instance.</p>
+ </li>
+ </ul>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-external">
+ <a name="bind" class="tsd-anchor"></a>
+ <h3>bind</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-external">
+ <li class="tsd-signature tsd-kind-icon">bind<Func><span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Func</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Func</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>asyncResource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncResource</span><span class="tsd-signature-symbol"> }</span></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <aside class="tsd-sources">
+ <ul>
+ <li>Defined in node_modules/@types/node/async_hooks.d.ts:136</li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Binds the given function to execute to this <code>AsyncResource</code>'s scope.</p>
+ </div>
+ </div>
+ <h4 class="tsd-type-parameters-title">Type parameters</h4>
+ <ul class="tsd-type-parameters">
+ <li>
+ <h4>Func<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h4>
+ </li>
+ </ul>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>fn: <span class="tsd-signature-type">Func</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>The function to bind to the current <code>AsyncResource</code>.</p>
+ </div>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Func</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>asyncResource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncResource</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-protected">
+ <a name="checkalive" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> check<wbr>Alive</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <li class="tsd-signature tsd-kind-icon">check<wbr>Alive<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">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L130">src/worker/abstract-worker.ts:130</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Check to see if the worker should be terminated, because its living too long.</p>
+ </div>
+ </div>
+ <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-private">
+ <a name="checkfunctioninput" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagPrivate">Private</span> check<wbr>Function<wbr>Input</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
+ <li class="tsd-signature tsd-kind-icon">check<wbr>Function<wbr>Input<span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><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">Response</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">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L104">src/worker/abstract-worker.ts:104</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Check if the <code>fn</code> parameter is passed to the constructor.</p>
+ </div>
+ </div>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>fn: <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">Response</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>The function that should be defined.</p>
+ </div>
+ <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>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">Response</span></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <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">Response</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-external">
+ <a name="emitdestroy" class="tsd-anchor"></a>
+ <h3>emit<wbr>Destroy</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
+ <li class="tsd-signature tsd-kind-icon">emit<wbr>Destroy<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">
+ <ul>
+ <li>Defined in node_modules/@types/node/async_hooks.d.ts:154</li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Call AsyncHooks destroy callbacks.</p>
+ </div>
+ </div>
+ <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-protected">
+ <a name="getmainworker" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> get<wbr>Main<wbr>Worker</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <li class="tsd-signature tsd-kind-icon">get<wbr>Main<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">MainWorker</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/worker/abstract-worker.ts#L113">src/worker/abstract-worker.ts:113</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Returns the main worker.</p>
+ </div>
+ </div>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">MainWorker</span></h4>
+ <p>Reference to the main worker.</p>
+ </li>
+ </ul>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a name="handleerror" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> handle<wbr>Error</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <li class="tsd-signature tsd-kind-icon">handle<wbr>Error<span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/worker/abstract-worker.ts#L142">src/worker/abstract-worker.ts:142</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Handle an error and convert it to a string so it can be sent back to the main worker.</p>
+ </div>
+ </div>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>e: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>The error raised by the worker.</p>
+ </div>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
+ <p>Message of the error.</p>
+ </li>
+ </ul>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a name="run" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> run</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <li class="tsd-signature tsd-kind-icon">run<span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><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">Response</span>, value<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">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L152">src/worker/abstract-worker.ts:152</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Run the given function synchronously.</p>
+ </div>
+ </div>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>fn: <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">Response</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>Function that will be executed.</p>
+ </div>
+ <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>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">Response</span></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">Data</span></h5>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Response</span></h4>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <h5>value: <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>
+ <div class="tsd-comment tsd-typography">
+ <p>Input data for the given function.</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-protected">
+ <a name="runasync" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> run<wbr>Async</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <li class="tsd-signature tsd-kind-icon">run<wbr>Async<span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><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>, value<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">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L173">src/worker/abstract-worker.ts:173</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Run the given function asynchronously.</p>
+ </div>
+ </div>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>fn: <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></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>Function that will be executed.</p>
+ </div>
+ <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>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">
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> 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>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <h5>value: <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>
+ <div class="tsd-comment tsd-typography">
+ <p>Input data for the given function.</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-has-type-parameter tsd-is-external">
+ <a name="runinasyncscope" class="tsd-anchor"></a>
+ <h3>run<wbr>InAsync<wbr>Scope</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-external">
+ <li class="tsd-signature tsd-kind-icon">run<wbr>InAsync<wbr>Scope<This, Result><span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Result</span>, thisArg<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">This</span>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Result</span></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <aside class="tsd-sources">
+ <ul>
+ <li>Defined in node_modules/@types/node/async_hooks.d.ts:149</li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Call the provided function with the provided arguments in the
+ execution context of the async resource. This will establish the
+ context, trigger the AsyncHooks before callbacks, call the function,
+ trigger the AsyncHooks after callbacks, and then restore the original
+ execution context.</p>
+ </div>
+ </div>
+ <h4 class="tsd-type-parameters-title">Type parameters</h4>
+ <ul class="tsd-type-parameters">
+ <li>
+ <h4>This</h4>
+ </li>
+ <li>
+ <h4>Result</h4>
+ </li>
+ </ul>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>fn: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Result</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>The function to call in the execution context of this
+ async resource.</p>
+ </div>
+ <ul class="tsd-parameters">
+ <li class="tsd-parameter-signature">
+ <ul class="tsd-signatures tsd-kind-type-literal tsd-is-external">
+ <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Result</span></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Result</span></h4>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> thisArg: <span class="tsd-signature-type">This</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>The receiver to be used for the function call.</p>
+ </div>
+ </li>
+ <li>
+ <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>Optional arguments to pass to the function.</p>
+ </div>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Result</span></h4>
+ </li>
+ </ul>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a name="sendtomainworker" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagAbstract">Abstract</span> send<wbr>ToMain<wbr>Worker</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <li class="tsd-signature tsd-kind-icon">send<wbr>ToMain<wbr>Worker<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">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L125">src/worker/abstract-worker.ts:125</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Send a message to the main worker.</p>
+ </div>
+ </div>
+ <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>
+ <div class="tsd-comment tsd-typography">
+ <p>The response message.</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-external">
+ <a name="triggerasyncid" class="tsd-anchor"></a>
+ <h3>trigger<wbr>Async<wbr>Id</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
+ <li class="tsd-signature tsd-kind-icon">trigger<wbr>Async<wbr>Id<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <aside class="tsd-sources">
+ <ul>
+ <li>Defined in node_modules/@types/node/async_hooks.d.ts:164</li>
+ </ul>
+ </aside>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
+ <p>the trigger ID for this AsyncResource instance.</p>
+ </li>
+ </ul>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static tsd-is-external">
+ <a name="bind-1" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagStatic">Static</span> bind</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static tsd-is-external">
+ <li class="tsd-signature tsd-kind-icon">bind<Func><span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Func</span>, type<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Func</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>asyncResource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncResource</span><span class="tsd-signature-symbol"> }</span></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <aside class="tsd-sources">
+ <ul>
+ <li>Defined in node_modules/@types/node/async_hooks.d.ts:130</li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Binds the given function to the current execution context.</p>
+ </div>
+ </div>
+ <h4 class="tsd-type-parameters-title">Type parameters</h4>
+ <ul class="tsd-type-parameters">
+ <li>
+ <h4>Func<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h4>
+ </li>
+ </ul>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>fn: <span class="tsd-signature-type">Func</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>The function to bind to the current execution context.</p>
+ </div>
+ </li>
+ <li>
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> type: <span class="tsd-signature-type">string</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>An optional name to associate with the underlying <code>AsyncResource</code>.</p>
+ </div>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Func</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>asyncResource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncResource</span><span class="tsd-signature-symbol"> }</span></h4>
+ </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">
+ </ul>
+ <ul class="current">
+ <li class="current tsd-kind-class tsd-has-type-parameter">
+ <a href="abstractworker.html" class="tsd-kind-icon">Abstract<wbr>Worker</a>
+ <ul>
+ <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter">
+ <a href="abstractworker.html#constructor" class="tsd-kind-icon">constructor</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
+ <a href="abstractworker.html#async" class="tsd-kind-icon">async</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
+ <a href="abstractworker.html#interval" class="tsd-kind-icon">interval</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
+ <a href="abstractworker.html#killbehavior" class="tsd-kind-icon">kill<wbr>Behavior</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
+ <a href="abstractworker.html#lasttask" class="tsd-kind-icon">last<wbr>Task</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
+ <a href="abstractworker.html#mainworker" class="tsd-kind-icon">main<wbr>Worker</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
+ <a href="abstractworker.html#maxinactivetime" class="tsd-kind-icon">max<wbr>Inactive<wbr>Time</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class">
+ <a href="abstractworker.html#opts" class="tsd-kind-icon">opts</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
+ <a href="abstractworker.html#asyncid" class="tsd-kind-icon">async<wbr>Id</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-external">
+ <a href="abstractworker.html#bind" class="tsd-kind-icon">bind</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a href="abstractworker.html#checkalive" class="tsd-kind-icon">check<wbr>Alive</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
+ <a href="abstractworker.html#checkfunctioninput" class="tsd-kind-icon">check<wbr>Function<wbr>Input</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
+ <a href="abstractworker.html#emitdestroy" class="tsd-kind-icon">emit<wbr>Destroy</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a href="abstractworker.html#getmainworker" class="tsd-kind-icon">get<wbr>Main<wbr>Worker</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a href="abstractworker.html#handleerror" class="tsd-kind-icon">handle<wbr>Error</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a href="abstractworker.html#run" class="tsd-kind-icon">run</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a href="abstractworker.html#runasync" class="tsd-kind-icon">run<wbr>Async</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-external">
+ <a href="abstractworker.html#runinasyncscope" class="tsd-kind-icon">run<wbr>InAsync<wbr>Scope</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a href="abstractworker.html#sendtomainworker" class="tsd-kind-icon">send<wbr>ToMain<wbr>Worker</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
+ <a href="abstractworker.html#triggerasyncid" class="tsd-kind-icon">trigger<wbr>Async<wbr>Id</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static tsd-is-external">
+ <a href="abstractworker.html#bind-1" class="tsd-kind-icon">bind</a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ <ul class="after-current">
+ <li class=" tsd-kind-class tsd-has-type-parameter">
+ <a href="clusterworker.html" class="tsd-kind-icon">Cluster<wbr>Worker</a>
+ </li>
+ <li class=" tsd-kind-class tsd-has-type-parameter">
+ <a href="dynamicclusterpool.html" class="tsd-kind-icon">Dynamic<wbr>Cluster<wbr>Pool</a>
+ </li>
+ <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
--- /dev/null
+<!doctype html>
+<html class="default no-js">
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <title>ClusterWorker | 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="clusterworker.html">ClusterWorker</a>
+ </li>
+ </ul>
+ <h1>Class ClusterWorker<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 worker used by a poolifier <code>ClusterPool</code>.</p>
+ </div>
+ <p>When this worker is inactive for more than the given <code>maxInactiveTime</code>,
+ it will send a termination request to its main worker.</p>
+ <p>If you use a <code>DynamicClusterPool</code> the extra workers that were created will be terminated,
+ but the minimum number of workers will be guaranteed.</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 this worker receives from pool's execution. 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 the worker sends back to the main worker. 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="abstractworker.html" class="tsd-signature-type" data-tsd-kind="Class">AbstractWorker</a><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>
+ <ul class="tsd-hierarchy">
+ <li>
+ <span class="target">ClusterWorker</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="clusterworker.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 tsd-is-protected"><a href="clusterworker.html#async" class="tsd-kind-icon">async</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="clusterworker.html#interval" class="tsd-kind-icon">interval</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="clusterworker.html#killbehavior" class="tsd-kind-icon">kill<wbr>Behavior</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="clusterworker.html#lasttask" class="tsd-kind-icon">last<wbr>Task</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="clusterworker.html#mainworker" class="tsd-kind-icon">main<wbr>Worker</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="clusterworker.html#maxinactivetime" class="tsd-kind-icon">max<wbr>Inactive<wbr>Time</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="clusterworker.html#opts" class="tsd-kind-icon">opts</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-external"><a href="clusterworker.html#asyncid" class="tsd-kind-icon">async<wbr>Id</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="clusterworker.html#bind" class="tsd-kind-icon">bind</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="clusterworker.html#checkalive" class="tsd-kind-icon">check<wbr>Alive</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="clusterworker.html#emitdestroy" class="tsd-kind-icon">emit<wbr>Destroy</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="clusterworker.html#getmainworker" class="tsd-kind-icon">get<wbr>Main<wbr>Worker</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"><a href="clusterworker.html#handleerror" class="tsd-kind-icon">handle<wbr>Error</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="clusterworker.html#run" class="tsd-kind-icon">run</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="clusterworker.html#runasync" class="tsd-kind-icon">run<wbr>Async</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="clusterworker.html#runinasyncscope" class="tsd-kind-icon">run<wbr>InAsync<wbr>Scope</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"><a href="clusterworker.html#sendtomainworker" class="tsd-kind-icon">send<wbr>ToMain<wbr>Worker</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="clusterworker.html#triggerasyncid" class="tsd-kind-icon">trigger<wbr>Async<wbr>Id</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-static tsd-is-external"><a href="clusterworker.html#bind-1" class="tsd-kind-icon">bind</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>Cluster<wbr>Worker<Data, Response><span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><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">Response</span>, opts<span class="tsd-signature-symbol">?: </span><a href="../interfaces/workeroptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkerOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="clusterworker.html" class="tsd-signature-type" data-tsd-kind="Class">ClusterWorker</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="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#constructor">constructor</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/cluster-worker.ts#L25">src/worker/cluster-worker.ts:25</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Constructs a new poolifier cluster worker.</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>fn: <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">Response</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>Function processed by the worker when the pool's <code>execution</code> function is invoked.</p>
+ </div>
+ <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>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">Response</span></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <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">Response</span></h4>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <h5>opts: <a href="../interfaces/workeroptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkerOptions</a><span class="tsd-signature-symbol"> = ...</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>Options for the worker.</p>
+ </div>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <a href="clusterworker.html" class="tsd-signature-type" data-tsd-kind="Class">ClusterWorker</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 tsd-is-protected">
+ <a name="async" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> async</h3>
+ <div class="tsd-signature tsd-kind-icon">async<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#async">async</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L34">src/worker/abstract-worker.ts:34</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Whether the worker is working asynchronously or not.</p>
+ </div>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a name="interval" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> interval</h3>
+ <div class="tsd-signature tsd-kind-icon">interval<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Timeout</span></div>
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#interval">interval</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L42">src/worker/abstract-worker.ts:42</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Handler ID of the <code>interval</code> alive check.</p>
+ </div>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a name="killbehavior" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> kill<wbr>Behavior</h3>
+ <div class="tsd-signature tsd-kind-icon">kill<wbr>Behavior<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"SOFT"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"HARD"</span></div>
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#killbehavior">killBehavior</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L30">src/worker/abstract-worker.ts:30</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>The kill behavior set as option on the Worker constructor or a default value.</p>
+ </div>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a name="lasttask" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> last<wbr>Task</h3>
+ <div class="tsd-signature tsd-kind-icon">last<wbr>Task<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#lasttask">lastTask</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L38">src/worker/abstract-worker.ts:38</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Timestamp of the last task processed by this worker.</p>
+ </div>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a name="mainworker" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagOptional">Optional</span> main<wbr>Worker</h3>
+ <div class="tsd-signature tsd-kind-icon">main<wbr>Worker<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Worker</span></div>
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#mainworker">mainWorker</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="maxinactivetime" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> max<wbr>Inactive<wbr>Time</h3>
+ <div class="tsd-signature tsd-kind-icon">max<wbr>Inactive<wbr>Time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#maxinactivetime">maxInactiveTime</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L26">src/worker/abstract-worker.ts:26</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>The maximum time to keep this worker alive while idle. The pool automatically checks and terminates this worker when the time expires.</p>
+ </div>
+ </div>
+ </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/workeroptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkerOptions</a><span class="tsd-signature-symbol"> = ...</span></div>
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#opts">opts</a></p>
+ </aside>
+ </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-external">
+ <a name="asyncid" class="tsd-anchor"></a>
+ <h3>async<wbr>Id</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
+ <li class="tsd-signature tsd-kind-icon">async<wbr>Id<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#asyncid">asyncId</a></p>
+ <ul>
+ <li>Defined in node_modules/@types/node/async_hooks.d.ts:159</li>
+ </ul>
+ </aside>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
+ <p>the unique ID assigned to this AsyncResource instance.</p>
+ </li>
+ </ul>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external">
+ <a name="bind" class="tsd-anchor"></a>
+ <h3>bind</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external">
+ <li class="tsd-signature tsd-kind-icon">bind<Func><span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Func</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Func</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>asyncResource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncResource</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="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#bind">bind</a></p>
+ <ul>
+ <li>Defined in node_modules/@types/node/async_hooks.d.ts:136</li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Binds the given function to execute to this <code>AsyncResource</code>'s scope.</p>
+ </div>
+ </div>
+ <h4 class="tsd-type-parameters-title">Type parameters</h4>
+ <ul class="tsd-type-parameters">
+ <li>
+ <h4>Func<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h4>
+ </li>
+ </ul>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>fn: <span class="tsd-signature-type">Func</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>The function to bind to the current <code>AsyncResource</code>.</p>
+ </div>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Func</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>asyncResource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncResource</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="checkalive" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> check<wbr>Alive</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">check<wbr>Alive<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="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#checkalive">checkAlive</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L130">src/worker/abstract-worker.ts:130</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Check to see if the worker should be terminated, because its living too long.</p>
+ </div>
+ </div>
+ <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-external">
+ <a name="emitdestroy" class="tsd-anchor"></a>
+ <h3>emit<wbr>Destroy</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
+ <li class="tsd-signature tsd-kind-icon">emit<wbr>Destroy<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="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#emitdestroy">emitDestroy</a></p>
+ <ul>
+ <li>Defined in node_modules/@types/node/async_hooks.d.ts:154</li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Call AsyncHooks destroy callbacks.</p>
+ </div>
+ </div>
+ <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="getmainworker" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> get<wbr>Main<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">get<wbr>Main<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="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#getmainworker">getMainWorker</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L113">src/worker/abstract-worker.ts:113</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Returns the main worker.</p>
+ </div>
+ </div>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Worker</span></h4>
+ <p>Reference to the main worker.</p>
+ </li>
+ </ul>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
+ <a name="handleerror" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> handle<wbr>Error</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
+ <li class="tsd-signature tsd-kind-icon">handle<wbr>Error<span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <aside class="tsd-sources">
+ <p>Overrides <a href="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#handleerror">handleError</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/cluster-worker.ts#L40">src/worker/cluster-worker.ts:40</a></li>
+ </ul>
+ </aside>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>e: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span></h5>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</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="run" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> run</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">run<span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><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">Response</span>, value<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="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#run">run</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L152">src/worker/abstract-worker.ts:152</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Run the given function synchronously.</p>
+ </div>
+ </div>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>fn: <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">Response</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>Function that will be executed.</p>
+ </div>
+ <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>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">Response</span></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">Data</span></h5>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Response</span></h4>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <h5>value: <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>
+ <div class="tsd-comment tsd-typography">
+ <p>Input data for the given function.</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="runasync" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> run<wbr>Async</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">run<wbr>Async<span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><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>, value<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="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#runasync">runAsync</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L173">src/worker/abstract-worker.ts:173</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Run the given function asynchronously.</p>
+ </div>
+ </div>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>fn: <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></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>Function that will be executed.</p>
+ </div>
+ <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>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">
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> 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>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <h5>value: <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>
+ <div class="tsd-comment tsd-typography">
+ <p>Input data for the given function.</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-has-type-parameter tsd-is-inherited tsd-is-external">
+ <a name="runinasyncscope" class="tsd-anchor"></a>
+ <h3>run<wbr>InAsync<wbr>Scope</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external">
+ <li class="tsd-signature tsd-kind-icon">run<wbr>InAsync<wbr>Scope<This, Result><span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Result</span>, thisArg<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">This</span>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Result</span></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#runinasyncscope">runInAsyncScope</a></p>
+ <ul>
+ <li>Defined in node_modules/@types/node/async_hooks.d.ts:149</li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Call the provided function with the provided arguments in the
+ execution context of the async resource. This will establish the
+ context, trigger the AsyncHooks before callbacks, call the function,
+ trigger the AsyncHooks after callbacks, and then restore the original
+ execution context.</p>
+ </div>
+ </div>
+ <h4 class="tsd-type-parameters-title">Type parameters</h4>
+ <ul class="tsd-type-parameters">
+ <li>
+ <h4>This</h4>
+ </li>
+ <li>
+ <h4>Result</h4>
+ </li>
+ </ul>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>fn: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Result</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>The function to call in the execution context of this
+ async resource.</p>
+ </div>
+ <ul class="tsd-parameters">
+ <li class="tsd-parameter-signature">
+ <ul class="tsd-signatures tsd-kind-type-literal tsd-is-external">
+ <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Result</span></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Result</span></h4>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> thisArg: <span class="tsd-signature-type">This</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>The receiver to be used for the function call.</p>
+ </div>
+ </li>
+ <li>
+ <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>Optional arguments to pass to the function.</p>
+ </div>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Result</span></h4>
+ </li>
+ </ul>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
+ <a name="sendtomainworker" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> send<wbr>ToMain<wbr>Worker</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
+ <li class="tsd-signature tsd-kind-icon">send<wbr>ToMain<wbr>Worker<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>Overrides <a href="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#sendtomainworker">sendToMainWorker</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/cluster-worker.ts#L36">src/worker/cluster-worker.ts:36</a></li>
+ </ul>
+ </aside>
+ <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>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
+ <a name="triggerasyncid" class="tsd-anchor"></a>
+ <h3>trigger<wbr>Async<wbr>Id</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
+ <li class="tsd-signature tsd-kind-icon">trigger<wbr>Async<wbr>Id<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#triggerasyncid">triggerAsyncId</a></p>
+ <ul>
+ <li>Defined in node_modules/@types/node/async_hooks.d.ts:164</li>
+ </ul>
+ </aside>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
+ <p>the trigger ID for this AsyncResource instance.</p>
+ </li>
+ </ul>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-static tsd-is-external">
+ <a name="bind-1" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagStatic">Static</span> bind</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-static tsd-is-external">
+ <li class="tsd-signature tsd-kind-icon">bind<Func><span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Func</span>, type<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Func</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>asyncResource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncResource</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="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#bind-1">bind</a></p>
+ <ul>
+ <li>Defined in node_modules/@types/node/async_hooks.d.ts:130</li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Binds the given function to the current execution context.</p>
+ </div>
+ </div>
+ <h4 class="tsd-type-parameters-title">Type parameters</h4>
+ <ul class="tsd-type-parameters">
+ <li>
+ <h4>Func<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h4>
+ </li>
+ </ul>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>fn: <span class="tsd-signature-type">Func</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>The function to bind to the current execution context.</p>
+ </div>
+ </li>
+ <li>
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> type: <span class="tsd-signature-type">string</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>An optional name to associate with the underlying <code>AsyncResource</code>.</p>
+ </div>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Func</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>asyncResource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncResource</span><span class="tsd-signature-symbol"> }</span></h4>
+ </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>
+ </ul>
+ <ul class="current">
+ <li class="current tsd-kind-class tsd-has-type-parameter">
+ <a href="clusterworker.html" class="tsd-kind-icon">Cluster<wbr>Worker</a>
+ <ul>
+ <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
+ <a href="clusterworker.html#constructor" class="tsd-kind-icon">constructor</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a href="clusterworker.html#async" class="tsd-kind-icon">async</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a href="clusterworker.html#interval" class="tsd-kind-icon">interval</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a href="clusterworker.html#killbehavior" class="tsd-kind-icon">kill<wbr>Behavior</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a href="clusterworker.html#lasttask" class="tsd-kind-icon">last<wbr>Task</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a href="clusterworker.html#mainworker" class="tsd-kind-icon">main<wbr>Worker</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a href="clusterworker.html#maxinactivetime" class="tsd-kind-icon">max<wbr>Inactive<wbr>Time</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
+ <a href="clusterworker.html#opts" class="tsd-kind-icon">opts</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
+ <a href="clusterworker.html#asyncid" class="tsd-kind-icon">async<wbr>Id</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external">
+ <a href="clusterworker.html#bind" class="tsd-kind-icon">bind</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a href="clusterworker.html#checkalive" class="tsd-kind-icon">check<wbr>Alive</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
+ <a href="clusterworker.html#emitdestroy" class="tsd-kind-icon">emit<wbr>Destroy</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a href="clusterworker.html#getmainworker" class="tsd-kind-icon">get<wbr>Main<wbr>Worker</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
+ <a href="clusterworker.html#handleerror" class="tsd-kind-icon">handle<wbr>Error</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a href="clusterworker.html#run" class="tsd-kind-icon">run</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a href="clusterworker.html#runasync" class="tsd-kind-icon">run<wbr>Async</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external">
+ <a href="clusterworker.html#runinasyncscope" class="tsd-kind-icon">run<wbr>InAsync<wbr>Scope</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
+ <a href="clusterworker.html#sendtomainworker" class="tsd-kind-icon">send<wbr>ToMain<wbr>Worker</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
+ <a href="clusterworker.html#triggerasyncid" class="tsd-kind-icon">trigger<wbr>Async<wbr>Id</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-static tsd-is-external">
+ <a href="clusterworker.html#bind-1" class="tsd-kind-icon">bind</a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ <ul class="after-current">
+ <li class=" tsd-kind-class tsd-has-type-parameter">
+ <a href="dynamicclusterpool.html" class="tsd-kind-icon">Dynamic<wbr>Cluster<wbr>Pool</a>
+ </li>
+ <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
--- /dev/null
+<!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
--- /dev/null
+<!doctype html>
+<html class="default no-js">
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <title>DynamicThreadPool | 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="dynamicthreadpool.html">DynamicThreadPool</a>
+ </li>
+ </ul>
+ <h1>Class DynamicThreadPool<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 thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.</p>
+ </div>
+ <p>This thread pool creates new threads when the others are busy, up to the maximum number of threads.
+ When the maximum number of threads 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/pioardi">Alessandro Pio Ardizio</a></p>
+ </dd>
+ <dt>since</dt>
+ <dd><p>0.0.1</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="fixedthreadpool.html" class="tsd-signature-type" data-tsd-kind="Class">FixedThreadPool</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">DynamicThreadPool</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="dynamicthreadpool.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="dynamicthreadpool.html#emitter" class="tsd-kind-icon">emitter</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="dynamicthreadpool.html#filepath" class="tsd-kind-icon">file<wbr>Path</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.html#destroy" class="tsd-kind-icon">destroy</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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>Thread<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/pooloptions.html" class="tsd-signature-type" data-tsd-kind="Interface">PoolOptions</a><span class="tsd-signature-symbol"><</span><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="dynamicthreadpool.html" class="tsd-signature-type" data-tsd-kind="Class">DynamicThreadPool</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="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.html#constructor">constructor</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/thread/dynamic.ts#L20">src/pools/thread/dynamic.ts:20</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Constructs a new poolifier dynamic thread 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 threads 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 threads 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>ThreadWorker</code> file, which can be relative or absolute.</p>
+ </div>
+ </li>
+ <li>
+ <h5>opts: <a href="../interfaces/pooloptions.html" class="tsd-signature-type" data-tsd-kind="Interface">PoolOptions</a><span class="tsd-signature-symbol"><</span><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>Options for this dynamic thread pool. Default: <code>{}</code></p>
+ </div>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <a href="dynamicthreadpool.html" class="tsd-signature-type" data-tsd-kind="Class">DynamicThreadPool</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="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.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="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.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="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.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="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.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/pooloptions.html" class="tsd-signature-type" data-tsd-kind="Interface">PoolOptions</a><span class="tsd-signature-symbol"><</span><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a><span class="tsd-signature-symbol">></span></div>
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.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><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a><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="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.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><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a><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="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.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><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</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></div>
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.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> <a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = ...</span></div>
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.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/thread/dynamic.ts#L39">src/pools/thread/dynamic.ts:39</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><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a><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="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.html#afterworkersetup">afterWorkerSetup</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/thread/fixed.ts#L76">src/pools/thread/fixed.ts:76</a></li>
+ </ul>
+ </aside>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>worker: <a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></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><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.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 <a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></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><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.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 <a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></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><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.html#createworker">createWorker</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/thread/fixed.ts#L70">src/pools/thread/fixed.ts:70</a></li>
+ </ul>
+ </aside>
+ <h4 class="tsd-returns-title">Returns <a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></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><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a><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="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.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: <a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></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="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.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><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a><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="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.html#destroyworker">destroyWorker</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/thread/fixed.ts#L48">src/pools/thread/fixed.ts:48</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: <a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></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">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="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="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.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><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a><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="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.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: <a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></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><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a>, 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="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.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: <a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></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="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.html#ismain">isMain</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/thread/fixed.ts#L43">src/pools/thread/fixed.ts:43</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>messageChannel<span class="tsd-signature-symbol">: </span><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a>, 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="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.html#registerworkermessagelistener">registerWorkerMessageListener</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/thread/fixed.ts#L63">src/pools/thread/fixed.ts:63</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>messageChannel: <a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></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><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a><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="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.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: <a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></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><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a>, 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="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.html#sendtoworker">sendToWorker</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/thread/fixed.ts#L55">src/pools/thread/fixed.ts:55</a></li>
+ </ul>
+ </aside>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>worker: <a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></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="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.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="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.html#setuphook">setupHook</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L252">src/pools/abstract-pool.ts:252</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Setup hook that can be overridden by a Poolifier pool implementation
+ to run code before workers are created in the abstract constructor.</p>
+ </div>
+ </div>
+ <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="fixedthreadpool.html">FixedThreadPool</a>.<a href="fixedthreadpool.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>
+ <li class=" tsd-kind-class tsd-has-type-parameter">
+ <a href="dynamicclusterpool.html" class="tsd-kind-icon">Dynamic<wbr>Cluster<wbr>Pool</a>
+ </li>
+ </ul>
+ <ul class="current">
+ <li class="current tsd-kind-class tsd-has-type-parameter">
+ <a href="dynamicthreadpool.html" class="tsd-kind-icon">Dynamic<wbr>Thread<wbr>Pool</a>
+ <ul>
+ <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
+ <a href="dynamicthreadpool.html#constructor" class="tsd-kind-icon">constructor</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
+ <a href="dynamicthreadpool.html#emitter" class="tsd-kind-icon">emitter</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
+ <a href="dynamicthreadpool.html#filepath" class="tsd-kind-icon">file<wbr>Path</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class">
+ <a href="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.html#workers" class="tsd-kind-icon">workers</a>
+ </li>
+ <li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
+ <a href="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.html#destroy" class="tsd-kind-icon">destroy</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
+ <a href="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="dynamicthreadpool.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="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
--- /dev/null
+<!doctype html>
+<html class="default no-js">
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <title>FixedClusterPool | 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="fixedclusterpool.html">FixedClusterPool</a>
+ </li>
+ </ul>
+ <h1>Class FixedClusterPool<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 fixed number of workers.</p>
+ </div>
+ <p>It is possible to perform tasks in sync or asynchronous mode as you prefer.</p>
+ <p>This pool selects the workers in a round robin fashion.</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>
+ <span class="tsd-signature-type">AbstractPool</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>
+ <ul class="tsd-hierarchy">
+ <li>
+ <span class="target">FixedClusterPool</span>
+ <ul class="tsd-hierarchy">
+ <li>
+ <a href="dynamicclusterpool.html" class="tsd-signature-type" data-tsd-kind="Class">DynamicClusterPool</a>
+ </li>
+ </ul>
+ </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"><a href="fixedclusterpool.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"><a href="fixedclusterpool.html#emitter" class="tsd-kind-icon">emitter</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="fixedclusterpool.html#filepath" class="tsd-kind-icon">file<wbr>Path</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="fixedclusterpool.html#nextmessageid" class="tsd-kind-icon">next<wbr>Message<wbr>Id</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="fixedclusterpool.html#numberofworkers" class="tsd-kind-icon">number<wbr>OfWorkers</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="fixedclusterpool.html#opts" class="tsd-kind-icon">opts</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="fixedclusterpool.html#promisemap" class="tsd-kind-icon">promise<wbr>Map</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="fixedclusterpool.html#tasks" class="tsd-kind-icon">tasks</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="fixedclusterpool.html#workerchoicestrategycontext" class="tsd-kind-icon">worker<wbr>Choice<wbr>Strategy<wbr>Context</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="fixedclusterpool.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"><a href="fixedclusterpool.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-protected"><a href="fixedclusterpool.html#afterworkersetup" class="tsd-kind-icon">after<wbr>Worker<wbr>Setup</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="fixedclusterpool.html#chooseworker" class="tsd-kind-icon">choose<wbr>Worker</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="fixedclusterpool.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-protected"><a href="fixedclusterpool.html#createworker" class="tsd-kind-icon">create<wbr>Worker</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="fixedclusterpool.html#decreaseworkerstasks" class="tsd-kind-icon">decrease<wbr>Workers<wbr>Tasks</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="fixedclusterpool.html#destroy" class="tsd-kind-icon">destroy</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="fixedclusterpool.html#destroyworker" class="tsd-kind-icon">destroy<wbr>Worker</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="fixedclusterpool.html#execute" class="tsd-kind-icon">execute</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="fixedclusterpool.html#increaseworkerstask" class="tsd-kind-icon">increase<wbr>Workers<wbr>Task</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="fixedclusterpool.html#internalexecute" class="tsd-kind-icon">internal<wbr>Execute</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="fixedclusterpool.html#ismain" class="tsd-kind-icon">is<wbr>Main</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="fixedclusterpool.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-protected"><a href="fixedclusterpool.html#removeworker" class="tsd-kind-icon">remove<wbr>Worker</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="fixedclusterpool.html#sendtoworker" class="tsd-kind-icon">send<wbr>ToWorker</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="fixedclusterpool.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-protected"><a href="fixedclusterpool.html#setuphook" class="tsd-kind-icon">setup<wbr>Hook</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="fixedclusterpool.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">
+ <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">
+ <li class="tsd-signature tsd-kind-icon">new <wbr>Fixed<wbr>Cluster<wbr>Pool<Data, Response><span class="tsd-signature-symbol">(</span>numberOfWorkers<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="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></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/fixed.ts#L35">src/pools/cluster/fixed.ts:35</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Constructs a new poolifier fixed 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>numberOfWorkers: <span class="tsd-signature-type">number</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>Number of workers for 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 fixed cluster pool. Default: <code>{}</code></p>
+ </div>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <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></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">
+ <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">
+ <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>
+ <div class="tsd-comment tsd-typography">
+ <dl class="tsd-comment-tags">
+ <dt>inheritdoc</dt>
+ <dd></dd>
+ </dl>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
+ <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">
+ </aside>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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">
+ <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">
+ <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">
+ </aside>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
+ <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">
+ </aside>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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">
+ <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">
+ <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">
+ <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>
+ <div class="tsd-comment tsd-typography">
+ <dl class="tsd-comment-tags">
+ <dt>inheritdoc</dt>
+ <dd></dd>
+ </dl>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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">
+ <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">
+ <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">
+ <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>
+ <div class="tsd-comment tsd-typography">
+ <dl class="tsd-comment-tags">
+ <dt>inheritdoc</dt>
+ <dd></dd>
+ </dl>
+ </div>
+ </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">
+ <a name="dynamic" class="tsd-anchor"></a>
+ <h3>dynamic</h3>
+ <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
+ <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/abstract-pool.ts#L211">src/pools/abstract-pool.ts:211</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-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-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">
+ <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-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-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">
+ <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-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-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">
+ <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-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-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">
+ <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-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-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">
+ <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">
+ <a name="destroy" class="tsd-anchor"></a>
+ <h3>destroy</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
+ <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">
+ <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">
+ <a name="destroyworker" class="tsd-anchor"></a>
+ <h3>destroy<wbr>Worker</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
+ <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">
+ <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">
+ <a name="execute" class="tsd-anchor"></a>
+ <h3>execute</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
+ <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">
+ <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-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-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">
+ <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-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-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">
+ <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-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-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">
+ <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">
+ <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">
+ <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">
+ <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-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-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">
+ <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-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-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">
+ <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">
+ <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">
+ <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">
+ <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-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-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">
+ <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-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-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">
+ <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>
+ <li class=" tsd-kind-class tsd-has-type-parameter">
+ <a href="dynamicclusterpool.html" class="tsd-kind-icon">Dynamic<wbr>Cluster<wbr>Pool</a>
+ </li>
+ <li class=" tsd-kind-class tsd-has-type-parameter">
+ <a href="dynamicthreadpool.html" class="tsd-kind-icon">Dynamic<wbr>Thread<wbr>Pool</a>
+ </li>
+ </ul>
+ <ul class="current">
+ <li class="current tsd-kind-class tsd-has-type-parameter">
+ <a href="fixedclusterpool.html" class="tsd-kind-icon">Fixed<wbr>Cluster<wbr>Pool</a>
+ <ul>
+ <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter">
+ <a href="fixedclusterpool.html#constructor" class="tsd-kind-icon">constructor</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class">
+ <a href="fixedclusterpool.html#emitter" class="tsd-kind-icon">emitter</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class">
+ <a href="fixedclusterpool.html#filepath" class="tsd-kind-icon">file<wbr>Path</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
+ <a href="fixedclusterpool.html#nextmessageid" class="tsd-kind-icon">next<wbr>Message<wbr>Id</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class">
+ <a href="fixedclusterpool.html#numberofworkers" class="tsd-kind-icon">number<wbr>OfWorkers</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class">
+ <a href="fixedclusterpool.html#opts" class="tsd-kind-icon">opts</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
+ <a href="fixedclusterpool.html#promisemap" class="tsd-kind-icon">promise<wbr>Map</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class">
+ <a href="fixedclusterpool.html#tasks" class="tsd-kind-icon">tasks</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
+ <a href="fixedclusterpool.html#workerchoicestrategycontext" class="tsd-kind-icon">worker<wbr>Choice<wbr>Strategy<wbr>Context</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class">
+ <a href="fixedclusterpool.html#workers" class="tsd-kind-icon">workers</a>
+ </li>
+ <li class=" tsd-kind-get-signature tsd-parent-kind-class">
+ <a href="fixedclusterpool.html#dynamic" class="tsd-kind-icon">dynamic</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a href="fixedclusterpool.html#afterworkersetup" class="tsd-kind-icon">after<wbr>Worker<wbr>Setup</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a href="fixedclusterpool.html#chooseworker" class="tsd-kind-icon">choose<wbr>Worker</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a href="fixedclusterpool.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-protected">
+ <a href="fixedclusterpool.html#createworker" class="tsd-kind-icon">create<wbr>Worker</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a href="fixedclusterpool.html#decreaseworkerstasks" class="tsd-kind-icon">decrease<wbr>Workers<wbr>Tasks</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class">
+ <a href="fixedclusterpool.html#destroy" class="tsd-kind-icon">destroy</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class">
+ <a href="fixedclusterpool.html#destroyworker" class="tsd-kind-icon">destroy<wbr>Worker</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class">
+ <a href="fixedclusterpool.html#execute" class="tsd-kind-icon">execute</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a href="fixedclusterpool.html#increaseworkerstask" class="tsd-kind-icon">increase<wbr>Workers<wbr>Task</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a href="fixedclusterpool.html#internalexecute" class="tsd-kind-icon">internal<wbr>Execute</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a href="fixedclusterpool.html#ismain" class="tsd-kind-icon">is<wbr>Main</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
+ <a href="fixedclusterpool.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-protected">
+ <a href="fixedclusterpool.html#removeworker" class="tsd-kind-icon">remove<wbr>Worker</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a href="fixedclusterpool.html#sendtoworker" class="tsd-kind-icon">send<wbr>ToWorker</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class">
+ <a href="fixedclusterpool.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-protected">
+ <a href="fixedclusterpool.html#setuphook" class="tsd-kind-icon">setup<wbr>Hook</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a href="fixedclusterpool.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="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
--- /dev/null
+<!doctype html>
+<html class="default no-js">
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <title>FixedThreadPool | 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="fixedthreadpool.html">FixedThreadPool</a>
+ </li>
+ </ul>
+ <h1>Class FixedThreadPool<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 thread pool with a fixed number of threads.</p>
+ </div>
+ <p>It is possible to perform tasks in sync or asynchronous mode as you prefer.</p>
+ <p>This pool selects the threads in a round robin fashion.</p>
+ <dl class="tsd-comment-tags">
+ <dt>author</dt>
+ <dd><p><a href="https://github.com/pioardi">Alessandro Pio Ardizio</a></p>
+ </dd>
+ <dt>since</dt>
+ <dd><p>0.0.1</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>
+ <span class="tsd-signature-type">AbstractPool</span><span class="tsd-signature-symbol"><</span><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</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">FixedThreadPool</span>
+ <ul class="tsd-hierarchy">
+ <li>
+ <a href="dynamicthreadpool.html" class="tsd-signature-type" data-tsd-kind="Class">DynamicThreadPool</a>
+ </li>
+ </ul>
+ </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"><a href="fixedthreadpool.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"><a href="fixedthreadpool.html#emitter" class="tsd-kind-icon">emitter</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="fixedthreadpool.html#filepath" class="tsd-kind-icon">file<wbr>Path</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="fixedthreadpool.html#nextmessageid" class="tsd-kind-icon">next<wbr>Message<wbr>Id</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="fixedthreadpool.html#numberofworkers" class="tsd-kind-icon">number<wbr>OfWorkers</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="fixedthreadpool.html#opts" class="tsd-kind-icon">opts</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="fixedthreadpool.html#promisemap" class="tsd-kind-icon">promise<wbr>Map</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="fixedthreadpool.html#tasks" class="tsd-kind-icon">tasks</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="fixedthreadpool.html#workerchoicestrategycontext" class="tsd-kind-icon">worker<wbr>Choice<wbr>Strategy<wbr>Context</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="fixedthreadpool.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"><a href="fixedthreadpool.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-protected"><a href="fixedthreadpool.html#afterworkersetup" class="tsd-kind-icon">after<wbr>Worker<wbr>Setup</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="fixedthreadpool.html#chooseworker" class="tsd-kind-icon">choose<wbr>Worker</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="fixedthreadpool.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-protected"><a href="fixedthreadpool.html#createworker" class="tsd-kind-icon">create<wbr>Worker</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="fixedthreadpool.html#decreaseworkerstasks" class="tsd-kind-icon">decrease<wbr>Workers<wbr>Tasks</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="fixedthreadpool.html#destroy" class="tsd-kind-icon">destroy</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="fixedthreadpool.html#destroyworker" class="tsd-kind-icon">destroy<wbr>Worker</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="fixedthreadpool.html#execute" class="tsd-kind-icon">execute</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="fixedthreadpool.html#increaseworkerstask" class="tsd-kind-icon">increase<wbr>Workers<wbr>Task</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="fixedthreadpool.html#internalexecute" class="tsd-kind-icon">internal<wbr>Execute</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="fixedthreadpool.html#ismain" class="tsd-kind-icon">is<wbr>Main</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="fixedthreadpool.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-protected"><a href="fixedthreadpool.html#removeworker" class="tsd-kind-icon">remove<wbr>Worker</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="fixedthreadpool.html#sendtoworker" class="tsd-kind-icon">send<wbr>ToWorker</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="fixedthreadpool.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-protected"><a href="fixedthreadpool.html#setuphook" class="tsd-kind-icon">setup<wbr>Hook</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="fixedthreadpool.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">
+ <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">
+ <li class="tsd-signature tsd-kind-icon">new <wbr>Fixed<wbr>Thread<wbr>Pool<Data, Response><span class="tsd-signature-symbol">(</span>numberOfThreads<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/pooloptions.html" class="tsd-signature-type" data-tsd-kind="Interface">PoolOptions</a><span class="tsd-signature-symbol"><</span><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="fixedthreadpool.html" class="tsd-signature-type" data-tsd-kind="Class">FixedThreadPool</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">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/thread/fixed.ts#L27">src/pools/thread/fixed.ts:27</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Constructs a new poolifier fixed thread 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>numberOfThreads: <span class="tsd-signature-type">number</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>Number of threads for 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>ThreadWorker</code> file, which can be relative or absolute.</p>
+ </div>
+ </li>
+ <li>
+ <h5>opts: <a href="../interfaces/pooloptions.html" class="tsd-signature-type" data-tsd-kind="Interface">PoolOptions</a><span class="tsd-signature-symbol"><</span><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>Options for this fixed thread pool. Default: <code>{}</code></p>
+ </div>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <a href="fixedthreadpool.html" class="tsd-signature-type" data-tsd-kind="Class">FixedThreadPool</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">
+ <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">
+ <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>
+ <div class="tsd-comment tsd-typography">
+ <dl class="tsd-comment-tags">
+ <dt>inheritdoc</dt>
+ <dd></dd>
+ </dl>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
+ <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">
+ </aside>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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">
+ <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">
+ <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">
+ </aside>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
+ <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/pooloptions.html" class="tsd-signature-type" data-tsd-kind="Interface">PoolOptions</a><span class="tsd-signature-symbol"><</span><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a><span class="tsd-signature-symbol">></span></div>
+ <aside class="tsd-sources">
+ </aside>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a><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">
+ <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">
+ <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><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a><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">
+ <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>
+ <div class="tsd-comment tsd-typography">
+ <dl class="tsd-comment-tags">
+ <dt>inheritdoc</dt>
+ <dd></dd>
+ </dl>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class 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><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</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></div>
+ <aside class="tsd-sources">
+ <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">
+ <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> <a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a><span class="tsd-signature-symbol">[]</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#L105">src/pools/abstract-pool.ts:105</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <dl class="tsd-comment-tags">
+ <dt>inheritdoc</dt>
+ <dd></dd>
+ </dl>
+ </div>
+ </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">
+ <a name="dynamic" class="tsd-anchor"></a>
+ <h3>dynamic</h3>
+ <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
+ <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/abstract-pool.ts#L211">src/pools/abstract-pool.ts:211</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-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-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><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a><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">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/thread/fixed.ts#L76">src/pools/thread/fixed.ts:76</a></li>
+ </ul>
+ </aside>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>worker: <a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></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-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-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><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></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/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 <a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></h4>
+ <p>Worker.</p>
+ </li>
+ </ul>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class 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-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><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></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/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 <a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></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-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-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><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></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/thread/fixed.ts#L70">src/pools/thread/fixed.ts:70</a></li>
+ </ul>
+ </aside>
+ <h4 class="tsd-returns-title">Returns <a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></h4>
+ </li>
+ </ul>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class 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-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><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a><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">
+ <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: <a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></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">
+ <a name="destroy" class="tsd-anchor"></a>
+ <h3>destroy</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
+ <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">
+ <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">
+ <a name="destroyworker" class="tsd-anchor"></a>
+ <h3>destroy<wbr>Worker</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
+ <li class="tsd-signature tsd-kind-icon">destroy<wbr>Worker<span class="tsd-signature-symbol">(</span>worker<span class="tsd-signature-symbol">: </span><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a><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">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/thread/fixed.ts#L48">src/pools/thread/fixed.ts:48</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: <a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></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">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">
+ <a name="execute" class="tsd-anchor"></a>
+ <h3>execute</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
+ <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">
+ <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-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-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><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a><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">
+ <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: <a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></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-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-protected">
+ <li class="tsd-signature tsd-kind-icon">internal<wbr>Execute<span class="tsd-signature-symbol">(</span>worker<span class="tsd-signature-symbol">: </span><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a>, 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">
+ <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: <a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></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-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-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">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/thread/fixed.ts#L43">src/pools/thread/fixed.ts:43</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">
+ <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">
+ <li class="tsd-signature tsd-kind-icon">register<wbr>Worker<wbr>Message<wbr>Listener<Message><span class="tsd-signature-symbol">(</span>messageChannel<span class="tsd-signature-symbol">: </span><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a>, 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">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/thread/fixed.ts#L63">src/pools/thread/fixed.ts:63</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>messageChannel: <a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></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-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-protected">
+ <li class="tsd-signature tsd-kind-icon">remove<wbr>Worker<span class="tsd-signature-symbol">(</span>worker<span class="tsd-signature-symbol">: </span><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a><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">
+ <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: <a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></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-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-protected">
+ <li class="tsd-signature tsd-kind-icon">send<wbr>ToWorker<span class="tsd-signature-symbol">(</span>worker<span class="tsd-signature-symbol">: </span><a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a>, 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">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/thread/fixed.ts#L55">src/pools/thread/fixed.ts:55</a></li>
+ </ul>
+ </aside>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>worker: <a href="../index.html#threadworkerwithmessagechannel" class="tsd-signature-type" data-tsd-kind="Type alias">ThreadWorkerWithMessageChannel</a></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">
+ <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">
+ <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">
+ <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-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-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">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L252">src/pools/abstract-pool.ts:252</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Setup hook that can be overridden by a Poolifier pool implementation
+ to run code before workers are created in the abstract constructor.</p>
+ </div>
+ </div>
+ <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-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-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">
+ <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>
+ <li class=" tsd-kind-class tsd-has-type-parameter">
+ <a href="dynamicclusterpool.html" class="tsd-kind-icon">Dynamic<wbr>Cluster<wbr>Pool</a>
+ </li>
+ <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>
+ </ul>
+ <ul class="current">
+ <li class="current tsd-kind-class tsd-has-type-parameter">
+ <a href="fixedthreadpool.html" class="tsd-kind-icon">Fixed<wbr>Thread<wbr>Pool</a>
+ <ul>
+ <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter">
+ <a href="fixedthreadpool.html#constructor" class="tsd-kind-icon">constructor</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class">
+ <a href="fixedthreadpool.html#emitter" class="tsd-kind-icon">emitter</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class">
+ <a href="fixedthreadpool.html#filepath" class="tsd-kind-icon">file<wbr>Path</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
+ <a href="fixedthreadpool.html#nextmessageid" class="tsd-kind-icon">next<wbr>Message<wbr>Id</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class">
+ <a href="fixedthreadpool.html#numberofworkers" class="tsd-kind-icon">number<wbr>OfWorkers</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class">
+ <a href="fixedthreadpool.html#opts" class="tsd-kind-icon">opts</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
+ <a href="fixedthreadpool.html#promisemap" class="tsd-kind-icon">promise<wbr>Map</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class">
+ <a href="fixedthreadpool.html#tasks" class="tsd-kind-icon">tasks</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
+ <a href="fixedthreadpool.html#workerchoicestrategycontext" class="tsd-kind-icon">worker<wbr>Choice<wbr>Strategy<wbr>Context</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class">
+ <a href="fixedthreadpool.html#workers" class="tsd-kind-icon">workers</a>
+ </li>
+ <li class=" tsd-kind-get-signature tsd-parent-kind-class">
+ <a href="fixedthreadpool.html#dynamic" class="tsd-kind-icon">dynamic</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a href="fixedthreadpool.html#afterworkersetup" class="tsd-kind-icon">after<wbr>Worker<wbr>Setup</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a href="fixedthreadpool.html#chooseworker" class="tsd-kind-icon">choose<wbr>Worker</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a href="fixedthreadpool.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-protected">
+ <a href="fixedthreadpool.html#createworker" class="tsd-kind-icon">create<wbr>Worker</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a href="fixedthreadpool.html#decreaseworkerstasks" class="tsd-kind-icon">decrease<wbr>Workers<wbr>Tasks</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class">
+ <a href="fixedthreadpool.html#destroy" class="tsd-kind-icon">destroy</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class">
+ <a href="fixedthreadpool.html#destroyworker" class="tsd-kind-icon">destroy<wbr>Worker</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class">
+ <a href="fixedthreadpool.html#execute" class="tsd-kind-icon">execute</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a href="fixedthreadpool.html#increaseworkerstask" class="tsd-kind-icon">increase<wbr>Workers<wbr>Task</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a href="fixedthreadpool.html#internalexecute" class="tsd-kind-icon">internal<wbr>Execute</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a href="fixedthreadpool.html#ismain" class="tsd-kind-icon">is<wbr>Main</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
+ <a href="fixedthreadpool.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-protected">
+ <a href="fixedthreadpool.html#removeworker" class="tsd-kind-icon">remove<wbr>Worker</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a href="fixedthreadpool.html#sendtoworker" class="tsd-kind-icon">send<wbr>ToWorker</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class">
+ <a href="fixedthreadpool.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-protected">
+ <a href="fixedthreadpool.html#setuphook" class="tsd-kind-icon">setup<wbr>Hook</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
+ <a href="fixedthreadpool.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="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
--- /dev/null
+<!doctype html>
+<html class="default no-js">
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <title>ThreadWorker | 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="threadworker.html">ThreadWorker</a>
+ </li>
+ </ul>
+ <h1>Class ThreadWorker<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 thread worker used by a poolifier <code>ThreadPool</code>.</p>
+ </div>
+ <p>When this worker is inactive for more than the given <code>maxInactiveTime</code>,
+ it will send a termination request to its main thread.</p>
+ <p>If you use a <code>DynamicThreadPool</code> the extra workers that were created will be terminated,
+ but the minimum number of workers will be guaranteed.</p>
+ <dl class="tsd-comment-tags">
+ <dt>author</dt>
+ <dd><p><a href="https://github.com/pioardi">Alessandro Pio Ardizio</a></p>
+ </dd>
+ <dt>since</dt>
+ <dd><p>0.0.1</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 this worker receives from pool's execution. 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 the worker sends back to the main thread. 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="abstractworker.html" class="tsd-signature-type" data-tsd-kind="Class">AbstractWorker</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MessagePort</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>
+ <ul class="tsd-hierarchy">
+ <li>
+ <span class="target">ThreadWorker</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="threadworker.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 tsd-is-protected"><a href="threadworker.html#async" class="tsd-kind-icon">async</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="threadworker.html#interval" class="tsd-kind-icon">interval</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="threadworker.html#killbehavior" class="tsd-kind-icon">kill<wbr>Behavior</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="threadworker.html#lasttask" class="tsd-kind-icon">last<wbr>Task</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="threadworker.html#mainworker" class="tsd-kind-icon">main<wbr>Worker</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="threadworker.html#maxinactivetime" class="tsd-kind-icon">max<wbr>Inactive<wbr>Time</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="threadworker.html#opts" class="tsd-kind-icon">opts</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-external"><a href="threadworker.html#asyncid" class="tsd-kind-icon">async<wbr>Id</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="threadworker.html#bind" class="tsd-kind-icon">bind</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="threadworker.html#checkalive" class="tsd-kind-icon">check<wbr>Alive</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="threadworker.html#emitdestroy" class="tsd-kind-icon">emit<wbr>Destroy</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="threadworker.html#getmainworker" class="tsd-kind-icon">get<wbr>Main<wbr>Worker</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="threadworker.html#handleerror" class="tsd-kind-icon">handle<wbr>Error</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="threadworker.html#run" class="tsd-kind-icon">run</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="threadworker.html#runasync" class="tsd-kind-icon">run<wbr>Async</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="threadworker.html#runinasyncscope" class="tsd-kind-icon">run<wbr>InAsync<wbr>Scope</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"><a href="threadworker.html#sendtomainworker" class="tsd-kind-icon">send<wbr>ToMain<wbr>Worker</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="threadworker.html#triggerasyncid" class="tsd-kind-icon">trigger<wbr>Async<wbr>Id</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-static tsd-is-external"><a href="threadworker.html#bind-1" class="tsd-kind-icon">bind</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>Thread<wbr>Worker<Data, Response><span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><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">Response</span>, opts<span class="tsd-signature-symbol">?: </span><a href="../interfaces/workeroptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkerOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="threadworker.html" class="tsd-signature-type" data-tsd-kind="Class">ThreadWorker</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="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#constructor">constructor</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/thread-worker.ts#L25">src/worker/thread-worker.ts:25</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Constructs a new poolifier thread worker.</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>fn: <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">Response</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>Function processed by the worker when the pool's <code>execution</code> function is invoked.</p>
+ </div>
+ <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>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">Response</span></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <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">Response</span></h4>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <h5>opts: <a href="../interfaces/workeroptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkerOptions</a><span class="tsd-signature-symbol"> = ...</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>Options for the worker.</p>
+ </div>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <a href="threadworker.html" class="tsd-signature-type" data-tsd-kind="Class">ThreadWorker</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 tsd-is-protected">
+ <a name="async" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> async</h3>
+ <div class="tsd-signature tsd-kind-icon">async<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#async">async</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L34">src/worker/abstract-worker.ts:34</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Whether the worker is working asynchronously or not.</p>
+ </div>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a name="interval" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> interval</h3>
+ <div class="tsd-signature tsd-kind-icon">interval<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Timeout</span></div>
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#interval">interval</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L42">src/worker/abstract-worker.ts:42</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Handler ID of the <code>interval</code> alive check.</p>
+ </div>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a name="killbehavior" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> kill<wbr>Behavior</h3>
+ <div class="tsd-signature tsd-kind-icon">kill<wbr>Behavior<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"SOFT"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"HARD"</span></div>
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#killbehavior">killBehavior</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L30">src/worker/abstract-worker.ts:30</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>The kill behavior set as option on the Worker constructor or a default value.</p>
+ </div>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a name="lasttask" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> last<wbr>Task</h3>
+ <div class="tsd-signature tsd-kind-icon">last<wbr>Task<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#lasttask">lastTask</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L38">src/worker/abstract-worker.ts:38</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Timestamp of the last task processed by this worker.</p>
+ </div>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a name="mainworker" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagOptional">Optional</span> main<wbr>Worker</h3>
+ <div class="tsd-signature tsd-kind-icon">main<wbr>Worker<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MessagePort</span></div>
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#mainworker">mainWorker</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="maxinactivetime" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> max<wbr>Inactive<wbr>Time</h3>
+ <div class="tsd-signature tsd-kind-icon">max<wbr>Inactive<wbr>Time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#maxinactivetime">maxInactiveTime</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L26">src/worker/abstract-worker.ts:26</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>The maximum time to keep this worker alive while idle. The pool automatically checks and terminates this worker when the time expires.</p>
+ </div>
+ </div>
+ </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/workeroptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkerOptions</a><span class="tsd-signature-symbol"> = ...</span></div>
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#opts">opts</a></p>
+ </aside>
+ </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-external">
+ <a name="asyncid" class="tsd-anchor"></a>
+ <h3>async<wbr>Id</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
+ <li class="tsd-signature tsd-kind-icon">async<wbr>Id<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#asyncid">asyncId</a></p>
+ <ul>
+ <li>Defined in node_modules/@types/node/async_hooks.d.ts:159</li>
+ </ul>
+ </aside>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
+ <p>the unique ID assigned to this AsyncResource instance.</p>
+ </li>
+ </ul>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external">
+ <a name="bind" class="tsd-anchor"></a>
+ <h3>bind</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external">
+ <li class="tsd-signature tsd-kind-icon">bind<Func><span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Func</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Func</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>asyncResource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncResource</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="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#bind">bind</a></p>
+ <ul>
+ <li>Defined in node_modules/@types/node/async_hooks.d.ts:136</li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Binds the given function to execute to this <code>AsyncResource</code>'s scope.</p>
+ </div>
+ </div>
+ <h4 class="tsd-type-parameters-title">Type parameters</h4>
+ <ul class="tsd-type-parameters">
+ <li>
+ <h4>Func<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h4>
+ </li>
+ </ul>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>fn: <span class="tsd-signature-type">Func</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>The function to bind to the current <code>AsyncResource</code>.</p>
+ </div>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Func</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>asyncResource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncResource</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="checkalive" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> check<wbr>Alive</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">check<wbr>Alive<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="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#checkalive">checkAlive</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L130">src/worker/abstract-worker.ts:130</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Check to see if the worker should be terminated, because its living too long.</p>
+ </div>
+ </div>
+ <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-external">
+ <a name="emitdestroy" class="tsd-anchor"></a>
+ <h3>emit<wbr>Destroy</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
+ <li class="tsd-signature tsd-kind-icon">emit<wbr>Destroy<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="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#emitdestroy">emitDestroy</a></p>
+ <ul>
+ <li>Defined in node_modules/@types/node/async_hooks.d.ts:154</li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Call AsyncHooks destroy callbacks.</p>
+ </div>
+ </div>
+ <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="getmainworker" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> get<wbr>Main<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">get<wbr>Main<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">MessagePort</span></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#getmainworker">getMainWorker</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L113">src/worker/abstract-worker.ts:113</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Returns the main worker.</p>
+ </div>
+ </div>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">MessagePort</span></h4>
+ <p>Reference to the main 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="handleerror" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> handle<wbr>Error</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">handle<wbr>Error<span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#handleerror">handleError</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L142">src/worker/abstract-worker.ts:142</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Handle an error and convert it to a string so it can be sent back to the main worker.</p>
+ </div>
+ </div>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>e: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>The error raised by the worker.</p>
+ </div>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
+ <p>Message of the error.</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="run" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> run</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">run<span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><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">Response</span>, value<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="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#run">run</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L152">src/worker/abstract-worker.ts:152</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Run the given function synchronously.</p>
+ </div>
+ </div>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>fn: <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">Response</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>Function that will be executed.</p>
+ </div>
+ <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>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">Response</span></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">Data</span></h5>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Response</span></h4>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <h5>value: <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>
+ <div class="tsd-comment tsd-typography">
+ <p>Input data for the given function.</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="runasync" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> run<wbr>Async</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">run<wbr>Async<span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><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>, value<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="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#runasync">runAsync</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/abstract-worker.ts#L173">src/worker/abstract-worker.ts:173</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Run the given function asynchronously.</p>
+ </div>
+ </div>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>fn: <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></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>Function that will be executed.</p>
+ </div>
+ <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>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">
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> 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>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <h5>value: <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>
+ <div class="tsd-comment tsd-typography">
+ <p>Input data for the given function.</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-has-type-parameter tsd-is-inherited tsd-is-external">
+ <a name="runinasyncscope" class="tsd-anchor"></a>
+ <h3>run<wbr>InAsync<wbr>Scope</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external">
+ <li class="tsd-signature tsd-kind-icon">run<wbr>InAsync<wbr>Scope<This, Result><span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Result</span>, thisArg<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">This</span>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Result</span></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#runinasyncscope">runInAsyncScope</a></p>
+ <ul>
+ <li>Defined in node_modules/@types/node/async_hooks.d.ts:149</li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Call the provided function with the provided arguments in the
+ execution context of the async resource. This will establish the
+ context, trigger the AsyncHooks before callbacks, call the function,
+ trigger the AsyncHooks after callbacks, and then restore the original
+ execution context.</p>
+ </div>
+ </div>
+ <h4 class="tsd-type-parameters-title">Type parameters</h4>
+ <ul class="tsd-type-parameters">
+ <li>
+ <h4>This</h4>
+ </li>
+ <li>
+ <h4>Result</h4>
+ </li>
+ </ul>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>fn: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Result</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>The function to call in the execution context of this
+ async resource.</p>
+ </div>
+ <ul class="tsd-parameters">
+ <li class="tsd-parameter-signature">
+ <ul class="tsd-signatures tsd-kind-type-literal tsd-is-external">
+ <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Result</span></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Result</span></h4>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> thisArg: <span class="tsd-signature-type">This</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>The receiver to be used for the function call.</p>
+ </div>
+ </li>
+ <li>
+ <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>Optional arguments to pass to the function.</p>
+ </div>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Result</span></h4>
+ </li>
+ </ul>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
+ <a name="sendtomainworker" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> send<wbr>ToMain<wbr>Worker</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
+ <li class="tsd-signature tsd-kind-icon">send<wbr>ToMain<wbr>Worker<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>Overrides <a href="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#sendtomainworker">sendToMainWorker</a></p>
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/thread-worker.ts#L36">src/worker/thread-worker.ts:36</a></li>
+ </ul>
+ </aside>
+ <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>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
+ <a name="triggerasyncid" class="tsd-anchor"></a>
+ <h3>trigger<wbr>Async<wbr>Id</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
+ <li class="tsd-signature tsd-kind-icon">trigger<wbr>Async<wbr>Id<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
+ </ul>
+ <ul class="tsd-descriptions">
+ <li class="tsd-description">
+ <aside class="tsd-sources">
+ <p>Inherited from <a href="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#triggerasyncid">triggerAsyncId</a></p>
+ <ul>
+ <li>Defined in node_modules/@types/node/async_hooks.d.ts:164</li>
+ </ul>
+ </aside>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
+ <p>the trigger ID for this AsyncResource instance.</p>
+ </li>
+ </ul>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-static tsd-is-external">
+ <a name="bind-1" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagStatic">Static</span> bind</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-static tsd-is-external">
+ <li class="tsd-signature tsd-kind-icon">bind<Func><span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Func</span>, type<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Func</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>asyncResource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncResource</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="abstractworker.html">AbstractWorker</a>.<a href="abstractworker.html#bind-1">bind</a></p>
+ <ul>
+ <li>Defined in node_modules/@types/node/async_hooks.d.ts:130</li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Binds the given function to the current execution context.</p>
+ </div>
+ </div>
+ <h4 class="tsd-type-parameters-title">Type parameters</h4>
+ <ul class="tsd-type-parameters">
+ <li>
+ <h4>Func<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h4>
+ </li>
+ </ul>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>fn: <span class="tsd-signature-type">Func</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>The function to bind to the current execution context.</p>
+ </div>
+ </li>
+ <li>
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> type: <span class="tsd-signature-type">string</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>An optional name to associate with the underlying <code>AsyncResource</code>.</p>
+ </div>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Func</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>asyncResource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncResource</span><span class="tsd-signature-symbol"> }</span></h4>
+ </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>
+ <li class=" tsd-kind-class tsd-has-type-parameter">
+ <a href="dynamicclusterpool.html" class="tsd-kind-icon">Dynamic<wbr>Cluster<wbr>Pool</a>
+ </li>
+ <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>
+ </ul>
+ <ul class="current">
+ <li class="current tsd-kind-class tsd-has-type-parameter">
+ <a href="threadworker.html" class="tsd-kind-icon">Thread<wbr>Worker</a>
+ <ul>
+ <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
+ <a href="threadworker.html#constructor" class="tsd-kind-icon">constructor</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a href="threadworker.html#async" class="tsd-kind-icon">async</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a href="threadworker.html#interval" class="tsd-kind-icon">interval</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a href="threadworker.html#killbehavior" class="tsd-kind-icon">kill<wbr>Behavior</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a href="threadworker.html#lasttask" class="tsd-kind-icon">last<wbr>Task</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a href="threadworker.html#mainworker" class="tsd-kind-icon">main<wbr>Worker</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a href="threadworker.html#maxinactivetime" class="tsd-kind-icon">max<wbr>Inactive<wbr>Time</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
+ <a href="threadworker.html#opts" class="tsd-kind-icon">opts</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
+ <a href="threadworker.html#asyncid" class="tsd-kind-icon">async<wbr>Id</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external">
+ <a href="threadworker.html#bind" class="tsd-kind-icon">bind</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a href="threadworker.html#checkalive" class="tsd-kind-icon">check<wbr>Alive</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
+ <a href="threadworker.html#emitdestroy" class="tsd-kind-icon">emit<wbr>Destroy</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a href="threadworker.html#getmainworker" class="tsd-kind-icon">get<wbr>Main<wbr>Worker</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a href="threadworker.html#handleerror" class="tsd-kind-icon">handle<wbr>Error</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a href="threadworker.html#run" class="tsd-kind-icon">run</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
+ <a href="threadworker.html#runasync" class="tsd-kind-icon">run<wbr>Async</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external">
+ <a href="threadworker.html#runinasyncscope" class="tsd-kind-icon">run<wbr>InAsync<wbr>Scope</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
+ <a href="threadworker.html#sendtomainworker" class="tsd-kind-icon">send<wbr>ToMain<wbr>Worker</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
+ <a href="threadworker.html#triggerasyncid" class="tsd-kind-icon">trigger<wbr>Async<wbr>Id</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-static tsd-is-external">
+ <a href="threadworker.html#bind-1" class="tsd-kind-icon">bind</a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ <ul class="after-current">
+ <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
--- /dev/null
+<!doctype html>
+<html class="default no-js">
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <title>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">
+ <h1>poolifier</h1>
+ </div>
+ </div>
+</header>
+<div class="container container-main">
+ <div class="row">
+ <div class="col-8 col-content">
+ <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>Classes</h3>
+ <ul class="tsd-index-list">
+ <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>
+ </ul>
+ </section>
+ <section class="tsd-index-section ">
+ <h3>Interfaces</h3>
+ <ul class="tsd-index-list">
+ <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>
+ </ul>
+ </section>
+ <section class="tsd-index-section ">
+ <h3>Type aliases</h3>
+ <ul class="tsd-index-list">
+ <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>
+ </ul>
+ </section>
+ <section class="tsd-index-section ">
+ <h3>Variables</h3>
+ <ul class="tsd-index-list">
+ <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>
+ </section>
+ </div>
+ </section>
+ </section>
+ <section class="tsd-panel-group tsd-member-group ">
+ <h2>Type aliases</h2>
+ <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter">
+ <a name="errorhandler" class="tsd-anchor"></a>
+ <h3>Error<wbr>Handler</h3>
+ <div class="tsd-signature tsd-kind-icon">Error<wbr>Handler<Worker><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Worker</span>, e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</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#L24">src/pools/abstract-pool.ts:24</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Callback invoked if the worker raised an error.</p>
+ </div>
+ </div>
+ <h4 class="tsd-type-parameters-title">Type parameters</h4>
+ <ul class="tsd-type-parameters">
+ <li>
+ <h4>Worker</h4>
+ </li>
+ </ul>
+ <div class="tsd-type-declaration">
+ <h4>Type declaration</h4>
+ <ul class="tsd-parameters">
+ <li class="tsd-parameter-signature">
+ <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias">
+ <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Worker</span>, e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</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>this: <span class="tsd-signature-type">Worker</span></h5>
+ </li>
+ <li>
+ <h5>e: <span class="tsd-signature-type">Error</span></h5>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter">
+ <a name="exithandler" class="tsd-anchor"></a>
+ <h3>Exit<wbr>Handler</h3>
+ <div class="tsd-signature tsd-kind-icon">Exit<wbr>Handler<Worker><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Worker</span>, code<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">void</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#L34">src/pools/abstract-pool.ts:34</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Callback invoked when the worker exits successfully.</p>
+ </div>
+ </div>
+ <h4 class="tsd-type-parameters-title">Type parameters</h4>
+ <ul class="tsd-type-parameters">
+ <li>
+ <h4>Worker</h4>
+ </li>
+ </ul>
+ <div class="tsd-type-declaration">
+ <h4>Type declaration</h4>
+ <ul class="tsd-parameters">
+ <li class="tsd-parameter-signature">
+ <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias">
+ <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Worker</span>, code<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">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>this: <span class="tsd-signature-type">Worker</span></h5>
+ </li>
+ <li>
+ <h5>code: <span class="tsd-signature-type">number</span></h5>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-type-alias">
+ <a name="killbehavior" class="tsd-anchor"></a>
+ <h3>Kill<wbr>Behavior</h3>
+ <div class="tsd-signature tsd-kind-icon">Kill<wbr>Behavior<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-symbol">typeof </span><a href="index.html#killbehaviors" class="tsd-signature-type" data-tsd-kind="Variable">KillBehaviors</a></div>
+ <aside class="tsd-sources">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/worker-options.ts#L18">src/worker/worker-options.ts:18</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Kill behavior.</p>
+ </div>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter">
+ <a name="onlinehandler" class="tsd-anchor"></a>
+ <h3>Online<wbr>Handler</h3>
+ <div class="tsd-signature tsd-kind-icon">Online<wbr>Handler<Worker><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>this<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></div>
+ <aside class="tsd-sources">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L29">src/pools/abstract-pool.ts:29</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Callback invoked when the worker has started successfully.</p>
+ </div>
+ </div>
+ <h4 class="tsd-type-parameters-title">Type parameters</h4>
+ <ul class="tsd-type-parameters">
+ <li>
+ <h4>Worker</h4>
+ </li>
+ </ul>
+ <div class="tsd-type-declaration">
+ <h4>Type declaration</h4>
+ <ul class="tsd-parameters">
+ <li class="tsd-parameter-signature">
+ <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias">
+ <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>this<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">
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>this: <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>
+ </li>
+ </ul>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-type-alias">
+ <a name="threadworkerwithmessagechannel" class="tsd-anchor"></a>
+ <h3>Thread<wbr>Worker<wbr>With<wbr>Message<wbr>Channel</h3>
+ <div class="tsd-signature tsd-kind-icon">Thread<wbr>Worker<wbr>With<wbr>Message<wbr>Channel<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Worker</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Draft</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MessageChannel</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/thread/fixed.ts#L9">src/pools/thread/fixed.ts:9</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>A thread worker with message channels for communication between main thread and thread worker.</p>
+ </div>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-type-alias">
+ <a name="workerchoicestrategy" class="tsd-anchor"></a>
+ <h3>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-symbol">keyof </span><span class="tsd-signature-symbol">typeof </span><a href="index.html#workerchoicestrategies" class="tsd-signature-type" data-tsd-kind="Variable">WorkerChoiceStrategies</a></div>
+ <aside class="tsd-sources">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/selection-strategies.ts#L21">src/pools/selection-strategies.ts:21</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Worker choice strategy.</p>
+ </div>
+ </div>
+ </section>
+ </section>
+ <section class="tsd-panel-group tsd-member-group ">
+ <h2>Variables</h2>
+ <section class="tsd-panel tsd-member tsd-kind-variable">
+ <a name="killbehaviors" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagConst">Const</span> Kill<wbr>Behaviors</h3>
+ <div class="tsd-signature tsd-kind-icon">Kill<wbr>Behaviors<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>HARD<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"HARD"</span><span class="tsd-signature-symbol">; </span>SOFT<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"SOFT"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></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/worker/worker-options.ts#L4">src/worker/worker-options.ts:4</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Enumeration of kill behaviors.</p>
+ </div>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-variable">
+ <a name="workerchoicestrategies" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagConst">Const</span> Worker<wbr>Choice<wbr>Strategies</h3>
+ <div class="tsd-signature tsd-kind-icon">Worker<wbr>Choice<wbr>Strategies<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>LESS_RECENTLY_USED<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"LESS_RECENTLY_USED"</span><span class="tsd-signature-symbol">; </span>ROUND_ROBIN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"ROUND_ROBIN"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></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/selection-strategies.ts#L7">src/pools/selection-strategies.ts:7</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Enumeration of worker choice strategies.</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="current ">
+ <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="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
--- /dev/null
+<!doctype html>
+<html class="default no-js">
+<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/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="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">
+ <p>Options for a poolifier cluster pool.</p>
+ </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"><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#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">
+ <a name="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/jerome-benoit/poolifier/blob/5d4101b/src/pools/cluster/fixed.ts#L16">src/pools/cluster/fixed.ts:16</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Key/value pairs to add to worker process environment.</p>
+ </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>
+ </dd>
+ </dl>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
+ <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">
+ <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/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 tsd-is-inherited">
+ <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">
+ <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/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 tsd-is-inherited">
+ <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">
+ <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/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 tsd-is-inherited">
+ <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">
+ <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/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>
+ </ul>
+ <ul class="current">
+ <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">
+ <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#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>
+ <ul class="after-current">
+ <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>
+ <li class=" tsd-kind-interface tsd-has-type-parameter">
+ <a href="pooloptions.html" class="tsd-kind-icon">Pool<wbr>Options</a>
+ </li>
+ <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
--- /dev/null
+<!doctype html>
+<html class="default no-js">
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <title>IPool | 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="ipool.html">IPool</a>
+ </li>
+ </ul>
+ <h1>Interface IPool<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>Contract definition 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>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>
+ <span class="target">IPool</span>
+ </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>Methods</h3>
+ <ul class="tsd-index-list">
+ <li class="tsd-kind-method tsd-parent-kind-interface"><a href="ipool.html#destroy" class="tsd-kind-icon">destroy</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-interface"><a href="ipool.html#execute" class="tsd-kind-icon">execute</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-interface"><a href="ipool.html#setworkerchoicestrategy" class="tsd-kind-icon">set<wbr>Worker<wbr>Choice<wbr>Strategy</a></li>
+ </ul>
+ </section>
+ </div>
+ </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-interface">
+ <a name="destroy" class="tsd-anchor"></a>
+ <h3>destroy</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
+ <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">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/pool.ts#L20">src/pools/pool.ts:20</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Shut down every current worker in this pool.</p>
+ </div>
+ </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-interface">
+ <a name="execute" class="tsd-anchor"></a>
+ <h3>execute</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
+ <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">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/pool.ts#L16">src/pools/pool.ts:16</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Perform the task specified in the constructor with the data parameter.</p>
+ </div>
+ </div>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>data: <span class="tsd-signature-type">Data</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>The input for the specified task. This can only be serializable data.</p>
+ </div>
+ </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>
+ <p>Promise that will be resolved when the task is successfully completed.</p>
+ </li>
+ </ul>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
+ <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-interface">
+ <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">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/pool.ts#L26">src/pools/pool.ts:26</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Set the worker choice strategy in this pool.</p>
+ </div>
+ </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>
+ <div class="tsd-comment tsd-typography">
+ <p>The worker choice strategy.</p>
+ </div>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
+ </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="../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>
+ </ul>
+ <ul class="current">
+ <li class="current tsd-kind-interface tsd-has-type-parameter">
+ <a href="ipool.html" class="tsd-kind-icon">IPool</a>
+ <ul>
+ <li class=" tsd-kind-method tsd-parent-kind-interface">
+ <a href="ipool.html#destroy" class="tsd-kind-icon">destroy</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-interface">
+ <a href="ipool.html#execute" class="tsd-kind-icon">execute</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-interface">
+ <a href="ipool.html#setworkerchoicestrategy" class="tsd-kind-icon">set<wbr>Worker<wbr>Choice<wbr>Strategy</a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ <ul class="after-current">
+ <li class=" tsd-kind-interface">
+ <a href="iworker.html" class="tsd-kind-icon">IWorker</a>
+ </li>
+ <li class=" tsd-kind-interface tsd-has-type-parameter">
+ <a href="pooloptions.html" class="tsd-kind-icon">Pool<wbr>Options</a>
+ </li>
+ <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
--- /dev/null
+<!doctype html>
+<html class="default no-js">
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <title>IWorker | 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="iworker.html">IWorker</a>
+ </li>
+ </ul>
+ <h1>Interface IWorker</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>Basic interface that describes the minimum required implementation of listener events for a pool-worker.</p>
+ </div>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-hierarchy">
+ <h3>Hierarchy</h3>
+ <ul class="tsd-hierarchy">
+ <li>
+ <span class="target">IWorker</span>
+ </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>Methods</h3>
+ <ul class="tsd-index-list">
+ <li class="tsd-kind-method tsd-parent-kind-interface"><a href="iworker.html#on" class="tsd-kind-icon">on</a></li>
+ <li class="tsd-kind-method tsd-parent-kind-interface"><a href="iworker.html#once" class="tsd-kind-icon">once</a></li>
+ </ul>
+ </section>
+ </div>
+ </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-interface">
+ <a name="on" class="tsd-anchor"></a>
+ <h3>on</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
+ <li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"error"</span>, 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><a href="iworker.html" class="tsd-signature-type" data-tsd-kind="Interface">IWorker</a><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>
+ <li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"online"</span>, 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><a href="iworker.html" class="tsd-signature-type" data-tsd-kind="Interface">IWorker</a><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>
+ <li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"exit"</span>, 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><a href="iworker.html" class="tsd-signature-type" data-tsd-kind="Interface">IWorker</a><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">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L46">src/pools/abstract-pool.ts:46</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Register a listener to the error event.</p>
+ </div>
+ </div>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>event: <span class="tsd-signature-type">"error"</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p><code>'error'</code>.</p>
+ </div>
+ </li>
+ <li>
+ <h5>handler: <a href="../index.html#errorhandler" class="tsd-signature-type" data-tsd-kind="Type alias">ErrorHandler</a><span class="tsd-signature-symbol"><</span><a href="iworker.html" class="tsd-signature-type" data-tsd-kind="Interface">IWorker</a><span class="tsd-signature-symbol">></span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>The error handler.</p>
+ </div>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
+ </li>
+ <li class="tsd-description">
+ <aside class="tsd-sources">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L53">src/pools/abstract-pool.ts:53</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Register a listener to the online event.</p>
+ </div>
+ </div>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>event: <span class="tsd-signature-type">"online"</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p><code>'online'</code>.</p>
+ </div>
+ </li>
+ <li>
+ <h5>handler: <a href="../index.html#onlinehandler" class="tsd-signature-type" data-tsd-kind="Type alias">OnlineHandler</a><span class="tsd-signature-symbol"><</span><a href="iworker.html" class="tsd-signature-type" data-tsd-kind="Interface">IWorker</a><span class="tsd-signature-symbol">></span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>The online handler.</p>
+ </div>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
+ </li>
+ <li class="tsd-description">
+ <aside class="tsd-sources">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L60">src/pools/abstract-pool.ts:60</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Register a listener to the exit event.</p>
+ </div>
+ </div>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>event: <span class="tsd-signature-type">"exit"</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p><code>'exit'</code>.</p>
+ </div>
+ </li>
+ <li>
+ <h5>handler: <a href="../index.html#exithandler" class="tsd-signature-type" data-tsd-kind="Type alias">ExitHandler</a><span class="tsd-signature-symbol"><</span><a href="iworker.html" class="tsd-signature-type" data-tsd-kind="Interface">IWorker</a><span class="tsd-signature-symbol">></span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>The exit handler.</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-interface">
+ <a name="once" class="tsd-anchor"></a>
+ <h3>once</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
+ <li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"exit"</span>, 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><a href="iworker.html" class="tsd-signature-type" data-tsd-kind="Interface">IWorker</a><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">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L67">src/pools/abstract-pool.ts:67</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Register a listener to the exit event that will only performed once.</p>
+ </div>
+ </div>
+ <h4 class="tsd-parameters-title">Parameters</h4>
+ <ul class="tsd-parameters">
+ <li>
+ <h5>event: <span class="tsd-signature-type">"exit"</span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p><code>'exit'</code>.</p>
+ </div>
+ </li>
+ <li>
+ <h5>handler: <a href="../index.html#exithandler" class="tsd-signature-type" data-tsd-kind="Type alias">ExitHandler</a><span class="tsd-signature-symbol"><</span><a href="iworker.html" class="tsd-signature-type" data-tsd-kind="Interface">IWorker</a><span class="tsd-signature-symbol">></span></h5>
+ <div class="tsd-comment tsd-typography">
+ <p>The exit handler.</p>
+ </div>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
+ </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="../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>
+ </ul>
+ <ul class="current">
+ <li class="current tsd-kind-interface">
+ <a href="iworker.html" class="tsd-kind-icon">IWorker</a>
+ <ul>
+ <li class=" tsd-kind-method tsd-parent-kind-interface">
+ <a href="iworker.html#on" class="tsd-kind-icon">on</a>
+ </li>
+ <li class=" tsd-kind-method tsd-parent-kind-interface">
+ <a href="iworker.html#once" class="tsd-kind-icon">once</a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ <ul class="after-current">
+ <li class=" tsd-kind-interface tsd-has-type-parameter">
+ <a href="pooloptions.html" class="tsd-kind-icon">Pool<wbr>Options</a>
+ </li>
+ <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
--- /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
--- /dev/null
+<!doctype html>
+<html class="default no-js">
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <title>WorkerOptions | 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="workeroptions.html">WorkerOptions</a>
+ </li>
+ </ul>
+ <h1>Interface WorkerOptions</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 workers.</p>
+ </div>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-hierarchy">
+ <h3>Hierarchy</h3>
+ <ul class="tsd-hierarchy">
+ <li>
+ <span class="target">WorkerOptions</span>
+ </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="workeroptions.html#async" class="tsd-kind-icon">async</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="workeroptions.html#killbehavior" class="tsd-kind-icon">kill<wbr>Behavior</a></li>
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="workeroptions.html#maxinactivetime" class="tsd-kind-icon">max<wbr>Inactive<wbr>Time</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="async" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> async</h3>
+ <div class="tsd-signature tsd-kind-icon">async<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/5d4101b/src/worker/worker-options.ts#L57">src/worker/worker-options.ts:57</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Whether your worker will perform asynchronous or not.</p>
+ </div>
+ <dl class="tsd-comment-tags">
+ <dt>default</dt>
+ <dd><p>false</p>
+ </dd>
+ </dl>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+ <a name="killbehavior" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> kill<wbr>Behavior</h3>
+ <div class="tsd-signature tsd-kind-icon">kill<wbr>Behavior<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"SOFT"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"HARD"</span></div>
+ <aside class="tsd-sources">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/worker-options.ts#L68">src/worker/worker-options.ts:68</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p><code>killBehavior</code> dictates if your async unit (worker/process) will be deleted in case that a task is active on it.</p>
+ </div>
+ <ul>
+ <li>SOFT: If <code>currentTime - lastActiveTime</code> is greater than <code>maxInactiveTime</code> but a task is still running, then the worker <strong>won't</strong> be deleted.</li>
+ <li>HARD: If <code>lastActiveTime</code> is greater than <code>maxInactiveTime</code> but a task is still running, then the worker will be deleted.</li>
+ </ul>
+ <p>This option only apply to the newly created workers.</p>
+ <dl class="tsd-comment-tags">
+ <dt>default</dt>
+ <dd><p>KillBehaviors.SOFT</p>
+ </dd>
+ </dl>
+ </div>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+ <a name="maxinactivetime" class="tsd-anchor"></a>
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Inactive<wbr>Time</h3>
+ <div class="tsd-signature tsd-kind-icon">max<wbr>Inactive<wbr>Time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
+ <aside class="tsd-sources">
+ <ul>
+ <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/worker/worker-options.ts#L51">src/worker/worker-options.ts:51</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Maximum waiting time in milliseconds for tasks.</p>
+ </div>
+ <p>After this time, newly created workers will be terminated.
+ The last active time of your worker unit will be updated when a task is submitted to a worker or when a worker terminate a task.</p>
+ <ul>
+ <li>If <code>killBehavior</code> is set to <code>KillBehaviors.HARD</code> this value represents also the timeout for the tasks that you submit to the pool,
+ when this timeout expires your tasks is interrupted and the worker is killed if is not part of the minimum size of the pool.</li>
+ <li>If <code>killBehavior</code> is set to <code>KillBehaviors.SOFT</code> your tasks have no timeout and your workers will not be terminated until your task is completed.</li>
+ </ul>
+ <dl class="tsd-comment-tags">
+ <dt>default</dt>
+ <dd><p>60.000 ms</p>
+ </dd>
+ </dl>
+ </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>
+ <li class=" tsd-kind-interface tsd-has-type-parameter">
+ <a href="pooloptions.html" class="tsd-kind-icon">Pool<wbr>Options</a>
+ </li>
+ </ul>
+ <ul class="current">
+ <li class="current tsd-kind-interface">
+ <a href="workeroptions.html" class="tsd-kind-icon">Worker<wbr>Options</a>
+ <ul>
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
+ <a href="workeroptions.html#async" class="tsd-kind-icon">async</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
+ <a href="workeroptions.html#killbehavior" class="tsd-kind-icon">kill<wbr>Behavior</a>
+ </li>
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
+ <a href="workeroptions.html#maxinactivetime" class="tsd-kind-icon">max<wbr>Inactive<wbr>Time</a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ <ul class="after-current">
+ <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
"integrity": "sha512-Z7tMw1ytTXt5jqMcOP+OQteU1VuNK9Y02uuJtKQ1Sv69jXQKKg5cibLwGJow8yzZP+eAc18EmLGPal0bp36rvQ==",
"dev": true
},
+ "at-least-node": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/at-least-node/-/at-least-node-1.0.0.tgz",
+ "integrity": "sha512-+q/t7Ekv1EDY2l6Gda6LLiX14rU9TV20Wa3ofeQmwPFZbOMo9DXrLbOjFaaclkXKWidIaopwAObQDqwWtGUjqg==",
+ "dev": true
+ },
"bail": {
"version": "1.0.5",
"resolved": "https://registry.npmjs.org/bail/-/bail-1.0.5.tgz",
"integrity": "sha512-puCDz0CzydiSYOrnXpz/PKd69zRrribezjtE9yd4zvytoRc8+RY/KJPvtPFKZS3E3wP6neGyMe0vOTlHO5L3Pw==",
"dev": true
},
+ "colors": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/colors/-/colors-1.4.0.tgz",
+ "integrity": "sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==",
+ "dev": true
+ },
"commander": {
"version": "2.20.3",
"resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz",
"integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==",
"dev": true
},
+ "interpret": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/interpret/-/interpret-1.4.0.tgz",
+ "integrity": "sha512-agE4QfB2Lkp9uICn7BAqoscw4SZP9kTE2hxiFI3jBPmXJfdqiahTbUuKGsMoN2GtqL9AxhYioAcVvgsb1HvRbA==",
+ "dev": true
+ },
"is-alphabetical": {
"version": "1.0.4",
"resolved": "https://registry.npmjs.org/is-alphabetical/-/is-alphabetical-1.0.4.tgz",
"yallist": "^4.0.0"
}
},
+ "lunr": {
+ "version": "2.3.9",
+ "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz",
+ "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==",
+ "dev": true
+ },
"make-dir": {
"version": "3.1.0",
"resolved": "https://registry.npmjs.org/make-dir/-/make-dir-3.1.0.tgz",
"integrity": "sha512-8z4efJYk43E0upd0NbVXwgSTQs6cT3T06etieCMEg7dRbzCbxUCK/GHlX8mhHRDcp+OLlHkPKsvqQTCvsRl2cg==",
"dev": true
},
+ "marked": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/marked/-/marked-2.0.0.tgz",
+ "integrity": "sha512-NqRSh2+LlN2NInpqTQnS614Y/3NkVMFFU6sJlRFEpxJ/LHuK/qJECH7/fXZjk4VZstPW/Pevjil/VtSONsLc7Q==",
+ "dev": true
+ },
"mem": {
"version": "6.1.1",
"resolved": "https://registry.npmjs.org/mem/-/mem-6.1.1.tgz",
"wrappy": "1"
}
},
+ "onigasm": {
+ "version": "2.2.5",
+ "resolved": "https://registry.npmjs.org/onigasm/-/onigasm-2.2.5.tgz",
+ "integrity": "sha512-F+th54mPc0l1lp1ZcFMyL/jTs2Tlq4SqIHKIXGZOR/VkHkF9A7Fr5rRr5+ZG/lWeRsyrClLYRq7s/yFQ/XhWCA==",
+ "dev": true,
+ "requires": {
+ "lru-cache": "^5.1.1"
+ },
+ "dependencies": {
+ "lru-cache": {
+ "version": "5.1.1",
+ "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz",
+ "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==",
+ "dev": true,
+ "requires": {
+ "yallist": "^3.0.2"
+ }
+ },
+ "yallist": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz",
+ "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==",
+ "dev": true
+ }
+ }
+ },
"optionator": {
"version": "0.9.1",
"resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.1.tgz",
"picomatch": "^2.2.1"
}
},
+ "rechoir": {
+ "version": "0.6.2",
+ "resolved": "https://registry.npmjs.org/rechoir/-/rechoir-0.6.2.tgz",
+ "integrity": "sha1-hSBLVNuoLVdC4oyWdW70OvUOM4Q=",
+ "dev": true,
+ "requires": {
+ "resolve": "^1.1.6"
+ }
+ },
"regexp-util": {
"version": "1.2.2",
"resolved": "https://registry.npmjs.org/regexp-util/-/regexp-util-1.2.2.tgz",
"integrity": "sha512-LL9GEt3bkXp6Wa19SNR5MWcvHNMvuTFYg+eYBZN2OIFhSWN+pEJUQXEKu5BsOeABob3x9PDaLKW7w5iOJnsESQ==",
"dev": true
},
+ "rollup-plugin-command": {
+ "version": "1.1.3",
+ "resolved": "https://registry.npmjs.org/rollup-plugin-command/-/rollup-plugin-command-1.1.3.tgz",
+ "integrity": "sha512-9nIcP5mgVYWGU7x/6ufTgtqI4vl5vvsYs6fTTil91NX53EIPcim42FXmq1TPdZRFJbUM1ikrg05clahPxObL1g==",
+ "dev": true
+ },
"rollup-plugin-delete": {
"version": "2.0.0",
"resolved": "https://registry.npmjs.org/rollup-plugin-delete/-/rollup-plugin-delete-2.0.0.tgz",
"integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==",
"dev": true
},
+ "shelljs": {
+ "version": "0.8.4",
+ "resolved": "https://registry.npmjs.org/shelljs/-/shelljs-0.8.4.tgz",
+ "integrity": "sha512-7gk3UZ9kOfPLIAbslLzyWeGiEqx9e3rxwZM0KE6EL8GlGwjym9Mrlx5/p33bWTu9YG6vcS4MBxYZDHYr5lr8BQ==",
+ "dev": true,
+ "requires": {
+ "glob": "^7.0.0",
+ "interpret": "^1.0.0",
+ "rechoir": "^0.6.2"
+ }
+ },
+ "shiki": {
+ "version": "0.9.2",
+ "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.9.2.tgz",
+ "integrity": "sha512-BjUCxVbxMnvjs8jC4b+BQ808vwjJ9Q8NtLqPwXShZ307HdXiDFYP968ORSVfaTNNSWYDBYdMnVKJ0fYNsoZUBA==",
+ "dev": true,
+ "requires": {
+ "onigasm": "^2.2.5",
+ "vscode-textmate": "^5.2.0"
+ }
+ },
"sigmund": {
"version": "1.0.1",
"resolved": "https://registry.npmjs.org/sigmund/-/sigmund-1.0.1.tgz",
"is-typedarray": "^1.0.0"
}
},
+ "typedoc": {
+ "version": "0.20.28",
+ "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.20.28.tgz",
+ "integrity": "sha512-8j0T8u9FuyDkoe+M/3cyoaGJSVgXCY9KwVoo7TLUnmQuzXwqH+wkScY530ZEdK6G39UZ2LFTYPIrL5eykWjx6A==",
+ "dev": true,
+ "requires": {
+ "colors": "^1.4.0",
+ "fs-extra": "^9.1.0",
+ "handlebars": "^4.7.7",
+ "lodash": "^4.17.21",
+ "lunr": "^2.3.9",
+ "marked": "^2.0.0",
+ "minimatch": "^3.0.0",
+ "progress": "^2.0.3",
+ "shelljs": "^0.8.4",
+ "shiki": "^0.9.2",
+ "typedoc-default-themes": "^0.12.7"
+ },
+ "dependencies": {
+ "fs-extra": {
+ "version": "9.1.0",
+ "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-9.1.0.tgz",
+ "integrity": "sha512-hcg3ZmepS30/7BSFqRvoo3DOMQu7IjqxO5nCDt+zM9XWjb33Wg7ziNT+Qvqbuc3+gWpzO02JubVyk2G4Zvo1OQ==",
+ "dev": true,
+ "requires": {
+ "at-least-node": "^1.0.0",
+ "graceful-fs": "^4.2.0",
+ "jsonfile": "^6.0.1",
+ "universalify": "^2.0.0"
+ }
+ },
+ "jsonfile": {
+ "version": "6.1.0",
+ "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz",
+ "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==",
+ "dev": true,
+ "requires": {
+ "graceful-fs": "^4.1.6",
+ "universalify": "^2.0.0"
+ }
+ },
+ "universalify": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.0.tgz",
+ "integrity": "sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ==",
+ "dev": true
+ }
+ }
+ },
+ "typedoc-default-themes": {
+ "version": "0.12.7",
+ "resolved": "https://registry.npmjs.org/typedoc-default-themes/-/typedoc-default-themes-0.12.7.tgz",
+ "integrity": "sha512-0XAuGEqID+gon1+fhi4LycOEFM+5Mvm2PjwaiVZNAzU7pn3G2DEpsoXnFOPlLDnHY6ZW0BY0nO7ur9fHOFkBLQ==",
+ "dev": true
+ },
"typescript": {
"version": "4.2.2",
"resolved": "https://registry.npmjs.org/typescript/-/typescript-4.2.2.tgz",
}
}
},
+ "vscode-textmate": {
+ "version": "5.2.0",
+ "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-5.2.0.tgz",
+ "integrity": "sha512-Uw5ooOQxRASHgu6C7GVvUxisKXfSgW4oFlO+aa+PAkgmH89O3CXxEEzNRNtHSqtXFTl0nAC1uYj0GMSH27uwtQ==",
+ "dev": true
+ },
"which": {
"version": "2.0.2",
"resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz",
"format": "prettier --loglevel silent --write .; prettierx --write .",
"lint": "eslint .",
"lint:fix": "eslint . --fix",
+ "typedoc": "typedoc",
"prepublishOnly": "npm run build:prod"
},
"repository": {
"prettierx": "^0.17.0",
"rollup": "^2.39.1",
"rollup-plugin-analyzer": "^4.0.0",
+ "rollup-plugin-command": "^1.1.3",
"rollup-plugin-delete": "^2.0.0",
"rollup-plugin-terser": "^7.0.2",
"rollup-plugin-typescript2": "^0.30.0",
"sonar-scanner": "^3.1.0",
"source-map-support": "^0.5.19",
+ "typedoc": "^0.20.28",
"typescript": "^4.2.2"
},
"engines": {
import analyze from 'rollup-plugin-analyzer'
import { terser } from 'rollup-plugin-terser'
import del from 'rollup-plugin-delete'
+import command from 'rollup-plugin-command'
const isDevelopmentBuild = process.env.BUILD === 'development'
const isAnalyze = process.env.ANALYZE
+const isDocumentation = process.env.DOCUMENTATION
export default {
input: 'src/index.ts',
del({
targets: ['lib/*']
}),
- isAnalyze && analyze()
+ isAnalyze && analyze(),
+ isDocumentation && command('npm run typedoc')
]
}
--- /dev/null
+{
+ "entryPoints": ["src/index.ts"],
+ "out": "docs",
+ "readme": "none"
+}
repositories / poolifier.git / commitdiff
