Skip to content

Commit 58675db

Browse files
MajoredMajored
committed
Update staged documentation
1 parent 59b223f commit 58675db

38 files changed

+738
-114
lines changed

‎docs/staged/APIError.html

Lines changed: 553 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/staged/APIError.js.html

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<title>JSDoc: Source: APIError.js</title>
6+
7+
<script src="scripts/prettify/prettify.js"> </script>
8+
<script src="scripts/prettify/lang-css.js"> </script>
9+
<!--[if lt IE 9]>
10+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11+
<![endif]-->
12+
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13+
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14+
</head>
15+
16+
<body>
17+
18+
<div id="main">
19+
20+
<h1 class="page-title">Source: APIError.js</h1>
21+
22+
23+
24+
25+
26+
27+
<section>
28+
<article>
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)
31+
32+
/** A type which represents a parsed error from the API, or an internal wrapper error. */
33+
class APIError extends Error {
34+
#code;
35+
#message;
36+
37+
constructor(json) {
38+
super(`${json.code} - ${json.message}`);
39+
40+
this.#code = json.code;
41+
this.#message = json.message;
42+
}
43+
44+
/** Returns the machine-readable code of the error.
45+
*
46+
* @returns {string} The machine-readable error code.
47+
*/
48+
code() {
49+
return this.#code;
50+
}
51+
52+
/** Returns the human-readable message of the error.
53+
*
54+
* @returns {string} The human-readable error message.
55+
*/
56+
message() {
57+
return this.#message;
58+
}
59+
60+
/** Constructs a new Error which originated within the wrapper.
61+
*
62+
* @param {string} message The internal error message.
63+
* @returns {APIError} The newly-constructed error.
64+
*/
65+
static internal(message) {
66+
return new APIError({code: "InternalWrapperError", message});
67+
}
68+
}
69+
70+
exports.APIError = APIError;</code></pre>
71+
</article>
72+
</section>
73+
74+
75+
76+
77+
</div>
78+
79+
<nav>
80+
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AlertsHelper.html">AlertsHelper</a></li><li><a href="APIError.html">APIError</a></li><li><a href="ConversationsHelper.html">ConversationsHelper</a></li><li><a href="DownloadsHelper.html">DownloadsHelper</a></li><li><a href="Http.html">Http</a></li><li><a href="LicensesHelper.html">LicensesHelper</a></li><li><a href="MembersHelper.html">MembersHelper</a></li><li><a href="ProfilePostsHelper.html">ProfilePostsHelper</a></li><li><a href="PurchasesHelper.html">PurchasesHelper</a></li><li><a href="ResourcesHelper.html">ResourcesHelper</a></li><li><a href="ReviewsHelper.html">ReviewsHelper</a></li><li><a href="SortOptions.html">SortOptions</a></li><li><a href="ThreadsHelper.html">ThreadsHelper</a></li><li><a href="Token.html">Token</a></li><li><a href="TokenType.html">TokenType</a></li><li><a href="UpdatesHelper.html">UpdatesHelper</a></li><li><a href="VersionsHelper.html">VersionsHelper</a></li><li><a href="Wrapper.html">Wrapper</a></li></ul><h3><a href="global.html">Global</a></h3>
81+
</nav>
82+
83+
<br class="clear">
84+
85+
<footer>
86+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Wed Aug 31 2022 10:53:36 GMT+0100 (British Summer Time)
87+
</footer>
88+
89+
<script> prettyPrint(); </script>
90+
<script src="scripts/linenumber.js"> </script>
91+
</body>
92+
</html>

‎docs/staged/AlertsHelper.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -756,13 +756,13 @@ <h4 class="name" id="markAsRead"><span class="type-signature">(async) </span>mar
756756
</div>
757757

758758
<nav>
759-
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AlertsHelper.html">AlertsHelper</a></li><li><a href="ConversationsHelper.html">ConversationsHelper</a></li><li><a href="DownloadsHelper.html">DownloadsHelper</a></li><li><a href="Error.html">Error</a></li><li><a href="Http.html">Http</a></li><li><a href="LicensesHelper.html">LicensesHelper</a></li><li><a href="MembersHelper.html">MembersHelper</a></li><li><a href="ProfilePostsHelper.html">ProfilePostsHelper</a></li><li><a href="PurchasesHelper.html">PurchasesHelper</a></li><li><a href="ResourcesHelper.html">ResourcesHelper</a></li><li><a href="ReviewsHelper.html">ReviewsHelper</a></li><li><a href="SortOptions.html">SortOptions</a></li><li><a href="ThreadsHelper.html">ThreadsHelper</a></li><li><a href="Token.html">Token</a></li><li><a href="TokenType.html">TokenType</a></li><li><a href="UpdatesHelper.html">UpdatesHelper</a></li><li><a href="VersionsHelper.html">VersionsHelper</a></li><li><a href="Wrapper.html">Wrapper</a></li></ul><h3><a href="global.html">Global</a></h3>
759+
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AlertsHelper.html">AlertsHelper</a></li><li><a href="APIError.html">APIError</a></li><li><a href="ConversationsHelper.html">ConversationsHelper</a></li><li><a href="DownloadsHelper.html">DownloadsHelper</a></li><li><a href="Http.html">Http</a></li><li><a href="LicensesHelper.html">LicensesHelper</a></li><li><a href="MembersHelper.html">MembersHelper</a></li><li><a href="ProfilePostsHelper.html">ProfilePostsHelper</a></li><li><a href="PurchasesHelper.html">PurchasesHelper</a></li><li><a href="ResourcesHelper.html">ResourcesHelper</a></li><li><a href="ReviewsHelper.html">ReviewsHelper</a></li><li><a href="SortOptions.html">SortOptions</a></li><li><a href="ThreadsHelper.html">ThreadsHelper</a></li><li><a href="Token.html">Token</a></li><li><a href="TokenType.html">TokenType</a></li><li><a href="UpdatesHelper.html">UpdatesHelper</a></li><li><a href="VersionsHelper.html">VersionsHelper</a></li><li><a href="Wrapper.html">Wrapper</a></li></ul><h3><a href="global.html">Global</a></h3>
760760
</nav>
761761

762762
<br class="clear">
763763

764764
<footer>
765-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Aug 05 2022 10:37:18 GMT+0100 (British Summer Time)
765+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Wed Aug 31 2022 10:53:36 GMT+0100 (British Summer Time)
766766
</footer>
767767

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

‎docs/staged/ConversationsHelper.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1634,13 +1634,13 @@ <h5>Returns:</h5>
16341634
</div>
16351635

16361636
<nav>
1637-
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AlertsHelper.html">AlertsHelper</a></li><li><a href="ConversationsHelper.html">ConversationsHelper</a></li><li><a href="DownloadsHelper.html">DownloadsHelper</a></li><li><a href="Error.html">Error</a></li><li><a href="Http.html">Http</a></li><li><a href="LicensesHelper.html">LicensesHelper</a></li><li><a href="MembersHelper.html">MembersHelper</a></li><li><a href="ProfilePostsHelper.html">ProfilePostsHelper</a></li><li><a href="PurchasesHelper.html">PurchasesHelper</a></li><li><a href="ResourcesHelper.html">ResourcesHelper</a></li><li><a href="ReviewsHelper.html">ReviewsHelper</a></li><li><a href="SortOptions.html">SortOptions</a></li><li><a href="ThreadsHelper.html">ThreadsHelper</a></li><li><a href="Token.html">Token</a></li><li><a href="TokenType.html">TokenType</a></li><li><a href="UpdatesHelper.html">UpdatesHelper</a></li><li><a href="VersionsHelper.html">VersionsHelper</a></li><li><a href="Wrapper.html">Wrapper</a></li></ul><h3><a href="global.html">Global</a></h3>
1637+
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AlertsHelper.html">AlertsHelper</a></li><li><a href="APIError.html">APIError</a></li><li><a href="ConversationsHelper.html">ConversationsHelper</a></li><li><a href="DownloadsHelper.html">DownloadsHelper</a></li><li><a href="Http.html">Http</a></li><li><a href="LicensesHelper.html">LicensesHelper</a></li><li><a href="MembersHelper.html">MembersHelper</a></li><li><a href="ProfilePostsHelper.html">ProfilePostsHelper</a></li><li><a href="PurchasesHelper.html">PurchasesHelper</a></li><li><a href="ResourcesHelper.html">ResourcesHelper</a></li><li><a href="ReviewsHelper.html">ReviewsHelper</a></li><li><a href="SortOptions.html">SortOptions</a></li><li><a href="ThreadsHelper.html">ThreadsHelper</a></li><li><a href="Token.html">Token</a></li><li><a href="TokenType.html">TokenType</a></li><li><a href="UpdatesHelper.html">UpdatesHelper</a></li><li><a href="VersionsHelper.html">VersionsHelper</a></li><li><a href="Wrapper.html">Wrapper</a></li></ul><h3><a href="global.html">Global</a></h3>
16381638
</nav>
16391639

16401640
<br class="clear">
16411641

16421642
<footer>
1643-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Aug 05 2022 10:37:18 GMT+0100 (British Summer Time)
1643+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Wed Aug 31 2022 10:53:36 GMT+0100 (British Summer Time)
16441644
</footer>
16451645

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

‎docs/staged/DownloadsHelper.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2031,13 +2031,13 @@ <h5>Returns:</h5>
20312031
</div>
20322032

20332033
<nav>
2034-
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AlertsHelper.html">AlertsHelper</a></li><li><a href="ConversationsHelper.html">ConversationsHelper</a></li><li><a href="DownloadsHelper.html">DownloadsHelper</a></li><li><a href="Error.html">Error</a></li><li><a href="Http.html">Http</a></li><li><a href="LicensesHelper.html">LicensesHelper</a></li><li><a href="MembersHelper.html">MembersHelper</a></li><li><a href="ProfilePostsHelper.html">ProfilePostsHelper</a></li><li><a href="PurchasesHelper.html">PurchasesHelper</a></li><li><a href="ResourcesHelper.html">ResourcesHelper</a></li><li><a href="ReviewsHelper.html">ReviewsHelper</a></li><li><a href="SortOptions.html">SortOptions</a></li><li><a href="ThreadsHelper.html">ThreadsHelper</a></li><li><a href="Token.html">Token</a></li><li><a href="TokenType.html">TokenType</a></li><li><a href="UpdatesHelper.html">UpdatesHelper</a></li><li><a href="VersionsHelper.html">VersionsHelper</a></li><li><a href="Wrapper.html">Wrapper</a></li></ul><h3><a href="global.html">Global</a></h3>
2034+
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AlertsHelper.html">AlertsHelper</a></li><li><a href="APIError.html">APIError</a></li><li><a href="ConversationsHelper.html">ConversationsHelper</a></li><li><a href="DownloadsHelper.html">DownloadsHelper</a></li><li><a href="Http.html">Http</a></li><li><a href="LicensesHelper.html">LicensesHelper</a></li><li><a href="MembersHelper.html">MembersHelper</a></li><li><a href="ProfilePostsHelper.html">ProfilePostsHelper</a></li><li><a href="PurchasesHelper.html">PurchasesHelper</a></li><li><a href="ResourcesHelper.html">ResourcesHelper</a></li><li><a href="ReviewsHelper.html">ReviewsHelper</a></li><li><a href="SortOptions.html">SortOptions</a></li><li><a href="ThreadsHelper.html">ThreadsHelper</a></li><li><a href="Token.html">Token</a></li><li><a href="TokenType.html">TokenType</a></li><li><a href="UpdatesHelper.html">UpdatesHelper</a></li><li><a href="VersionsHelper.html">VersionsHelper</a></li><li><a href="Wrapper.html">Wrapper</a></li></ul><h3><a href="global.html">Global</a></h3>
20352035
</nav>
20362036

20372037
<br class="clear">
20382038

20392039
<footer>
2040-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Aug 05 2022 10:37:18 GMT+0100 (British Summer Time)
2040+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Wed Aug 31 2022 10:53:36 GMT+0100 (British Summer Time)
20412041
</footer>
20422042

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

‎docs/staged/Http.html

Lines changed: 6 additions & 6 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#line93">line 93</a>
253+
<a href="Http.js.html">Http.js</a>, <a href="Http.js.html#line86">line 86</a>
254254
</li></ul></dd>
255255

256256

@@ -633,7 +633,7 @@ <h5>Parameters:</h5>
633633

634634
<dt class="tag-source">Source:</dt>
635635
<dd class="tag-source"><ul class="dummy"><li>
636-
<a href="Http.js.html">Http.js</a>, <a href="Http.js.html#line128">line 128</a>
636+
<a href="Http.js.html">Http.js</a>, <a href="Http.js.html#line119">line 119</a>
637637
</li></ul></dd>
638638

639639

@@ -815,7 +815,7 @@ <h5>Parameters:</h5>
815815

816816
<dt class="tag-source">Source:</dt>
817817
<dd class="tag-source"><ul class="dummy"><li>
818-
<a href="Http.js.html">Http.js</a>, <a href="Http.js.html#line74">line 74</a>
818+
<a href="Http.js.html">Http.js</a>, <a href="Http.js.html#line69">line 69</a>
819819
</li></ul></dd>
820820

821821

@@ -975,7 +975,7 @@ <h5>Parameters:</h5>
975975

976976
<dt class="tag-source">Source:</dt>
977977
<dd class="tag-source"><ul class="dummy"><li>
978-
<a href="Http.js.html">Http.js</a>, <a href="Http.js.html#line54">line 54</a>
978+
<a href="Http.js.html">Http.js</a>, <a href="Http.js.html#line51">line 51</a>
979979
</li></ul></dd>
980980

981981

@@ -1043,13 +1043,13 @@ <h5>Returns:</h5>
10431043
</div>
10441044

10451045
<nav>
1046-
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AlertsHelper.html">AlertsHelper</a></li><li><a href="ConversationsHelper.html">ConversationsHelper</a></li><li><a href="DownloadsHelper.html">DownloadsHelper</a></li><li><a href="Error.html">Error</a></li><li><a href="Http.html">Http</a></li><li><a href="LicensesHelper.html">LicensesHelper</a></li><li><a href="MembersHelper.html">MembersHelper</a></li><li><a href="ProfilePostsHelper.html">ProfilePostsHelper</a></li><li><a href="PurchasesHelper.html">PurchasesHelper</a></li><li><a href="ResourcesHelper.html">ResourcesHelper</a></li><li><a href="ReviewsHelper.html">ReviewsHelper</a></li><li><a href="SortOptions.html">SortOptions</a></li><li><a href="ThreadsHelper.html">ThreadsHelper</a></li><li><a href="Token.html">Token</a></li><li><a href="TokenType.html">TokenType</a></li><li><a href="UpdatesHelper.html">UpdatesHelper</a></li><li><a href="VersionsHelper.html">VersionsHelper</a></li><li><a href="Wrapper.html">Wrapper</a></li></ul><h3><a href="global.html">Global</a></h3>
1046+
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AlertsHelper.html">AlertsHelper</a></li><li><a href="APIError.html">APIError</a></li><li><a href="ConversationsHelper.html">ConversationsHelper</a></li><li><a href="DownloadsHelper.html">DownloadsHelper</a></li><li><a href="Http.html">Http</a></li><li><a href="LicensesHelper.html">LicensesHelper</a></li><li><a href="MembersHelper.html">MembersHelper</a></li><li><a href="ProfilePostsHelper.html">ProfilePostsHelper</a></li><li><a href="PurchasesHelper.html">PurchasesHelper</a></li><li><a href="ResourcesHelper.html">ResourcesHelper</a></li><li><a href="ReviewsHelper.html">ReviewsHelper</a></li><li><a href="SortOptions.html">SortOptions</a></li><li><a href="ThreadsHelper.html">ThreadsHelper</a></li><li><a href="Token.html">Token</a></li><li><a href="TokenType.html">TokenType</a></li><li><a href="UpdatesHelper.html">UpdatesHelper</a></li><li><a href="VersionsHelper.html">VersionsHelper</a></li><li><a href="Wrapper.html">Wrapper</a></li></ul><h3><a href="global.html">Global</a></h3>
10471047
</nav>
10481048

10491049
<br class="clear">
10501050

10511051
<footer>
1052-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Aug 05 2022 10:37:18 GMT+0100 (British Summer Time)
1052+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Wed Aug 31 2022 10:53:36 GMT+0100 (British Summer Time)
10531053
</footer>
10541054

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

0 commit comments

Comments
 (0)