Merge pull request #4020 from MetaMask/i3941-jsdoc-bitpshr

Documentation

1 files changed, 37 insertions, 2 deletions

diff --git a/app/scripts/config.js b/app/scripts/config.js
index a8470ed82..e6f70ca2b 100644
--- a/app/scripts/config.js
+++ b/app/scripts/config.js
@@ -15,7 +15,41 @@ const BETA_UI_NETWORK_TYPE = 'networkBeta'
 
 global.METAMASK_DEBUG = process.env.METAMASK_DEBUG
 
-module.exports = {
+/**
+ * @typedef {Object} UrlConfig
+ * @property {string} localhost URL of local RPC provider
+ * @property {string} mainnet URL of mainnet RPC provider
+ * @property {string} ropsten URL of Ropsten testnet RPC provider
+ * @property {string} kovan URL of Kovan testnet RPC provider
+ * @property {string} rinkeby URL of Rinkeby testnet RPC provider
+ */
+
+/**
+ * @typedef {Object} NameConfig
+ * @property {string} 3 URL of local RPC provider
+ * @property {string} 4 URL of mainnet RPC provider
+ * @property {string} 42 URL of Ropsten testnet RPC provider
+ */
+
+/**
+ * @typedef {Object} EnumConfig
+ * @property {string} DEFAULT_RPC Default network provider URL
+ * @property {string} OLD_UI_NETWORK_TYPE Network associated with old UI
+ * @property {string} BETA_UI_NETWORK_TYPE Network associated with new UI
+ */
+
+/**
+ * @typedef {Object} Config
+ * @property {UrlConfig} network Network configuration parameters
+ * @property {UrlConfig} networkBeta Beta UI network configuration parameters
+ * @property {NameConfig} networkNames Network name configuration parameters
+ * @property {EnumConfig} enums Application-wide string constants
+ */
+
+/**
+ * @type {Config}
+ **/
+const config = {
   network: {
     localhost: LOCALHOST_RPC_URL,
     mainnet: MAINET_RPC_URL,
@@ -23,7 +57,6 @@ module.exports = {
     kovan: KOVAN_RPC_URL,
     rinkeby: RINKEBY_RPC_URL,
   },
-  // Used for beta UI
   networkBeta: {
     localhost: LOCALHOST_RPC_URL,
     mainnet: MAINET_RPC_URL_BETA,
@@ -42,3 +75,5 @@ module.exports = {
     BETA_UI_NETWORK_TYPE,
   },
 }
+
+module.exports = config