Skip to content

Commit 7c05412

Browse files
MajoredMajored
committed
Update documentation
1 parent 765ca94 commit 7c05412

File tree

76 files changed

+557
-227
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

+557
-227
lines changed

‎docs/live/AlertsHelper.html

+10-1
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,9 @@ <h5>Parameters:</h5>
200200

201201

202202
<span class="param-type"><a href="SortOptions.html">SortOptions</a></span>
203+
|
204+
205+
<span class="param-type">undefined</span>
203206

204207

205208

@@ -359,6 +362,9 @@ <h5>Parameters:</h5>
359362

360363

361364
<span class="param-type"><a href="SortOptions.html">SortOptions</a></span>
365+
|
366+
367+
<span class="param-type">undefined</span>
362368

363369

364370

@@ -541,6 +547,9 @@ <h5>Parameters:</h5>
541547

542548

543549
<span class="param-type"><a href="SortOptions.html">SortOptions</a></span>
550+
|
551+
552+
<span class="param-type">undefined</span>
544553

545554

546555

@@ -753,7 +762,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AlertsHel
753762
<br class="clear">
754763

755764
<footer>
756-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Thu May 26 2022 17:03:34 GMT+0100 (British Summer Time)
765+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Aug 05 2022 10:37:23 GMT+0100 (British Summer Time)
757766
</footer>
758767

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

‎docs/live/ConversationsHelper.html

+19-1
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,9 @@ <h5>Parameters:</h5>
200200

201201

202202
<span class="param-type"><a href="SortOptions.html">SortOptions</a></span>
203+
|
204+
205+
<span class="param-type">undefined</span>
203206

204207

205208

@@ -359,6 +362,9 @@ <h5>Parameters:</h5>
359362

360363

361364
<span class="param-type"><a href="SortOptions.html">SortOptions</a></span>
365+
|
366+
367+
<span class="param-type">undefined</span>
362368

363369

364370

@@ -541,6 +547,9 @@ <h5>Parameters:</h5>
541547

542548

543549
<span class="param-type"><a href="SortOptions.html">SortOptions</a></span>
550+
|
551+
552+
<span class="param-type">undefined</span>
544553

545554

546555

@@ -723,6 +732,9 @@ <h5>Parameters:</h5>
723732

724733

725734
<span class="param-type"><a href="SortOptions.html">SortOptions</a></span>
735+
|
736+
737+
<span class="param-type">undefined</span>
726738

727739

728740

@@ -928,6 +940,9 @@ <h5>Parameters:</h5>
928940

929941

930942
<span class="param-type"><a href="SortOptions.html">SortOptions</a></span>
943+
|
944+
945+
<span class="param-type">undefined</span>
931946

932947

933948

@@ -1111,6 +1126,9 @@ <h5>Parameters:</h5>
11111126

11121127

11131128
<span class="param-type"><a href="SortOptions.html">SortOptions</a></span>
1129+
|
1130+
1131+
<span class="param-type">undefined</span>
11141132

11151133

11161134

@@ -1622,7 +1640,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AlertsHel
16221640
<br class="clear">
16231641

16241642
<footer>
1625-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Thu May 26 2022 17:03:34 GMT+0100 (British Summer Time)
1643+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Aug 05 2022 10:37:23 GMT+0100 (British Summer Time)
16261644
</footer>
16271645

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

‎docs/live/DownloadsHelper.html

+28-1
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,9 @@ <h5>Parameters:</h5>
223223

224224

225225
<span class="param-type"><a href="SortOptions.html">SortOptions</a></span>
226+
|
227+
228+
<span class="param-type">undefined</span>
226229

227230

228231

@@ -405,6 +408,9 @@ <h5>Parameters:</h5>
405408

406409

407410
<span class="param-type"><a href="SortOptions.html">SortOptions</a></span>
411+
|
412+
413+
<span class="param-type">undefined</span>
408414

409415

410416

@@ -610,6 +616,9 @@ <h5>Parameters:</h5>
610616

611617

612618
<span class="param-type"><a href="SortOptions.html">SortOptions</a></span>
619+
|
620+
621+
<span class="param-type">undefined</span>
613622

614623

615624

@@ -815,6 +824,9 @@ <h5>Parameters:</h5>
815824

816825

817826
<span class="param-type"><a href="SortOptions.html">SortOptions</a></span>
827+
|
828+
829+
<span class="param-type">undefined</span>
818830

819831

820832

@@ -1043,6 +1055,9 @@ <h5>Parameters:</h5>
10431055

10441056

10451057
<span class="param-type"><a href="SortOptions.html">SortOptions</a></span>
1058+
|
1059+
1060+
<span class="param-type">undefined</span>
10461061

10471062

10481063

@@ -1248,6 +1263,9 @@ <h5>Parameters:</h5>
12481263

12491264

12501265
<span class="param-type"><a href="SortOptions.html">SortOptions</a></span>
1266+
|
1267+
1268+
<span class="param-type">undefined</span>
12511269

12521270

12531271

@@ -1453,6 +1471,9 @@ <h5>Parameters:</h5>
14531471

14541472

14551473
<span class="param-type"><a href="SortOptions.html">SortOptions</a></span>
1474+
|
1475+
1476+
<span class="param-type">undefined</span>
14561477

14571478

14581479

@@ -1681,6 +1702,9 @@ <h5>Parameters:</h5>
16811702

16821703

16831704
<span class="param-type"><a href="SortOptions.html">SortOptions</a></span>
1705+
|
1706+
1707+
<span class="param-type">undefined</span>
16841708

16851709

16861710

@@ -1886,6 +1910,9 @@ <h5>Parameters:</h5>
18861910

18871911

18881912
<span class="param-type"><a href="SortOptions.html">SortOptions</a></span>
1913+
|
1914+
1915+
<span class="param-type">undefined</span>
18891916

18901917

18911918

@@ -2010,7 +2037,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AlertsHel
20102037
<br class="clear">
20112038

20122039
<footer>
2013-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Thu May 26 2022 17:03:34 GMT+0100 (British Summer Time)
2040+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Aug 05 2022 10:37:23 GMT+0100 (British Summer Time)
20142041
</footer>
20152042

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

‎docs/live/Error.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -654,7 +654,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AlertsHel
654654
<br class="clear">
655655

656656
<footer>
657-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Thu May 26 2022 17:03:34 GMT+0100 (British Summer Time)
657+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Aug 05 2022 10:37:23 GMT+0100 (British Summer Time)
658658
</footer>
659659

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

‎docs/live/Error.js.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ <h1 class="page-title">Source: Error.js</h1>
2626

2727
<section>
2828
<article>
29-
<pre class="prettyprint source linenums"><code>// Copyright (c) 2021 MC-Market (Mick Capital Pty. Ltd.)
30-
// MIT License (https://github.com/MC-Market-org/js-api-wrapper/blob/main/LICENSE)
29+
<pre class="prettyprint source linenums"><code>// Copyright (c) 2021-2022 BuiltByBit (Mick Capital Pty. Ltd.)
30+
// MIT License (https://github.com/BuiltByBit/js-api-wrapper/blob/main/LICENSE)
3131

3232
/** A type which represents a parsed error from the API, or an internal wrapper error. */
3333
class Error {
@@ -89,7 +89,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AlertsHel
8989
<br class="clear">
9090

9191
<footer>
92-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Thu May 26 2022 17:03:34 GMT+0100 (British Summer Time)
92+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Aug 05 2022 10:37:23 GMT+0100 (British Summer Time)
9393
</footer>
9494

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

‎docs/live/Http.html

+7-1
Original file line numberDiff line numberDiff line change
@@ -360,6 +360,9 @@ <h5>Parameters:</h5>
360360

361361

362362
<span class="param-type"><a href="SortOptions.html">SortOptions</a></span>
363+
|
364+
365+
<span class="param-type">undefined</span>
363366

364367

365368

@@ -577,6 +580,9 @@ <h5>Parameters:</h5>
577580

578581

579582
<span class="param-type"><a href="SortOptions.html">SortOptions</a></span>
583+
|
584+
585+
<span class="param-type">undefined</span>
580586

581587

582588

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

10451051
<footer>
1046-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Thu May 26 2022 17:03:34 GMT+0100 (British Summer Time)
1052+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Aug 05 2022 10:37:23 GMT+0100 (British Summer Time)
10471053
</footer>
10481054

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

‎docs/live/Http.js.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ <h1 class="page-title">Source: Http.js</h1>
2626

2727
<section>
2828
<article>
29-
<pre class="prettyprint source linenums"><code>// Copyright (c) 2021 MC-Market (Mick Capital Pty. Ltd.)
30-
// MIT License (https://github.com/MC-Market-org/js-api-wrapper/blob/main/LICENSE)
29+
<pre class="prettyprint source linenums"><code>// Copyright (c) 2021-2022 BuiltByBit (Mick Capital Pty. Ltd.)
30+
// MIT License (https://github.com/BuiltByBit/js-api-wrapper/blob/main/LICENSE)
3131

3232
const { SortOptions } = require("./SortOptions.js");
3333
const { Error } = require("./Error.js");
@@ -51,7 +51,7 @@ <h1 class="page-title">Source: Http.js</h1>
5151
/** Schedules a GET request for a specific endpoint.
5252
*
5353
* @param {string} endpoint The path of the endpoint (incl. any path parameters).
54-
* @param {SortOptions} sort The optional set of sort options.
54+
* @param {SortOptions | undefined} sort The optional set of sort options.
5555
*
5656
* @return {*} The response data on success.
5757
*/
@@ -149,7 +149,7 @@ <h1 class="page-title">Source: Http.js</h1>
149149
*
150150
* @param {string} endpoint The path of the endpoint (incl. any path parameters).
151151
* @param {function(object):boolean} shouldContinue A function which determines if further pages are requested.
152-
* @param {SortOptions} sort An optional set of sort options.
152+
* @param {SortOptions | undefined} sort An optional set of sort options.
153153
*
154154
* @return {Array&lt;object>} An array of raw objects.
155155
*/
@@ -224,7 +224,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AlertsHel
224224
<br class="clear">
225225

226226
<footer>
227-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Thu May 26 2022 17:03:34 GMT+0100 (British Summer Time)
227+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Aug 05 2022 10:37:23 GMT+0100 (British Summer Time)
228228
</footer>
229229

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

‎docs/live/LicensesHelper.html

+16-1
Original file line numberDiff line numberDiff line change
@@ -428,6 +428,9 @@ <h5>Parameters:</h5>
428428

429429

430430
<span class="param-type">number</span>
431+
|
432+
433+
<span class="param-type">undefined</span>
431434

432435

433436

@@ -451,6 +454,9 @@ <h5>Parameters:</h5>
451454

452455

453456
<span class="param-type">number</span>
457+
|
458+
459+
<span class="param-type">undefined</span>
454460

455461

456462

@@ -633,6 +639,9 @@ <h5>Parameters:</h5>
633639

634640

635641
<span class="param-type"><a href="SortOptions.html">SortOptions</a></span>
642+
|
643+
644+
<span class="param-type">undefined</span>
636645

637646

638647

@@ -815,6 +824,9 @@ <h5>Parameters:</h5>
815824

816825

817826
<span class="param-type"><a href="SortOptions.html">SortOptions</a></span>
827+
|
828+
829+
<span class="param-type">undefined</span>
818830

819831

820832

@@ -1020,6 +1032,9 @@ <h5>Parameters:</h5>
10201032

10211033

10221034
<span class="param-type"><a href="SortOptions.html">SortOptions</a></span>
1035+
|
1036+
1037+
<span class="param-type">undefined</span>
10231038

10241039

10251040

@@ -1533,7 +1548,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AlertsHel
15331548
<br class="clear">
15341549

15351550
<footer>
1536-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Thu May 26 2022 17:03:34 GMT+0100 (British Summer Time)
1551+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Aug 05 2022 10:37:23 GMT+0100 (British Summer Time)
15371552
</footer>
15381553

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

‎docs/live/MembersHelper.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -468,7 +468,7 @@ <h5>Parameters:</h5>
468468
<td class="type">
469469

470470

471-
<span class="param-type">number</span>
471+
<span class="param-type">string</span>
472472

473473

474474

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

11571157
<footer>
1158-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Thu May 26 2022 17:03:34 GMT+0100 (British Summer Time)
1158+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Aug 05 2022 10:37:23 GMT+0100 (British Summer Time)
11591159
</footer>
11601160

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

0 commit comments

Comments
 (0)