Skip to content

Commit 89b634a

Browse files
CMCDragonkaiCMCDragonkai
committed
Updated docs
1 parent daa24c5 commit 89b634a

8 files changed

Lines changed: 285 additions & 253 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: 126 additions & 64 deletions
Large diffs are not rendered by default.

‎docs/classes/errors.ErrorWorkerManager.html‎

Lines changed: 48 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ <h3>Hierarchy</h3>
7878
<span class="target">ErrorWorkerManager</span>
7979
<ul class="tsd-hierarchy">
8080
<li>
81-
<a href="errors.ErrorWorkerManagerNotStarted.html" class="tsd-signature-type" data-tsd-kind="Class">ErrorWorkerManagerNotStarted</a>
81+
<a href="errors.ErrorWorkerManagerNotRunning.html" class="tsd-signature-type" data-tsd-kind="Class">ErrorWorkerManagerNotRunning</a>
8282
</li>
8383
</ul>
8484
</li>
@@ -102,14 +102,14 @@ <h3>Properties</h3>
102102
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.ErrorWorkerManager.html#message" class="tsd-kind-icon">message</a></li>
103103
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.ErrorWorkerManager.html#name" class="tsd-kind-icon">name</a></li>
104104
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.ErrorWorkerManager.html#stack" class="tsd-kind-icon">stack</a></li>
105+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="errors.ErrorWorkerManager.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a></li>
105106
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="errors.ErrorWorkerManager.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a></li>
106107
</ul>
107108
</section>
108109
<section class="tsd-index-section tsd-is-inherited tsd-is-external">
109110
<h3>Methods</h3>
110111
<ul class="tsd-index-list">
111112
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="errors.ErrorWorkerManager.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a></li>
112-
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="errors.ErrorWorkerManager.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a></li>
113113
</ul>
114114
</section>
115115
</div>
@@ -177,14 +177,54 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
177177
</ul>
178178
</aside>
179179
</section>
180+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
181+
<a name="prepareStackTrace" class="tsd-anchor"></a>
182+
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr>Stack<wbr>Trace</h3>
183+
<div class="tsd-signature tsd-kind-icon">prepare<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div>
184+
<aside class="tsd-sources">
185+
<p>Inherited from CustomError.prepareStackTrace</p>
186+
<ul>
187+
<li>Defined in node_modules/@types/node/globals.d.ts:11</li>
188+
</ul>
189+
</aside>
190+
<div class="tsd-type-declaration">
191+
<h4>Type declaration</h4>
192+
<ul class="tsd-parameters">
193+
<li class="tsd-parameter-signature">
194+
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
195+
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</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></li>
196+
</ul>
197+
<ul class="tsd-descriptions">
198+
<li class="tsd-description">
199+
<div class="tsd-comment tsd-typography">
200+
<div class="lead">
201+
<p>Optional override for formatting stack traces</p>
202+
</div>
203+
</div>
204+
<h4 class="tsd-parameters-title">Parameters</h4>
205+
<ul class="tsd-parameters">
206+
<li>
207+
<h5>err: <span class="tsd-signature-type">Error</span></h5>
208+
</li>
209+
<li>
210+
<h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5>
211+
</li>
212+
</ul>
213+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
214+
</li>
215+
</ul>
216+
</li>
217+
</ul>
218+
</div>
219+
</section>
180220
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
181221
<a name="stackTraceLimit" class="tsd-anchor"></a>
182222
<h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr>Trace<wbr>Limit</h3>
183223
<div class="tsd-signature tsd-kind-icon">stack<wbr>Trace<wbr>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
184224
<aside class="tsd-sources">
185225
<p>Inherited from CustomError.stackTraceLimit</p>
186226
<ul>
187-
<li>Defined in node_modules/@types/node/globals.d.ts:117</li>
227+
<li>Defined in node_modules/@types/node/globals.d.ts:13</li>
188228
</ul>
189229
</aside>
190230
</section>
@@ -202,7 +242,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr>Stack<wbr>Tra
202242
<aside class="tsd-sources">
203243
<p>Inherited from CustomError.captureStackTrace</p>
204244
<ul>
205-
<li>Defined in node_modules/@types/node/globals.d.ts:108</li>
245+
<li>Defined in node_modules/@types/node/globals.d.ts:4</li>
206246
</ul>
207247
</aside>
208248
<div class="tsd-comment tsd-typography">
@@ -223,43 +263,6 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
223263
</li>
224264
</ul>
225265
</section>
226-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
227-
<a name="prepareStackTrace" class="tsd-anchor"></a>
228-
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr>Stack<wbr>Trace</h3>
229-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
230-
<li class="tsd-signature tsd-kind-icon">prepare<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</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></li>
231-
</ul>
232-
<ul class="tsd-descriptions">
233-
<li class="tsd-description">
234-
<aside class="tsd-sources">
235-
<p>Inherited from CustomError.prepareStackTrace</p>
236-
<ul>
237-
<li>Defined in node_modules/@types/node/globals.d.ts:115</li>
238-
</ul>
239-
</aside>
240-
<div class="tsd-comment tsd-typography">
241-
<div class="lead">
242-
<p>Optional override for formatting stack traces</p>
243-
</div>
244-
<dl class="tsd-comment-tags">
245-
<dt>see</dt>
246-
<dd><p><a href="https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces">https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces</a></p>
247-
</dd>
248-
</dl>
249-
</div>
250-
<h4 class="tsd-parameters-title">Parameters</h4>
251-
<ul class="tsd-parameters">
252-
<li>
253-
<h5>err: <span class="tsd-signature-type">Error</span></h5>
254-
</li>
255-
<li>
256-
<h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5>
257-
</li>
258-
</ul>
259-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
260-
</li>
261-
</ul>
262-
</section>
263266
</section>
264267
</div>
265268
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
@@ -307,21 +310,21 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span
307310
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
308311
<a href="errors.ErrorWorkerManager.html#stack" class="tsd-kind-icon">stack</a>
309312
</li>
313+
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
314+
<a href="errors.ErrorWorkerManager.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a>
315+
</li>
310316
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
311317
<a href="errors.ErrorWorkerManager.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a>
312318
</li>
313319
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
314320
<a href="errors.ErrorWorkerManager.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a>
315321
</li>
316-
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
317-
<a href="errors.ErrorWorkerManager.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a>
318-
</li>
319322
</ul>
320323
</li>
321324
</ul>
322325
<ul class="after-current">
323326
<li class=" tsd-kind-class tsd-parent-kind-module">
324-
<a href="errors.ErrorWorkerManagerNotStarted.html" class="tsd-kind-icon">Error<wbr>Worker<wbr>Manager<wbr>Not<wbr>Started</a>
327+
<a href="errors.ErrorWorkerManagerNotRunning.html" class="tsd-kind-icon">Error<wbr>Worker<wbr>Manager<wbr>Not<wbr>Running</a>
325328
</li>
326329
</ul>
327330
</nav>

0 commit comments

Comments
 (0)