Bitmessage
/
bitmessage-js
2
0
Fork 1
Code Issues 1 Pull Requests 1 Actions Packages Releases Activity

Fix module paths

This commit is contained in:
Kagami Hiiragi 2015-02-14 13:53:24 +03:00
parent 9ca411ec22
commit 508c92009d
5 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -129,11 +129,11 @@ var verackmsg = structs.message.encode("verack");
console.log(structs.message.decode(verackmsg).command); // verack
```
### Network
### Networking
```js
var messages = require("bitmessage").messages;
var TcpTransport = require("bitmessage/net/tcp");
var TcpTransport = require("bitmessage/lib/net/tcp");
var tcp = new TcpTransport({
dnsSeeds: [["bootstrap8444.bitmessage.org", 8444]],

2
lib/address.js
View File

@ -3,7 +3,7 @@
* **NOTE**: `Address` is exported as a module.
* @example
* var Address = require("bitmessage").Address;
* // Or: var Address = require("bitmessage/address");
* // Or: var Address = require("bitmessage/lib/address");
*
* // Generate a new random Bitmessage identity.
* var addr1 = Address.fromRandom();

4
lib/net/base.js
View File

@ -3,8 +3,8 @@
* implementing new transports. End-users should import some transport
* instead in order to connect/accept connections to/from other nodes.
* **NOTE**: `BaseTransport` is exported as a module.
* @example var BaseTransport = require("bitmessage/net/base");
* @module bitmessage/net/base
* @example var BaseTransport = require("bitmessage/lib/net/base");
* @module bitmessage/lib/net/base
*/
// TODO(Kagami): Write some sort of tutorial.

8
lib/net/tcp.js
View File

@ -2,10 +2,10 @@
* TCP transport compatible with PyBitmessage. Available only for Node
* platform.
* **NOTE**: `TcpTransport` is exported as a module.
* @module bitmessage/net/tcp
* @module bitmessage/lib/net/tcp
* @example
* var messages = require("bitmessage").messages;
* var TcpTransport = require("bitmessage/net/tcp");
* var TcpTransport = require("bitmessage/lib/net/tcp");
*
* var tcp = new TcpTransport({
* dnsSeeds: [["bootstrap8444.bitmessage.org", 8444]],
@ -48,8 +48,8 @@ var getmsg = BaseTransport._getmsg;
var unmap = BaseTransport._unmap;
/**
* TCP transport class. Implements
* [base transport interface]{@link module:bitmessage/net/base.BaseTransport}.
* TCP transport class. Implements [base transport interface]{@link
* module:bitmessage/lib/net/base.BaseTransport}.
* @param {Object=} opts - Transport options
* @param {Array} opts.seeds - Bootstrap nodes (none by default)
* @param {Array} opts.dnsSeeds - Bootstrap DNS nodes (none by default)

8
lib/net/ws.js
View File

@ -3,8 +3,8 @@
* so we use separate WebSocket server to proxy messages into TCP data
* packets. Available for both Node.js and Browser platforms.
* **NOTE**: `WsTransport` is exported as a module.
* @example var WsTransport = require("bitmessage/net/ws");
* @module bitmessage/net/ws
* @example var WsTransport = require("bitmessage/lib/net/ws");
* @module bitmessage/lib/net/ws
*/
"use strict";
@ -23,8 +23,8 @@ var getmsg = BaseTransport._getmsg;
var unmap = BaseTransport._unmap;
/**
* WebSocket transport class. Implements
* [base transport interface]{@link module:bitmessage/net/base.BaseTransport}.
* WebSocket transport class. Implements [base transport
* interface]{@link module:bitmessage/lib/net/base.BaseTransport}.
* @param {Object=} opts - Transport options
* @param {Array} opts.seeds - Bootstrap nodes (none by default)
* @param {Object} opts.services -