Refactor(main): Cleaner methods code with JSDoc

Author: fvdm

requestbin.js

@@ -84,36 +84,97 @@ function talk (method, path, props, callback) {
 }
 
 
-module.exports = {
-  config: function (props) {
-    var name;
-
-    for (name in props) {
-      config [name] = props [name];
-    }
-  },
+/**
+ * Set configuration
+ *
+ * @param props {object} - Config parameters
+ * @return {void}
+ */
 
-  create: function (isPrivate, callback) {
-    var props = {};
+function methodConfig (props) (
+  var name;
 
-    if (typeof isPrivate === 'function') {
-      callback = isPrivate;
-    } else if (isPrivate === true) {
-      props.private = 'true';
-    }
+  for (name in props) {
+    config [name] = props [name];
+  }
+}
 
-    talk ('POST', 'bins', props, callback);
-  },
 
-  get: function (bin, callback) {
-    talk ('GET', 'bins/' + bin, callback);
-  },
+/**
+ * Create request instance
+ *
+ * @callback callback
+ * @param [isPrivate = false] {boolean} - Make instance private
+ * @param callback {function} - `function (err, data) {}`
+ * @return {void}
+ */
 
-  requests: function (bin, callback) {
-    talk ('GET', 'bins/' + bin + '/requests', callback);
-  },
+function methodCreate (isPrivate, callback) (
+  var props = {};
 
-  request: function (bin, request, callback) {
-    talk ('GET', 'bins/' + bin + '/requests/' + request, callback);
+  if (typeof isPrivate === 'function') {
+    callback = isPrivate;
+  } else if (isPrivate === true) {
+    props.private = 'true';
   }
+
+  talk ('POST', 'bins', props, callback);
+}
+
+
+/**
+ * Get a request instance
+ *
+ * @callback callback
+ * @param bin {string} - Bin instance ID
+ * @param callback {function} - `function (err, data) {}`
+ * @return {void}
+ */
+
+function methodGet (bin, callback) {
+  talk ('GET', 'bins/' + bin, callback);
+}
+
+
+/**
+ * Get received requests
+ *
+ * @callback callback
+ * @param bin {string} - Bin instance ID
+ * @param callback {function} - `function (err, data) {}`
+ * @return {void}
+ */
+
+function methodRequests (bin, callback) {
+  talk ('GET', 'bins/' + bin + '/requests', callback);
+}
+
+
+/**
+ * Get one received request
+ *
+ * @callback callback
+ * @param bin {string} - Bin instance ID
+ * @param request {string} - Request ID
+ * @param callback {function} - `function (err, data) {}`
+ * @return {void}
+ */
+
+function methodRequest (bin, request, callback) {
+  talk ('GET', 'bins/' + bin + '/requests/' + request, callback);
+}
+
+
+/**
+ * Interface methods
+ *
+ * @return {object} - Methods
+ */
+
+module.exports = {
+  config: methodConfig,
+  create: methodCreate,
+  get: methodGet,
+  requests: methodRequests,
+  request: methodRequest
 };