fix: add type definitions for params and callbacks

Author: DavidVujic

lib/typedefs.js

@@ -23,8 +23,89 @@
  */
 
 /**
- * Children with stat
- * @typedef {Object} childrenWithStat
- * @property {Array.<string>} children
- * @property {stat} stat
+ * Mkdir callback
+ * @typedef {callback} mkdirCb
+ * @param {Error} error
+ * @param {boolean} [success]
+ */
+
+/**
+ * Connect callback
+ * @typedef {callback} connectCb
+ * @param {Error} error
+ * @param {ZooKeeper} client
+ */
+
+/**
+ * Path callback
+ * @typedef {callback} pathCb
+ * @param {number} rc
+ * @param {number} error
+ * @param {string} path
+ */
+
+/**
+ * Stat callback
+ * @typedef {callback} statCb
+ * @param {number} rc
+ * @param {number} error
+ * @param {stat} stat
+ */
+
+/**
+ * Data callback
+ * @typedef {callback} dataCb
+ * @param {number} rc
+ * @param {number} error
+ * @param {stat} stat
+ * @param {string|Buffer} data
+ */
+
+/**
+ * Child callback
+ * @typedef {callback} childCb
+ * @param {number} rc
+ * @param {number} error
+ * @param {Array.<string>} children
+ */
+
+/**
+ * Child2 callback
+ * @typedef {callback} child2Cb
+ * @param {number} rc
+ * @param {number} error
+ * @param {Array.<string>} children
+ * @param {stat} stat
+ */
+
+/**
+ * Value callback
+ * @typedef {callback} valueCb
+ * @param {number} rc
+ * @param {number} error
+ * @param {*} value
+ */
+
+/**
+ * Void callback
+ * @typedef {callback} voidCb
+ * @param {number} rc
+ * @param {number} error
+ */
+
+/**
+ * Watch callback
+ * @typedef {callback} watchCb
+ * @param {number} type
+ * @param {number} state
+ * @param {string} path
+ */
+
+/**
+ * ACL callback
+ * @typedef {callback} aclCb
+ * @param {number} rc
+ * @param {number} error
+ * @param {acl} acl
+ * @param {stat} stat
  */

lib/zk_promise.js

@@ -92,7 +92,7 @@ class ZooKeeperPromise extends ZooKeeper {
      * @param path {string}
      * @param watch {boolean}
      * @fulfill {childrenWithStat}
-     * @returns {Promise.<childrenWithStat>}
+     * @returns {Promise.<Array.<string>>,<stat>}
      */
     get_children2(path, watch) {
         return this.promisify(super.a_get_children2, [path, watch]);
@@ -102,7 +102,7 @@ class ZooKeeperPromise extends ZooKeeper {
      * @param path {string}
      * @param watchCb {function}
      * @fulfill {childrenWithStat}
-     * @returns {Promise.<childrenWithStat>}
+     * @returns {Promise.<Array.<string>>,<stat>}
      */
     w_get_children2(path, watchCb) {
         return this.promisify(super.aw_get_children2, [path, watchCb]);

lib/zookeeper.js

@@ -43,7 +43,7 @@ const create = (con, p, cb) => {
  * does not support ./file or /dir/../file
  * @param con {ZooKeeper}
  * @param p {string}
- * @param callback {function}
+ * @param callback {mkdirCb}
  */
 const mkdirp = (con, p, callback) => {
     const dirs = normalize(p).split('/').slice(1); // remove empty string at the start.
@@ -130,7 +130,7 @@ class ZooKeeper extends EventEmitter {
 
     /**
      * @param options {object|function}
-     * @param cb {function}
+     * @param cb {connectCb}
      */
     connect(options, cb) {
         let callback;
@@ -168,7 +168,7 @@ class ZooKeeper extends EventEmitter {
      * @param path {string}
      * @param data {string|Buffer}
      * @param flags {number} an int32 value
-     * @param pathCb {function}
+     * @param pathCb {pathCb}
      * @returns {*}
      */
     a_create(path, data, flags, pathCb) {
@@ -179,7 +179,7 @@ class ZooKeeper extends EventEmitter {
     /**
      * @param path {string}
      * @param watch {boolean}
-     * @param statCb {function}
+     * @param statCb {statCb}
      * @returns {*}
      */
     a_exists(path, watch, statCb) {
@@ -189,8 +189,8 @@ class ZooKeeper extends EventEmitter {
 
     /**
      * @param path {string}
-     * @param watchCb {function}
-     * @param statCb {function}
+     * @param watchCb {watchCb}
+     * @param statCb {statCb}
      * @returns {*}
      */
     aw_exists(path, watchCb, statCb) {
@@ -201,7 +201,7 @@ class ZooKeeper extends EventEmitter {
     /**
      * @param path {string}
      * @param watch {bool}
-     * @param dataCb {function}
+     * @param dataCb {dataCb}
      * @returns {*}
      */
     a_get(path, watch, dataCb) {
@@ -216,8 +216,8 @@ class ZooKeeper extends EventEmitter {
 
     /**
      * @param path {string}
-     * @param watchCb {function}
-     * @param dataCb {function}
+     * @param watchCb {watchCb}
+     * @param dataCb {dataCb}
      * @returns {*}
      */
     aw_get(path, watchCb, dataCb) {
@@ -233,7 +233,7 @@ class ZooKeeper extends EventEmitter {
     /**
      * @param path {string}
      * @param watch {boolean}
-     * @param childCb {function}
+     * @param childCb {childCb}
      * @returns {*}
      */
     a_get_children(path, watch, childCb) {
@@ -243,8 +243,8 @@ class ZooKeeper extends EventEmitter {
 
     /**
      * @param path {string}
-     * @param watchCb {function}
-     * @param childCb {function}
+     * @param watchCb {watchCb}
+     * @param childCb {childCb}
      * @returns {*}
      */
     aw_get_children(path, watchCb, childCb) {
@@ -255,7 +255,7 @@ class ZooKeeper extends EventEmitter {
     /**
      * @param path {string}
      * @param watch {boolean}
-     * @param childCb {function}
+     * @param childCb {childCb}
      * @returns {*}
      */
     a_get_children2(path, watch, childCb) {
@@ -265,8 +265,8 @@ class ZooKeeper extends EventEmitter {
 
     /**
      * @param path {string}
-     * @param watchCb {function}
-     * @param childCb {function}
+     * @param watchCb {watchCb}
+     * @param childCb {childCb}
      * @returns {*}
      */
     aw_get_children2(path, watchCb, childCb) {
@@ -278,7 +278,7 @@ class ZooKeeper extends EventEmitter {
      * @param path {string}
      * @param data {string|Buffer}
      * @param version {number} an int32 value
-     * @param statCb {function}
+     * @param statCb {statCb}
      * @returns {*}
      */
     a_set(path, data, version, statCb) {
@@ -289,7 +289,7 @@ class ZooKeeper extends EventEmitter {
     /**
      * @param path {string}
      * @param version {number} an int32 value
-     * @param voidCb {function}
+     * @param voidCb {voidCb}
      * @returns {*}
      */
     // eslint-disable-next-line no-underscore-dangle
@@ -301,7 +301,7 @@ class ZooKeeper extends EventEmitter {
 
     /**
      * @param path {string}
-     * @param aclCb {function}
+     * @param aclCb {aclCb}
      * @returns {*}
      */
     a_get_acl(path, aclCb) {
@@ -313,7 +313,7 @@ class ZooKeeper extends EventEmitter {
      * @param path {string}
      * @param version {number} an int32 value
      * @param acl {acl}
-     * @param voidCb {function}
+     * @param voidCb {voidCb}
      * @returns {*}
      */
     a_set_acl(path, version, acl, voidCb) {
@@ -333,7 +333,7 @@ class ZooKeeper extends EventEmitter {
 
     /**
      * @param path {string}
-     * @param cb {function}
+     * @param cb {mkdirCb}
      */
     mkdirp(path, cb) {
         this.log(`Calling mkdirp with ${util.inspect([path, cb])}`);