docs: split methods to sections

endpass · May 7, 2019 · dad17d2 · dad17d2
1 parent 8c7f19f
commit dad17d2
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -79,19 +79,34 @@ web3.setProvider(provider);
 
 ### API
 
-#### Instance methods
-
-| Method | Params | Returns | Description |
-| --------------------- | ---------------------------------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `auth` | | `Promise<{ status: boolean, message?: string }>` | Open Endpass Connect application for user authorization, return promise, which returns object with auth status. See [Errors handling](#errors-handling) for more details. |
-| `logout` | | `Promise<Boolean>` | Makes logout request and returns status or throw error |
-| `getAccountData` | | `Promise<{ activeAccount: string, activeNet: number }>` | Returns authorized user active account. |
-| `getProvider` | `provider: Web3.Provider` | `Web3Provider` | Creates Web3 provider for injection in Web3 instance. |
-| `getWidgetNode` | | `Promise<Element>` | Returns widget iframe node when it is available. |
-| `setProviderSettings` | `{ activeAccount: string, activeNet: number }` | | Set user settings to the injected `web3` provider. |
-| `openAccount` | | `Promise<{ type: string, payload?: { activeAccount: string, activeNet: number } }>` | Open Endpass Connect application for change user active address, network or logout |
-| `mountWidget` | `{ position: string }` | `Promise<Element>` | Mounts Endpass widget on given position and returns iframe element |
-| `unmountWidget` | | | Removes mounted Endpass widget |
+#### Authorization
+
+| Method | Params | Returns | Description |
+| -------- | ------ | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `auth` | | `Promise<{ status: boolean, message?: string }>` | Open Endpass Connect application for user authorization, return promise, which returns object with auth status. See [Errors handling](#errors-handling) for more details. |
+| `logout` | | `Promise<Boolean>` | Makes logout request and returns status or throw error |
+
+#### Account
+
+| Method | Params | Returns | Description |
+| ---------------- | ------ | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| `getAccountData` | | `Promise<{ activeAccount: string, activeNet: number }>` | Returns authorized user active account. |
+| `openAccount` | | `Promise<{ type: string, payload?: { activeAccount: string, activeNet: number } }>` | Open Endpass Connect application for change user active address, network or logout |
+
+#### Provider
+
+| Method | Params | Returns | Description |
+| --------------------- | ---------------------------------------------- | -------------- | ----------------------------------------------------- |
+| `getProvider` | `provider: Web3.Provider` | `Web3Provider` | Creates Web3 provider for injection in Web3 instance. |
+| `setProviderSettings` | `{ activeAccount: string, activeNet: number }` | | Set user settings to the injected `web3` provider. |
+
+#### Widget
+
+| Method | Params | Returns | Description |
+| --------------- | ---------------------- | ------------------ | ------------------------------------------------------------------ |
+| `getWidgetNode` | | `Promise<Element>` | Returns widget iframe node when it is available. |
+| `mountWidget` | `{ position: string }` | `Promise<Element>` | Mounts Endpass widget on given position and returns iframe element |
+| `unmountWidget` | | | Removes mounted Endpass widget |
 
 ### Interactions with current account
 

diff --git a/src/Connect.js b/src/Connect.js
@@ -125,10 +125,8 @@ export default class Connect {
  * @param {String} [params.position] Position of mounting widget
  * @returns {Promise<Element>} Mounted widget iframe element
  */
- async mountWidget(params) {
- const res = await this[privateFields.context].mountWidget(params);
-
- return res;
+ mountWidget(params) {
+ return this[privateFields.context].mountWidget(params);
  }
 
  /**

diff --git a/src/Context.js b/src/Context.js
@@ -228,11 +228,13 @@ export default class Context {
  return this.inpageProvider.settings;
  }
 
+ /**
+ * @param {Object} [parameters]
+ * @returns {Promise<Element>}
+ */
  async mountWidget(parameters) {
  if (this.isWidgetMounted) {
- const widgetNode = await this.bridge.getWidgetNode();
-
- return widgetNode;
+ return this.bridge.getWidgetNode();
  }
 
  this.widgetMessenger = new CrossWindowMessenger({

diff --git a/src/class/Bridge.js b/src/class/Bridge.js
@@ -115,12 +115,14 @@ export default class Bridge {
  return res;
  }
 
- async mountWidget(parameters) {
+ /**
+ * @param {Object} [parameters]
+ * @returns {Element}
+ */
+ mountWidget(parameters) {
  this.initWidgetMessenger();
 
- const res = await this.widget.mount(parameters);
-
- return res;
+ return this.widget.mount(parameters);
  }
 
  unmountWidget() {