diff options
Diffstat (limited to 'docs/global.html')
| -rw-r--r-- | docs/global.html | 272 |
1 files changed, 136 insertions, 136 deletions
diff --git a/docs/global.html b/docs/global.html index bcec003..8b70834 100644 --- a/docs/global.html +++ b/docs/global.html @@ -24,7 +24,7 @@ <label for="nav-trigger" class="overlay"></label> <nav> - <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#_createPackage">_createPackage</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#_decrypt">_decrypt</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#_decryptJSON">_decryptJSON</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#_encrypt">_encrypt</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#_merger">_merger</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#_verification">_verification</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#connect">connect</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#http">http</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#send">send</a></span></li> + <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#connect">connect</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#createPackage">createPackage</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#decrypt">decrypt</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#decryptJSON">decryptJSON</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#encrypt">encrypt</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#http">http</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#isVerification">isVerification</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#mergerString">mergerString</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#send">send</a></span></li> </nav> <div id="main"> @@ -160,7 +160,7 @@ <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="index.js.html">index.js</a>, <a href="index.js.html#line7">line 7</a> + <a href="index.js.html">index.js</a>, <a href="index.js.html#line6">line 6</a> </li></ul></dd> @@ -191,14 +191,14 @@ - <h4 class="name" id="_createPackage"><span class="type-signature"></span>_createPackage<span class="signature">(raw)</span><span class="type-signature"> → {String}</span></h4> + <h4 class="name" id="connect"><span class="type-signature"></span>connect<span class="signature">(uuid, callback)</span><span class="type-signature"></span></h4> <div class="description"> - Creates an encrypted package to send. + Connects to the server and returns the connection data. </div> @@ -234,7 +234,7 @@ <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="index.js.html">index.js</a>, <a href="index.js.html#line140">line 140</a> + <a href="index.js.html">index.js</a>, <a href="index.js.html#line14">line 14</a> </li></ul></dd> @@ -278,50 +278,7 @@ <tr> - <td class="name"><code>raw</code></td> - - - <td class="type"> - - -<span class="param-type"><code>Object</code></span> - - - - </td> - - - - - - <td class="description last"> - The data to send. - - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>cuid</code></td> + <td class="name"><code>uuid</code></td> <td class="type"> @@ -338,7 +295,7 @@ <td class="description last"> - Session identifier. + The bot UUID. </td> </tr> @@ -347,13 +304,13 @@ <tr> - <td class="name"><code>text</code></td> + <td class="name"><code>callback</code></td> <td class="type"> -<span class="param-type"><code>String</code></span> +<span class="param-type"><code>requestCallback</code></span> @@ -364,15 +321,7 @@ <td class="description last"> - Message text. - - </td> - </tr> - - - </tbody> -</table> - + The callback that handles the response. </td> </tr> @@ -394,31 +343,6 @@ -<div class="section-returns"> -<h5>Returns:</h5> - - - -<dl class="param-type"> - <dt> - Type: - </dt> - <dd> - -<span class="param-type"><code>String</code></span> - - - </dd> -</dl> - - -<div class="param-desc"> - - Encrypted string. -</div> - - -</div> - </div> @@ -428,14 +352,14 @@ - <h4 class="name" id="_decrypt"><span class="type-signature"></span>_decrypt<span class="signature">(raw)</span><span class="type-signature"> → {String}</span></h4> + <h4 class="name" id="createPackage"><span class="type-signature"></span>createPackage<span class="signature">(raw)</span><span class="type-signature"> → {String}</span></h4> <div class="description"> - Decrypts the incoming data. + Creates an encrypted package to send. </div> @@ -471,7 +395,7 @@ <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="index.js.html">index.js</a>, <a href="index.js.html#line92">line 92</a> + <a href="index.js.html">index.js</a>, <a href="index.js.html#line139">line 139</a> </li></ul></dd> @@ -521,6 +445,49 @@ <td class="type"> +<span class="param-type"><code>Object</code></span> + + + + </td> + + + + + + <td class="description last"> + The data to send. + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>cuid</code></td> + + + <td class="type"> + + <span class="param-type"><code>String</code></span> @@ -532,7 +499,41 @@ <td class="description last"> - Encrypted data. + Session identifier. + + </td> + </tr> + + + + <tr> + + <td class="name"><code>text</code></td> + + + <td class="type"> + + +<span class="param-type"><code>String</code></span> + + + + </td> + + + + + + <td class="description last"> + Message text. + + </td> + </tr> + + + </tbody> +</table> + </td> </tr> @@ -573,7 +574,7 @@ <div class="param-desc"> - - Decrypted string. + - Encrypted string. </div> @@ -588,14 +589,14 @@ - <h4 class="name" id="_decryptJSON"><span class="type-signature"></span>_decryptJSON<span class="signature">(raw)</span><span class="type-signature"> → {Object}</span></h4> + <h4 class="name" id="decrypt"><span class="type-signature"></span>decrypt<span class="signature">(raw)</span><span class="type-signature"> → {String}</span></h4> <div class="description"> - Decrypts an encrypted JSON object. + Decrypts the incoming data. </div> @@ -631,7 +632,7 @@ <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="index.js.html">index.js</a>, <a href="index.js.html#line106">line 106</a> + <a href="index.js.html">index.js</a>, <a href="index.js.html#line91">line 91</a> </li></ul></dd> @@ -725,7 +726,7 @@ </dt> <dd> -<span class="param-type"><code>Object</code></span> +<span class="param-type"><code>String</code></span> </dd> @@ -733,7 +734,7 @@ <div class="param-desc"> - - Decrypted JSON. + - Decrypted string. </div> @@ -748,14 +749,14 @@ - <h4 class="name" id="_encrypt"><span class="type-signature"></span>_encrypt<span class="signature">(raw)</span><span class="type-signature"> → {String}</span></h4> + <h4 class="name" id="decryptJSON"><span class="type-signature"></span>decryptJSON<span class="signature">(raw)</span><span class="type-signature"> → {Object}</span></h4> <div class="description"> - Encrypts the incoming data. + Decrypts an encrypted JSON object. </div> @@ -791,7 +792,7 @@ <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="index.js.html">index.js</a>, <a href="index.js.html#line78">line 78</a> + <a href="index.js.html">index.js</a>, <a href="index.js.html#line105">line 105</a> </li></ul></dd> @@ -852,7 +853,7 @@ <td class="description last"> - Decrypted data. + Encrypted data. </td> </tr> @@ -885,7 +886,7 @@ </dt> <dd> -<span class="param-type"><code>String</code></span> +<span class="param-type"><code>Object</code></span> </dd> @@ -893,7 +894,7 @@ <div class="param-desc"> - - Encrypted string. + - Decrypted JSON. </div> @@ -908,14 +909,14 @@ - <h4 class="name" id="_merger"><span class="type-signature"></span>_merger<span class="signature">(raw)</span><span class="type-signature"> → {String}</span></h4> + <h4 class="name" id="encrypt"><span class="type-signature"></span>encrypt<span class="signature">(raw)</span><span class="type-signature"> → {String}</span></h4> <div class="description"> - Merge and convert a string. + Encrypts the incoming data. </div> @@ -951,7 +952,7 @@ <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="index.js.html">index.js</a>, <a href="index.js.html#line120">line 120</a> + <a href="index.js.html">index.js</a>, <a href="index.js.html#line77">line 77</a> </li></ul></dd> @@ -1012,7 +1013,7 @@ <td class="description last"> - The string to convert. + Decrypted data. </td> </tr> @@ -1053,7 +1054,7 @@ <div class="param-desc"> - - The converted string. + - Encrypted string. </div> @@ -1068,7 +1069,7 @@ - <h4 class="name" id="_verification"><span class="type-signature"></span>_verification<span class="signature">(data)</span><span class="type-signature"> → {Boolean}</span></h4> + <h4 class="name" id="isVerification"><span class="type-signature"></span>isVerification<span class="signature">(data)</span><span class="type-signature"> → {Boolean}</span></h4> @@ -1111,7 +1112,7 @@ <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="index.js.html">index.js</a>, <a href="index.js.html#line165">line 165</a> + <a href="index.js.html">index.js</a>, <a href="index.js.html#line164">line 164</a> </li></ul></dd> @@ -1224,14 +1225,14 @@ - <h4 class="name" id="connect"><span class="type-signature"></span>connect<span class="signature">(uuid, callback)</span><span class="type-signature"></span></h4> + <h4 class="name" id="mergerString"><span class="type-signature"></span>mergerString<span class="signature">(raw)</span><span class="type-signature"> → {String}</span></h4> <div class="description"> - Connects to the server and returns the connection data. + Merge and convert a string. </div> @@ -1267,7 +1268,7 @@ <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="index.js.html">index.js</a>, <a href="index.js.html#line15">line 15</a> + <a href="index.js.html">index.js</a>, <a href="index.js.html#line119">line 119</a> </li></ul></dd> @@ -1311,7 +1312,7 @@ <tr> - <td class="name"><code>uuid</code></td> + <td class="name"><code>raw</code></td> <td class="type"> @@ -1328,53 +1329,52 @@ <td class="description last"> - The bot UUID. + The string to convert. </td> </tr> + </tbody> +</table> - <tr> - - <td class="name"><code>callback</code></td> - - <td class="type"> - - -<span class="param-type"><code>requestCallback</code></span> - - </td> - - - <td class="description last"> - The callback that handles the response. - - </td> - </tr> - - </tbody> -</table> +<div class="section-returns"> +<h5>Returns:</h5> + +<dl class="param-type"> + <dt> + Type: + </dt> + <dd> + +<span class="param-type"><code>String</code></span> + </dd> +</dl> +<div class="param-desc"> + - The converted string. +</div> + +</div> @@ -1428,7 +1428,7 @@ <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="index.js.html">index.js</a>, <a href="index.js.html#line48">line 48</a> + <a href="index.js.html">index.js</a>, <a href="index.js.html#line47">line 47</a> </li></ul></dd> @@ -1635,7 +1635,7 @@ <br class="clear"> <footer> - Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon May 29 2017 07:00:49 GMT+0300 (MSK) using the Minami theme. + Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue May 30 2017 16:03:16 GMT+0300 (MSK) using the Minami theme. </footer> <script>prettyPrint();</script> |