Merge pull request #3987 from MetaMask/dm-docs-1

Documentation for various controllers and and lib utils

1 files changed, 8 insertions, 0 deletions

diff --git a/app/scripts/lib/nodeify.js b/app/scripts/lib/nodeify.js
index 9b595d93c..25be6537b 100644
--- a/app/scripts/lib/nodeify.js
+++ b/app/scripts/lib/nodeify.js
@@ -1,6 +1,14 @@
 const promiseToCallback = require('promise-to-callback')
 const noop = function () {}
 
+/**
+ * A generator that returns a function which, when passed a promise, can treat that promise as a node style callback.
+ * The prime advantage being that callbacks are better for error handling.
+ *
+ * @param {Function} fn The function to handle as a callback
+ * @param {Object} context The context in which the fn is to be called, most often a this reference
+ *
+ */
 module.exports = function nodeify (fn, context) {
   return function () {
     const args = [].slice.call(arguments)