Skip to content

Commit 83da2d0

Browse files
CMCDragonkaiCMCDragonkai
committed
Updated docs
1 parent 32f7419 commit 83da2d0

13 files changed

Lines changed: 384 additions & 193 deletions

‎docs/assets/js/search.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/classes/WorkerManager.default.html‎

Lines changed: 22 additions & 101 deletions
Large diffs are not rendered by default.

‎docs/classes/errors.ErrorWorkerManager.html‎

Lines changed: 160 additions & 26 deletions
Large diffs are not rendered by default.

docs/classes/errors.ErrorWorkerManagerNotRunning.html renamed to docs/classes/errors.ErrorWorkerManagerDestroyed.html

Lines changed: 168 additions & 34 deletions
Large diffs are not rendered by default.

‎docs/index.html‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -180,11 +180,10 @@ <h2>Legend</h2>
180180
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
181181
</ul>
182182
<ul class="tsd-legend">
183-
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
184-
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
183+
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
185184
</ul>
186185
<ul class="tsd-legend">
187-
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
186+
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
188187
</ul>
189188
</div>
190189
</div>

‎docs/interfaces/WorkerManagerInterface.default.html‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
177177
<a name="destroy" class="tsd-anchor"></a>
178178
<h3>destroy</h3>
179179
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
180-
<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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
180+
<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>force<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
181181
</ul>
182182
<ul class="tsd-descriptions">
183183
<li class="tsd-description">
@@ -186,6 +186,17 @@ <h3>destroy</h3>
186186
<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/master/src/WorkerManagerInterface.ts#L6">src/WorkerManagerInterface.ts:6</a></li>
187187
</ul>
188188
</aside>
189+
<h4 class="tsd-parameters-title">Parameters</h4>
190+
<ul class="tsd-parameters">
191+
<li>
192+
<h5>options: <span class="tsd-signature-symbol">{ </span>force<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h5>
193+
<ul class="tsd-parameters">
194+
<li class="tsd-parameter">
195+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> force<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
196+
</li>
197+
</ul>
198+
</li>
199+
</ul>
189200
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
190201
</li>
191202
</ul>
@@ -326,7 +337,6 @@ <h2>Legend</h2>
326337
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
327338
</ul>
328339
<ul class="tsd-legend">
329-
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
330340
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
331341
</ul>
332342
</div>

‎docs/modules.html‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,11 +118,10 @@ <h2>Legend</h2>
118118
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
119119
</ul>
120120
<ul class="tsd-legend">
121-
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
122-
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
121+
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
123122
</ul>
124123
<ul class="tsd-legend">
125-
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
124+
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
126125
</ul>
127126
</div>
128127
</div>

‎docs/modules/WorkerManager.html‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -124,11 +124,10 @@ <h2>Legend</h2>
124124
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
125125
</ul>
126126
<ul class="tsd-legend">
127-
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
128-
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
127+
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
129128
</ul>
130129
<ul class="tsd-legend">
131-
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
130+
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
132131
</ul>
133132
</div>
134133
</div>

‎docs/modules/WorkerManagerInterface.html‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -124,11 +124,10 @@ <h2>Legend</h2>
124124
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
125125
</ul>
126126
<ul class="tsd-legend">
127-
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
128-
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
127+
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
129128
</ul>
130129
<ul class="tsd-legend">
131-
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
130+
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
132131
</ul>
133132
</div>
134133
</div>

‎docs/modules/errors.html‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ <h2>Index</h2>
7272
<section class="tsd-index-section ">
7373
<h3>Classes</h3>
7474
<ul class="tsd-index-list">
75-
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/errors.ErrorWorkerManager.html" class="tsd-kind-icon">Error<wbr>Worker<wbr>Manager</a></li>
76-
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/errors.ErrorWorkerManagerNotRunning.html" class="tsd-kind-icon">Error<wbr>Worker<wbr>Manager<wbr>Not<wbr>Running</a></li>
75+
<li class="tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter"><a href="../classes/errors.ErrorWorkerManager.html" class="tsd-kind-icon">Error<wbr>Worker<wbr>Manager</a></li>
76+
<li class="tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter"><a href="../classes/errors.ErrorWorkerManagerDestroyed.html" class="tsd-kind-icon">Error<wbr>Worker<wbr>Manager<wbr>Destroyed</a></li>
7777
</ul>
7878
</section>
7979
</div>
@@ -108,11 +108,11 @@ <h3>Classes</h3>
108108
</nav>
109109
<nav class="tsd-navigation secondary menu-sticky">
110110
<ul class="before-current">
111-
<li class=" tsd-kind-class tsd-parent-kind-module">
111+
<li class=" tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter">
112112
<a href="../classes/errors.ErrorWorkerManager.html" class="tsd-kind-icon">Error<wbr>Worker<wbr>Manager</a>
113113
</li>
114-
<li class=" tsd-kind-class tsd-parent-kind-module">
115-
<a href="../classes/errors.ErrorWorkerManagerNotRunning.html" class="tsd-kind-icon">Error<wbr>Worker<wbr>Manager<wbr>Not<wbr>Running</a>
114+
<li class=" tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter">
115+
<a href="../classes/errors.ErrorWorkerManagerDestroyed.html" class="tsd-kind-icon">Error<wbr>Worker<wbr>Manager<wbr>Destroyed</a>
116116
</li>
117117
</ul>
118118
</nav>
@@ -128,11 +128,10 @@ <h2>Legend</h2>
128128
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
129129
</ul>
130130
<ul class="tsd-legend">
131-
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
132-
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
131+
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
133132
</ul>
134133
<ul class="tsd-legend">
135-
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
134+
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
136135
</ul>
137136
</div>
138137
</div>

0 commit comments

Comments
 (0)