docs(fix): fromNodeAddress take an object (#100)

* Fix jsdoc for `fromNodeAddress` * Update to detailed Object
multiformats · Sep 25, 2019 · 43cb934 · 43cb934
1 parent 3bcb6d2
commit 43cb934
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/src/index.js b/src/index.js
@@ -381,7 +381,7 @@ Multiaddr.prototype.nodeAddress = function nodeAddress () {
 /**
  * Creates a Multiaddr from a node-friendly address object
  *
- * @param {String} addr
+ * @param {{family: String, address: String, port: Number}} addr
  * @param {String} transport
  * @returns {Multiaddr} multiaddr
  * @throws {Error} Throws error if addr is not truthy