doc: add types to JSDoc

Author: BridgeAR

lib/parser.js

@@ -13,9 +13,9 @@ var counter = 0
 var notDecreased = 0
 
 /**
- * Used for lengths and numbers only, faster perf on arrays / bulks
- * @param parser
- * @returns {*}
+ * Used for integer numbers only
+ * @param {JavascriptRedisParser} parser
+ * @returns {undefined|number}
  */
 function parseSimpleNumbers (parser) {
   const length = parser.buffer.length - 1
@@ -41,11 +41,11 @@ function parseSimpleNumbers (parser) {
 /**
  * Used for integer numbers in case of the returnNumbers option
  *
- * The maximum possible integer to use is: Math.floor(Number.MAX_SAFE_INTEGER / 10)
- * Staying in a SMI Math.floor((Math.pow(2, 32) / 10) - 1) is even more efficient though
+ * Reading the string as parts of n SMI is more efficient than
+ * using a string directly.
  *
- * @param parser
- * @returns {*}
+ * @param {JavascriptRedisParser} parser
+ * @returns {undefined|string}
  */
 function parseStringNumbers (parser) {
   const length = parser.buffer.length - 1
@@ -80,8 +80,8 @@ function parseStringNumbers (parser) {
 /**
  * Parse a '+' redis simple string response but forward the offsets
  * onto convertBufferRange to generate a string.
- * @param parser
- * @returns {*}
+ * @param {JavascriptRedisParser} parser
+ * @returns {undefined|string|Buffer}
  */
 function parseSimpleString (parser) {
   const start = parser.offset
@@ -102,8 +102,8 @@ function parseSimpleString (parser) {
 
 /**
  * Returns the read length
- * @param parser
- * @returns {*}
+ * @param {JavascriptRedisParser} parser
+ * @returns {undefined|number}
  */
 function parseLength (parser) {
   const length = parser.buffer.length - 1
@@ -127,8 +127,8 @@ function parseLength (parser) {
  * This is important for big numbers (number > Math.pow(2, 53)) as js numbers
  * are 64bit floating point numbers with reduced precision
  *
- * @param parser
- * @returns {*}
+ * @param {JavascriptRedisParser} parser
+ * @returns {undefined|number|string}
  */
 function parseInteger (parser) {
   if (parser.optionStringNumbers === true) {
@@ -139,8 +139,8 @@ function parseInteger (parser) {
 
 /**
  * Parse a '$' redis bulk string response
- * @param parser
- * @returns {*}
+ * @param {JavascriptRedisParser} parser
+ * @returns {undefined|null|string}
  */
 function parseBulkString (parser) {
   const length = parseLength(parser)
@@ -150,25 +150,25 @@ function parseBulkString (parser) {
   if (length < 0) {
     return null
   }
-  const offsetEnd = parser.offset + length
-  if (offsetEnd + 2 > parser.buffer.length) {
-    parser.bigStrSize = offsetEnd + 2
+  const offset = parser.offset + length
+  if (offset + 2 > parser.buffer.length) {
+    parser.bigStrSize = offset + 2
     parser.totalChunkSize = parser.buffer.length
     parser.bufferCache.push(parser.buffer)
     return
   }
   const start = parser.offset
-  parser.offset = offsetEnd + 2
+  parser.offset = offset + 2
   if (parser.optionReturnBuffers === true) {
-    return parser.buffer.slice(start, offsetEnd)
+    return parser.buffer.slice(start, offset)
   }
-  return parser.buffer.toString('utf8', start, offsetEnd)
+  return parser.buffer.toString('utf8', start, offset)
 }
 
 /**
  * Parse a '-' redis error response
- * @param parser
- * @returns {Error}
+ * @param {JavascriptRedisParser} parser
+ * @returns {ReplyError}
  */
 function parseError (parser) {
   var string = parseSimpleString(parser)
@@ -182,8 +182,9 @@ function parseError (parser) {
 
 /**
  * Parsing error handler, resets parser buffer
- * @param parser
- * @param error
+ * @param {JavascriptRedisParser} parser
+ * @param {number} type
+ * @returns {undefined}
  */
 function handleError (parser, error) {
   parser.buffer = null
@@ -192,8 +193,8 @@ function handleError (parser, error) {
 
 /**
  * Parse a '*' redis array response
- * @param parser
- * @returns {*}
+ * @param {JavascriptRedisParser} parser
+ * @returns {undefined|null|any[]}
  */
 function parseArray (parser) {
   const length = parseLength(parser)
@@ -210,20 +211,20 @@ function parseArray (parser) {
 /**
  * Push a partly parsed array to the stack
  *
- * @param parser
- * @param elem
- * @param i
+ * @param {JavascriptRedisParser} parser
+ * @param {any[]} array
+ * @param {number} pos
  * @returns {undefined}
  */
-function pushArrayCache (parser, elem, pos) {
-  parser.arrayCache.push(elem)
+function pushArrayCache (parser, array, pos) {
+  parser.arrayCache.push(array)
   parser.arrayPos.push(pos)
 }
 
 /**
  * Parse chunked redis array response
- * @param parser
- * @returns {*}
+ * @param {JavascriptRedisParser} parser
+ * @returns {undefined|any[]}
  */
 function parseArrayChunks (parser) {
   const tmp = parser.arrayCache.pop()
@@ -241,10 +242,10 @@ function parseArrayChunks (parser) {
 
 /**
  * Parse redis array response elements
- * @param parser
- * @param responses
- * @param i
- * @returns {*}
+ * @param {JavascriptRedisParser} parser
+ * @param {Array} responses
+ * @param {number} i
+ * @returns {undefined|null|any[]}
  */
 function parseArrayElements (parser, responses, i) {
   const bufferLength = parser.buffer.length
@@ -256,7 +257,7 @@ function parseArrayElements (parser, responses, i) {
     }
     const response = parseType(parser, parser.buffer[parser.offset++])
     if (response === undefined) {
-      if (!parser.arrayCache.length && !parser.bufferCache.length) {
+      if (!(parser.arrayCache.length || parser.bufferCache.length)) {
         parser.offset = offset
       }
       pushArrayCache(parser, responses, i)
@@ -278,8 +279,8 @@ function parseArrayElements (parser, responses, i) {
  * 58: :
  * 45: -
  *
- * @param parser
- * @param type
+ * @param {JavascriptRedisParser} parser
+ * @param {number} type
  * @returns {*}
  */
 function parseType (parser, type) {
@@ -335,7 +336,7 @@ function decreaseBufferPool () {
  * Check if the requested size fits in the current bufferPool.
  * If it does not, reset and increase the bufferPool accordingly.
  *
- * @param length
+ * @param {number} length
  * @returns {undefined}
  */
 function resizeBuffer (length) {
@@ -360,7 +361,7 @@ function resizeBuffer (length) {
  * 1) The first chunk might contain the whole bulk string including the \r
  * 2) We are only safe to fully add up elements that are neither the first nor any of the last two elements
  *
- * @param parser
+ * @param {JavascriptRedisParser} parser
  * @returns {String}
  */
 function concatBulkString (parser) {
@@ -389,7 +390,7 @@ function concatBulkString (parser) {
  *
  * Increases the bufferPool size beforehand if necessary.
  *
- * @param parser
+ * @param {JavascriptRedisParser} parser
  * @returns {Buffer}
  */
 function concatBulkBuffer (parser) {
@@ -419,12 +420,12 @@ function concatBulkBuffer (parser) {
   return bufferPool.slice(start, bufferOffset)
 }
 
-/**
- * Javascript Redis Parser
- * @param options
- * @constructor
- */
 class JavascriptRedisParser {
+  /**
+   * Javascript Redis Parser constructor
+   * @param {{returnError: Function, returnReply: Function, returnFatalError?: Function, returnBuffers: boolean, stringNumbers: boolean }} options
+   * @constructor
+   */
   constructor (options) {
     if (!options) {
       throw new TypeError('Options are mandatory.')
@@ -458,7 +459,7 @@ class JavascriptRedisParser {
   /**
    * Set the returnBuffers option
    *
-   * @param returnBuffers
+   * @param {boolean} returnBuffers
    * @returns {undefined}
    */
   setReturnBuffers (returnBuffers) {
@@ -471,7 +472,7 @@ class JavascriptRedisParser {
   /**
    * Set the stringNumbers option
    *
-   * @param stringNumbers
+   * @param {boolean} stringNumbers
    * @returns {undefined}
    */
   setStringNumbers (stringNumbers) {
@@ -483,7 +484,7 @@ class JavascriptRedisParser {
 
   /**
    * Parse the redis buffer
-   * @param buffer
+   * @param {Buffer} buffer
    * @returns {undefined}
    */
   execute (buffer) {
@@ -530,7 +531,7 @@ class JavascriptRedisParser {
       const type = this.buffer[this.offset++]
       const response = parseType(this, type)
       if (response === undefined) {
-        if (!this.arrayCache.length && !this.bufferCache.length) {
+        if (!(this.arrayCache.length || this.bufferCache.length)) {
           this.offset = offset
         }
         return