add .eslintrc, lint fixes + jsdoc documentation (#1)

.eslintrc

@@ -0,0 +1,15 @@
+{
+  "extends": "google",
+  "env": {
+    "node": true,
+    "es6": true
+  },
+  "rules": {
+    "max-len": ["error", {
+      "ignoreComments": true,
+      "ignoreUrls": true,
+      "ignoreStrings": true,
+      "ignoreRegExpLiterals": true
+    }]
+  }
+}

README.md

@@ -17,10 +17,10 @@ npm install @superbalist/js-pubsub-redis
 ## Usage
 
 ```node
-"use strict";
+'use strict';
 
-var redis = require('redis');
-var RedisPubSubAdapter = require('@superbalist/js-pubsub-redis');
+let redis = require('redis');
+let RedisPubSubAdapter = require('@superbalist/js-pubsub-redis');
 
 let client = redis.createClient({
   host: 'redis',

examples/RedisConsumerExample.js

@@ -1,11 +1,11 @@
-"use strict";
+'use strict';
 
-var redis = require('redis');
-var RedisPubSubAdapter = require('../src/RedisPubSubAdapter');
+let redis = require('redis');
+let RedisPubSubAdapter = require('../src/RedisPubSubAdapter');
 
 let client = redis.createClient({
   host: 'redis',
-  port: 6379
+  port: 6379,
 });
 
 let adapter = new RedisPubSubAdapter(client);

examples/RedisPublishExample.js

@@ -1,11 +1,11 @@
-"use strict";
+'use strict';
 
-var redis = require('redis');
-var RedisPubSubAdapter = require('../src/RedisPubSubAdapter');
+let redis = require('redis');
+let RedisPubSubAdapter = require('../src/RedisPubSubAdapter');
 
 let client = redis.createClient({
   host: 'redis',
-  port: 6379
+  port: 6379,
 });
 
 let adapter = new RedisPubSubAdapter(client);

index.js

@@ -1,5 +1,7 @@
-"use strict";
+'use strict';
 
-var RedisPubSubAdapter = require('./src/RedisPubSubAdapter');
+/** @module pubsubRedis */
+
+let RedisPubSubAdapter = require('./src/RedisPubSubAdapter');
 
 module.exports = RedisPubSubAdapter;

package.json

@@ -23,5 +23,9 @@
   "dependencies": {
     "@superbalist/js-pubsub": "0.0.1",
     "redis": "^2.7.1"
+  },
+  "devDependencies": {
+    "eslint": "^3.19.0",
+    "eslint-config-google": "^0.7.1"
   }
 }

src/RedisPubSubAdapter.js

@@ -1,12 +1,50 @@
-"use strict";
+'use strict';
 
-var Utils = require('@superbalist/js-pubsub').Utils;
+let Utils = require('@superbalist/js-pubsub').Utils;
 
+/**
+ * @callback subscriberCallback
+ * @param {*} message - The message payload received
+ */
+
+/**
+ * RedisPubSubAdapter Class
+ *
+ * @implements {module:pubsub.PubSubAdapterInterface}
+ * @example
+ * let redis = require('redis');
+ * let RedisPubSubAdapter = require('@superbalist/js-pubsub-redis');
+ *
+ * // create adapter
+ * let client = redis.createClient({
+ *   host: 'redis',
+ *   port: 6379,
+ * });
+ *
+ * let adapter = new RedisPubSubAdapter(client);
+ */
 class RedisPubSubAdapter {
+  /**
+   *
+   * @param {RedisClient} client
+   */
   constructor(client) {
+    /**
+     * @type {RedisClient}
+     */
     this.client = client;
   }
 
+  /**
+   * Subscribe a handler to a channel.
+   *
+   * @param {string} channel
+   * @param {subscriberCallback} handler - The callback to run when a message is received
+   * @example
+   * adapter.subscribe('my_channel', (message) => {
+   *   console.log(message);
+   * });
+   */
   subscribe(channel, handler) {
     this.client.on('message', (channel, message) => {
       handler(Utils.unserializeMessagePayload(message));
@@ -15,6 +53,21 @@ class RedisPubSubAdapter {
     this.client.subscribe(channel);
   }
 
+  /**
+   * Publish a message to a channel.
+   *
+   * @param {string} channel
+   * @param {*} message - The message payload
+   * @example
+   * // publish a string
+   * adapter.publish('my_channel', 'Hello World');
+   *
+   * // publish an object
+   * adapter.publish('my_channel', {
+   *   'id': 1234,
+   *   'first_name': 'Matthew',
+   * });
+   */
   publish(channel, message) {
     this.client.publish(channel, message);
   }