src/coins.js: isValidCoin -> isValidNetwork

The function takes `network` as an argument after all. Add deprecation notice for old func.
BitGo · Jan 8, 2020 · 9556784 · 9556784
1 parent c9f367a
commit 9556784
Showing 1 changed file with 11 additions and 2 deletions.
diff --git a/src/coins.js b/src/coins.js
@@ -55,7 +55,11 @@ function isZcash (network) {
   return typeforce.value(networks.zcash.coin)(network.coin)
 }
 
-isValidCoin = typeforce.oneOf(
+/**
+ * @param network
+ * @returns {boolean} returns true iff network is any of the network stated in the argument
+ */
+const isValidNetwork = typeforce.oneOf(
   isBitcoin,
   isBitcoinCash,
   isBitcoinSV,
@@ -85,5 +89,10 @@ module.exports = {
   isDash,
   isLitecoin,
   isZcash,
-  isValidCoin
+
+  isValidNetwork,
+  /**
+   * @deprecated: use isValidNetwork
+   */
+  isValidCoin: isValidNetwork
 }