Merge pull request #3984 from whymarrh/3941-jsdoc

Add a few docblocks to background files

1 files changed, 16 insertions, 2 deletions

diff --git a/app/scripts/lib/stream-utils.js b/app/scripts/lib/stream-utils.js
index 8bb0b4f3c..3dbc064b5 100644
--- a/app/scripts/lib/stream-utils.js
+++ b/app/scripts/lib/stream-utils.js
@@ -8,20 +8,34 @@ module.exports = {
   setupMultiplex: setupMultiplex,
 }
 
+/**
+ * Returns a stream transform that parses JSON strings passing through
+ * @return {stream.Transform}
+ */
 function jsonParseStream () {
-  return Through.obj(function (serialized, encoding, cb) {
+  return Through.obj(function (serialized, _, cb) {
     this.push(JSON.parse(serialized))
     cb()
   })
 }
 
+/**
+ * Returns a stream transform that calls {@code JSON.stringify}
+ * on objects passing through
+ * @return {stream.Transform} the stream transform
+ */
 function jsonStringifyStream () {
-  return Through.obj(function (obj, encoding, cb) {
+  return Through.obj(function (obj, _, cb) {
     this.push(JSON.stringify(obj))
     cb()
   })
 }
 
+/**
+ * Sets up stream multiplexing for the given stream
+ * @param {any} connectionStream - the stream to mux
+ * @return {stream.Stream} the multiplexed stream
+ */
 function setupMultiplex (connectionStream) {
   const mux = new ObjectMultiplex()
   pump(