Skip to content

Commit b359ee9

Browse files
MajoredMajored
committed
Update live documentation
1 parent 44ed5e2 commit b359ee9

File tree

76 files changed

+340
-123
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+340
-123
lines changed

‎docs/live/AlertsHelper.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -753,7 +753,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AlertsHel
753753
<br class="clear">
754754

755755
<footer>
756-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Mar 07 2022 17:36:03 GMT+0000 (Greenwich Mean Time)
756+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri May 20 2022 19:20:16 GMT+0100 (British Summer Time)
757757
</footer>
758758

759759
<script> prettyPrint(); </script>

‎docs/live/ConversationsHelper.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1622,7 +1622,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AlertsHel
16221622
<br class="clear">
16231623

16241624
<footer>
1625-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Mar 07 2022 17:36:03 GMT+0000 (Greenwich Mean Time)
1625+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri May 20 2022 19:20:16 GMT+0100 (British Summer Time)
16261626
</footer>
16271627

16281628
<script> prettyPrint(); </script>

‎docs/live/DownloadsHelper.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2010,7 +2010,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AlertsHel
20102010
<br class="clear">
20112011

20122012
<footer>
2013-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Mar 07 2022 17:36:03 GMT+0000 (Greenwich Mean Time)
2013+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri May 20 2022 19:20:16 GMT+0100 (British Summer Time)
20142014
</footer>
20152015

20162016
<script> prettyPrint(); </script>

‎docs/live/Error.html

Lines changed: 223 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ <h5>Parameters:</h5>
250250

251251
<dt class="tag-source">Source:</dt>
252252
<dd class="tag-source"><ul class="dummy"><li>
253-
<a href="Error.js.html">Error.js</a>, <a href="Error.js.html#line27">line 27</a>
253+
<a href="Error.js.html">Error.js</a>, <a href="Error.js.html#line43">line 43</a>
254254
</li></ul></dd>
255255

256256

@@ -308,6 +308,226 @@ <h5>Returns:</h5>
308308

309309

310310

311+
<h4 class="name" id="code"><span class="type-signature"></span>code<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
312+
313+
314+
315+
316+
317+
318+
<div class="description">
319+
Returns the machine-readable code of the error.
320+
</div>
321+
322+
323+
324+
325+
326+
327+
328+
329+
330+
331+
332+
333+
334+
<dl class="details">
335+
336+
337+
338+
339+
340+
341+
342+
343+
344+
345+
346+
347+
348+
349+
350+
351+
352+
353+
354+
355+
356+
357+
358+
359+
360+
361+
<dt class="tag-source">Source:</dt>
362+
<dd class="tag-source"><ul class="dummy"><li>
363+
<a href="Error.js.html">Error.js</a>, <a href="Error.js.html#line26">line 26</a>
364+
</li></ul></dd>
365+
366+
367+
368+
369+
370+
371+
372+
</dl>
373+
374+
375+
376+
377+
378+
379+
380+
381+
382+
383+
384+
385+
386+
387+
388+
<h5>Returns:</h5>
389+
390+
391+
<div class="param-desc">
392+
The machine-readable error code.
393+
</div>
394+
395+
396+
397+
<dl>
398+
<dt>
399+
Type
400+
</dt>
401+
<dd>
402+
403+
<span class="param-type">string</span>
404+
405+
406+
</dd>
407+
</dl>
408+
409+
410+
411+
412+
413+
414+
415+
416+
417+
418+
419+
420+
421+
<h4 class="name" id="message"><span class="type-signature"></span>message<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
422+
423+
424+
425+
426+
427+
428+
<div class="description">
429+
Returns the human-readable message of the error.
430+
</div>
431+
432+
433+
434+
435+
436+
437+
438+
439+
440+
441+
442+
443+
444+
<dl class="details">
445+
446+
447+
448+
449+
450+
451+
452+
453+
454+
455+
456+
457+
458+
459+
460+
461+
462+
463+
464+
465+
466+
467+
468+
469+
470+
471+
<dt class="tag-source">Source:</dt>
472+
<dd class="tag-source"><ul class="dummy"><li>
473+
<a href="Error.js.html">Error.js</a>, <a href="Error.js.html#line34">line 34</a>
474+
</li></ul></dd>
475+
476+
477+
478+
479+
480+
481+
482+
</dl>
483+
484+
485+
486+
487+
488+
489+
490+
491+
492+
493+
494+
495+
496+
497+
498+
<h5>Returns:</h5>
499+
500+
501+
<div class="param-desc">
502+
The human-readable error message.
503+
</div>
504+
505+
506+
507+
<dl>
508+
<dt>
509+
Type
510+
</dt>
511+
<dd>
512+
513+
<span class="param-type">string</span>
514+
515+
516+
</dd>
517+
</dl>
518+
519+
520+
521+
522+
523+
524+
525+
526+
527+
528+
529+
530+
311531
<h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
312532

313533

@@ -316,7 +536,7 @@ <h4 class="name" id="toString"><span class="type-signature"></span>toString<span
316536

317537

318538
<div class="description">
319-
Converts this error into a human-readable string.
539+
Returns a string representation of this error including both the machine and human-readable parts.
320540
</div>
321541

322542

@@ -434,7 +654,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AlertsHel
434654
<br class="clear">
435655

436656
<footer>
437-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Mar 07 2022 17:36:03 GMT+0000 (Greenwich Mean Time)
657+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri May 20 2022 19:20:16 GMT+0100 (British Summer Time)
438658
</footer>
439659

440660
<script> prettyPrint(); </script>

‎docs/live/Error.js.html

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,30 @@ <h1 class="page-title">Source: Error.js</h1>
3939
this.#message = json.message;
4040
}
4141

42-
/** Converts this error into a human-readable string.
42+
/** Returns a string representation of this error including both the machine and human-readable parts.
4343
*
4444
* @returns {string} A string representation of this error.
4545
*/
4646
toString() {
4747
return `${this.#code}: ${this.#message}`;
4848
}
4949

50+
/** Returns the machine-readable code of the error.
51+
*
52+
* @returns {string} The machine-readable error code.
53+
*/
54+
code() {
55+
return this.#code;
56+
}
57+
58+
/** Returns the human-readable message of the error.
59+
*
60+
* @returns {string} The human-readable error message.
61+
*/
62+
message() {
63+
return this.#message;
64+
}
65+
5066
/** Constructs a new Error which originated within the wrapper.
5167
*
5268
* @param {string} message The internal error message.
@@ -73,7 +89,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AlertsHel
7389
<br class="clear">
7490

7591
<footer>
76-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Mar 07 2022 17:36:03 GMT+0000 (Greenwich Mean Time)
92+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri May 20 2022 19:20:16 GMT+0100 (British Summer Time)
7793
</footer>
7894

7995
<script> prettyPrint(); </script>

‎docs/live/Http.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ <h5>Parameters:</h5>
250250

251251
<dt class="tag-source">Source:</dt>
252252
<dd class="tag-source"><ul class="dummy"><li>
253-
<a href="Http.js.html">Http.js</a>, <a href="Http.js.html#line100">line 100</a>
253+
<a href="Http.js.html">Http.js</a>, <a href="Http.js.html#line93">line 93</a>
254254
</li></ul></dd>
255255

256256

@@ -627,7 +627,7 @@ <h5>Parameters:</h5>
627627

628628
<dt class="tag-source">Source:</dt>
629629
<dd class="tag-source"><ul class="dummy"><li>
630-
<a href="Http.js.html">Http.js</a>, <a href="Http.js.html#line137">line 137</a>
630+
<a href="Http.js.html">Http.js</a>, <a href="Http.js.html#line128">line 128</a>
631631
</li></ul></dd>
632632

633633

@@ -809,7 +809,7 @@ <h5>Parameters:</h5>
809809

810810
<dt class="tag-source">Source:</dt>
811811
<dd class="tag-source"><ul class="dummy"><li>
812-
<a href="Http.js.html">Http.js</a>, <a href="Http.js.html#line79">line 79</a>
812+
<a href="Http.js.html">Http.js</a>, <a href="Http.js.html#line74">line 74</a>
813813
</li></ul></dd>
814814

815815

@@ -969,7 +969,7 @@ <h5>Parameters:</h5>
969969

970970
<dt class="tag-source">Source:</dt>
971971
<dd class="tag-source"><ul class="dummy"><li>
972-
<a href="Http.js.html">Http.js</a>, <a href="Http.js.html#line57">line 57</a>
972+
<a href="Http.js.html">Http.js</a>, <a href="Http.js.html#line54">line 54</a>
973973
</li></ul></dd>
974974

975975

@@ -1043,7 +1043,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AlertsHel
10431043
<br class="clear">
10441044

10451045
<footer>
1046-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Mar 07 2022 17:36:03 GMT+0000 (Greenwich Mean Time)
1046+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri May 20 2022 19:20:16 GMT+0100 (British Summer Time)
10471047
</footer>
10481048

10491049
<script> prettyPrint(); </script>

0 commit comments

Comments
 (0)