Documentation fixing and basic communication test

.gitignore

@@ -3,3 +3,4 @@ Thumbs.db
 node_modules
 playground
 .vscode
+docs

README.md

@@ -14,6 +14,10 @@ This project is currently in development and not considered stable yet.
 npm install zyre.js
 ```
 
+## Documentation
+
+A jsdoc documentation can be found [here](https://interpretor.github.io/zyre.js/)
+
 ## Examples
 
 ```js

lib/zbeacon.js

@@ -74,10 +74,11 @@ function readDataGramBuffer(dgBuffer) {
 class ZBeacon {
 
   /**
-   * @param {Buffer} identity - 16 byte UUID as Buffer
-   * @param {string} address - Address of the zyre node
-   * @param {number} mailbox - Mailbox of the zyre node
-   * @param {ZyrePeers} zyrePeers - Global ZyrePeers object
+   * @param {Object} options - Options Object
+   * @param {Buffer} options.identity - 16 byte UUID as Buffer
+   * @param {string} options.address - Address of the zyre node
+   * @param {number} options.mailbox - Mailbox of the zyre node
+   * @param {ZyrePeers} options.zyrePeers - Global ZyrePeers object
    */
   constructor({ identity, address, mailbox, zyrePeers }) {
     this._dgBuffer = createDataGramBuffer(identity, mailbox);

lib/zhelper.js

@@ -14,12 +14,22 @@ const tcpPortUsed = require('tcp-port-used');
  */
 class ZHelper {
 
+  /**
+   * @typedef {Object} IfaceData
+   * @property {string} address - IP address
+   * @property {string} netmask - Netmask
+   * @property {string} family - IPv4 or IPv6
+   * @property {string} mac - MAC address
+   * @property {boolean} internal - Internal or external
+   * @property {string} broadcast - Broadcast address
+   */
+
   /**
    * Returns IPv4 interface data from the given interface, or searches for a public interface with
    * an assigned IPv4. Also calculates the broadcast address of the interface.
    *
    * @param {string} [iface] - Optional interface to check
-   * @return {Object}
+   * @return {IfaceData}
    */
   static getIfData(iface) {
     const ifaces = os.networkInterfaces();
@@ -70,7 +80,7 @@ class ZHelper {
    *
    * @param {string} address - Address to search on
    * @param {number} port - Port to start searching from
-   * @return {Promise}
+   * @return {Promise.<port>}
    */
   static getFreePort(address, port) {
     return new Promise((resolve) => {

lib/zre_msg.js

@@ -117,7 +117,7 @@ class ZreMsg {
   /**
    * @param {number} cmd - ZreMsg command as number
    * @param {Object} options - Options Object
-   * @param {number} options.sequence - Sequence of the message
+   * @param {number} [options.sequence=1] - Sequence of the message
    * @param {string} [options.group] - Group which the node/peer joins or leaves
    * @param {string} [options.content] - Content of the message
    * @param {string} [options.endpoint] - TCP address of the node/peer

lib/zyre_peer.js

@@ -146,7 +146,7 @@ class ZyrePeer extends EventEmitter {
     this._expiredTimeout = setTimeout(() => {
       this._expiredAt = Date.now();
       debug(`${this._identity}: expired at ${this._expiredAt}`);
-      this.disconnect();
+      if (this._connected) this.disconnect();
       this.emit('expired');
     }, PEER_EXPIRED);
   }

lib/zyre_peers.js

@@ -11,6 +11,8 @@ const ZyrePeer = require('./zyre_peer');
 
 /**
  * ZyrePeers manages all ZyrePeer objects
+ *
+ * @extends EventEmitter
  */
 class ZyrePeers extends EventEmitter {
 

test/zyre_test.js

@@ -14,4 +14,34 @@ describe('Zyre', () => {
     const z1 = zyre.new();
     assert.instanceOf(z1, zyre);
   });
+
+  it('should do basic group communication', (done) => {
+    const z1 = zyre.new({ name: 'z1' });
+    const z2 = zyre.new({ name: 'z2' });
+
+    z1.on('message', (name, message, group) => {
+      assert.equal(name, 'z2');
+      assert.equal(message, 'Hello World!');
+      assert.equal(group, 'CHAT');
+      z1.shout('CHAT', 'Hey!');
+    });
+
+    z2.on('message', (name, message, group) => {
+      assert.equal(name, 'z1');
+      assert.equal(message, 'Hey!');
+      assert.equal(group, 'CHAT');
+      done();
+    });
+
+    z1.start().then(() => {
+      z1.join('CHAT');
+      z2.start().then(() => {
+        z2.join('CHAT');
+      });
+    });
+
+    setTimeout(() => {
+      z2.shout('CHAT', 'Hello World!');
+    }, 1500);
+  });
 });