Publish docs

This commit is contained in:
Kagami Hiiragi 2015-02-12 13:51:08 +03:00
parent 034f611a98
commit 83cf1a240d
48 changed files with 110 additions and 80 deletions

View File

@ -462,7 +462,7 @@ module.exports = Address;
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -218,7 +218,7 @@ exports.decrypt = function(privateKey, buf) {
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -186,7 +186,7 @@ tcp.on(&quot;established&quot;, function() {
} }
}); });
});</code></pre><h2>License</h2><p>bitmessage - JavaScript Bitmessage library</p> });</code></pre><h2>License</h2><p>bitmessage - JavaScript Bitmessage library</p>
<p>Written in 2014-2015 by Kagami Hiiragi <a href="&#109;&#97;&#105;&#x6c;&#116;&#x6f;&#58;&#107;&#x61;&#x67;&#97;&#x6d;&#105;&#x40;&#103;&#x65;&#110;&#x73;&#x68;&#105;&#107;&#101;&#x6e;&#46;&#x6f;&#x72;&#x67;">&#107;&#x61;&#x67;&#97;&#x6d;&#105;&#x40;&#103;&#x65;&#110;&#x73;&#x68;&#105;&#107;&#101;&#x6e;&#46;&#x6f;&#x72;&#x67;</a></p> <p>Written in 2014-2015 by Kagami Hiiragi <a href="&#109;&#97;&#x69;&#x6c;&#116;&#x6f;&#58;&#107;&#x61;&#103;&#97;&#109;&#105;&#x40;&#x67;&#x65;&#x6e;&#115;&#x68;&#x69;&#x6b;&#101;&#x6e;&#x2e;&#111;&#x72;&#103;">&#107;&#x61;&#103;&#97;&#109;&#105;&#x40;&#x67;&#x65;&#x6e;&#115;&#x68;&#x69;&#x6b;&#101;&#x6e;&#x2e;&#111;&#x72;&#103;</a></p>
<p>To the extent possible under law, the author(s) have dedicated all copyright and related and neighboring rights to this software to the public domain worldwide. This software is distributed without any warranty.</p> <p>To the extent possible under law, the author(s) have dedicated all copyright and related and neighboring rights to this software to the public domain worldwide. This software is distributed without any warranty.</p>
<p>You should have received a copy of the CC0 Public Domain Dedication along with this software. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.</p></article> <p>You should have received a copy of the CC0 Public Domain Dedication along with this software. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.</p></article>
</section> </section>
@ -205,7 +205,7 @@ tcp.on(&quot;established&quot;, function() {
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -71,7 +71,7 @@ exports.UserAgent = require("./user-agent");
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -111,6 +111,10 @@ var randomNonce = bmcrypto.randomBytes(8);
var version = exports.version = { var version = exports.version = {
/** /**
* @typedef {Object} DecodeResult * @typedef {Object} DecodeResult
* @property {number} version - Identifies protocol version being used
* by the node. Should equal 3. Nodes should disconnect if the remote
* node's version is lower but continue with the connection if it is
* higher.
* @property {Object} services - * @property {Object} services -
* [Service]{@link module:bitmessage/structs.ServicesBitfield} * [Service]{@link module:bitmessage/structs.ServicesBitfield}
* features to be enabled for this connection * features to be enabled for this connection
@ -594,7 +598,7 @@ var error = exports.error = {
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -660,7 +660,7 @@
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -2206,7 +2206,7 @@ encrypt/decrypt
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -178,7 +178,7 @@ console.log("Deterministic Bitmessage address:", addr2.encode());</code></pre>
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -2034,7 +2034,7 @@ and rejects on bad key or signature.</p>
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -76,7 +76,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line230">line 230</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line234">line 234</a>
</li></ul></dd> </li></ul></dd>
@ -219,7 +219,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line245">line 245</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line249">line 249</a>
</li></ul></dd> </li></ul></dd>
@ -324,7 +324,7 @@ The same as <a href="module-bitmessage_messages.addr.html#.decode">decode</a>.</
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line255">line 255</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line259">line 259</a>
</li></ul></dd> </li></ul></dd>
@ -456,7 +456,7 @@ The same as <a href="module-bitmessage_messages.addr.html#.decode">decode</a>.</
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line279">line 279</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line283">line 283</a>
</li></ul></dd> </li></ul></dd>
@ -561,7 +561,7 @@ The same as <a href="module-bitmessage_messages.addr.html#.encode">encode</a>.</
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line288">line 288</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line292">line 292</a>
</li></ul></dd> </li></ul></dd>
@ -721,7 +721,7 @@ The same as <a href="module-bitmessage_messages.addr.html#.encode">encode</a>.</
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line231">line 231</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line235">line 235</a>
</li></ul></dd> </li></ul></dd>
@ -757,7 +757,7 @@ The same as <a href="module-bitmessage_messages.addr.html#.encode">encode</a>.</
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -76,7 +76,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line431">line 431</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line435">line 435</a>
</li></ul></dd> </li></ul></dd>
@ -168,7 +168,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line442">line 442</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line446">line 446</a>
</li></ul></dd> </li></ul></dd>
@ -241,7 +241,7 @@ maybe ban you for some time.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line449">line 449</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line453">line 453</a>
</li></ul></dd> </li></ul></dd>
@ -313,7 +313,7 @@ maybe ban you for some time.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line436">line 436</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line440">line 440</a>
</li></ul></dd> </li></ul></dd>
@ -440,7 +440,7 @@ maybe ban you for some time.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line470">line 470</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line474">line 474</a>
</li></ul></dd> </li></ul></dd>
@ -545,7 +545,7 @@ The same as <a href="module-bitmessage_messages.error.html#.decode">decode</a>.<
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line480">line 480</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line484">line 484</a>
</li></ul></dd> </li></ul></dd>
@ -840,7 +840,7 @@ related to the error (empty by default)</p></td>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line530">line 530</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line534">line 534</a>
</li></ul></dd> </li></ul></dd>
@ -945,7 +945,7 @@ The same as <a href="module-bitmessage_messages.error.html#.encode">encode</a>.<
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line539">line 539</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line543">line 543</a>
</li></ul></dd> </li></ul></dd>
@ -1209,7 +1209,7 @@ related to the error</p></td>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line451">line 451</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line455">line 455</a>
</li></ul></dd> </li></ul></dd>
@ -1245,7 +1245,7 @@ related to the error</p></td>
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -78,7 +78,7 @@ content of a specific object after filtering known elements.</p></div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line376">line 376</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line380">line 380</a>
</li></ul></dd> </li></ul></dd>
@ -221,7 +221,7 @@ content of a specific object after filtering known elements.</p></div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line392">line 392</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line396">line 396</a>
</li></ul></dd> </li></ul></dd>
@ -326,7 +326,7 @@ The same as <a href="module-bitmessage_messages.getdata.html#.decode">decode</a>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line398">line 398</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line402">line 402</a>
</li></ul></dd> </li></ul></dd>
@ -457,7 +457,7 @@ The same as <a href="module-bitmessage_messages.getdata.html#.decode">decode</a>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line412">line 412</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line416">line 416</a>
</li></ul></dd> </li></ul></dd>
@ -562,7 +562,7 @@ The same as <a href="module-bitmessage_messages.getdata.html#.encode">encode</a>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line417">line 417</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line421">line 421</a>
</li></ul></dd> </li></ul></dd>
@ -722,7 +722,7 @@ The same as <a href="module-bitmessage_messages.getdata.html#.encode">encode</a>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line377">line 377</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line381">line 381</a>
</li></ul></dd> </li></ul></dd>
@ -758,7 +758,7 @@ The same as <a href="module-bitmessage_messages.getdata.html#.encode">encode</a>
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -370,7 +370,7 @@ routine.</p>
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -77,7 +77,7 @@ more objects.</p></div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line303">line 303</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line307">line 307</a>
</li></ul></dd> </li></ul></dd>
@ -220,7 +220,7 @@ more objects.</p></div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line318">line 318</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line322">line 322</a>
</li></ul></dd> </li></ul></dd>
@ -325,7 +325,7 @@ The same as <a href="module-bitmessage_messages.inv.html#.decode">decode</a>.</p
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line328">line 328</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line332">line 332</a>
</li></ul></dd> </li></ul></dd>
@ -456,7 +456,7 @@ The same as <a href="module-bitmessage_messages.inv.html#.decode">decode</a>.</p
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line352">line 352</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line356">line 356</a>
</li></ul></dd> </li></ul></dd>
@ -561,7 +561,7 @@ The same as <a href="module-bitmessage_messages.inv.html#.encode">encode</a>.</p
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line361">line 361</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line365">line 365</a>
</li></ul></dd> </li></ul></dd>
@ -721,7 +721,7 @@ The same as <a href="module-bitmessage_messages.inv.html#.encode">encode</a>.</p
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line304">line 304</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line308">line 308</a>
</li></ul></dd> </li></ul></dd>
@ -757,7 +757,7 @@ The same as <a href="module-bitmessage_messages.inv.html#.encode">encode</a>.</p
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -219,7 +219,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line112">line 112</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line116">line 116</a>
</li></ul></dd> </li></ul></dd>
@ -324,7 +324,7 @@ The same as <a href="module-bitmessage_messages.version.html#.decode">decode</a>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line122">line 122</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line126">line 126</a>
</li></ul></dd> </li></ul></dd>
@ -757,7 +757,7 @@ node (1 by default)</p></td>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line177">line 177</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line181">line 181</a>
</li></ul></dd> </li></ul></dd>
@ -862,7 +862,7 @@ The same as <a href="module-bitmessage_messages.version.html#.encode">encode</a>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line186">line 186</a> <a href="messages.js.html">messages.js</a>, <a href="messages.js.html#line190">line 190</a>
</li></ul></dd> </li></ul></dd>
@ -941,6 +941,32 @@ The same as <a href="module-bitmessage_messages.version.html#.encode">encode</a>
<tbody> <tbody>
<tr>
<td class="name"><code>version</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Identifies protocol version being used
by the node. Should equal 3. Nodes should disconnect if the remote
node's version is lower but continue with the connection if it is
higher.</p></td>
</tr>
<tr> <tr>
<td class="name"><code>services</code></td> <td class="name"><code>services</code></td>
@ -1229,7 +1255,7 @@ to self</p></td>
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -872,7 +872,7 @@ argument is a string)</p></td>
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -164,7 +164,7 @@ instead in order to connect/accept connections to/from other nodes.<br><strong>N
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -564,7 +564,7 @@ for
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -188,7 +188,7 @@ tcp.on("established", function() {
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -542,7 +542,7 @@ Available only for Node platform.</p>
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -164,7 +164,7 @@ packets. Available for both Node.js and Browser platforms.<br><strong>NOTE</stro
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -1586,7 +1586,7 @@ unparsed buffer data for other encodings</p></td>
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -1090,7 +1090,7 @@ for address version &gt;= 4</p></td>
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -419,7 +419,7 @@ then call decode function of the appropriate object handler.</p>
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -1896,7 +1896,7 @@ unparsed buffer data for other encodings</p></td>
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -1296,7 +1296,7 @@ only for <code>pubkey</code> version &gt;= 3)</p></td>
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -1095,7 +1095,7 @@ raised to 1000.</p></td>
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -804,7 +804,7 @@ bound for them.</p>
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -724,7 +724,7 @@ console.log(services.get(15)); // false</code></pre>
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -756,7 +756,7 @@ size)</p></td>
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -216,7 +216,7 @@ console.log(decoded4.list); // [1, 2, 3]</code></pre>
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -289,7 +289,7 @@
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -1149,7 +1149,7 @@ processing message</p></td>
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -933,7 +933,7 @@ provided by the node</p></td>
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -1834,7 +1834,7 @@ useful if you are going to calculate it later).</p>
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -615,7 +615,7 @@
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -613,7 +613,7 @@
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -612,7 +612,7 @@
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -907,7 +907,7 @@ format because it's not that important.</p>
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -469,7 +469,7 @@ key).</p>
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -155,7 +155,7 @@ module.exports = BaseTransport;
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -368,7 +368,7 @@ module.exports = TcpTransport;
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -298,7 +298,7 @@ module.exports = WsTransport;
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -1176,7 +1176,7 @@ var broadcast = exports.broadcast = {
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -156,7 +156,7 @@ exports.doAsync = function(opts) {
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -1097,7 +1097,7 @@ exports.PubkeyBitfield = objectAssign(Bitfield(32), {
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -154,7 +154,7 @@ exports.encodeSelfWith = function(software) {
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

View File

@ -87,7 +87,7 @@ exports.encode = function(privateKey) {
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:43:38 GMT+0300 (MSK) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Feb 12 2015 13:50:46 GMT+0300 (MSK)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>