Skip to content

Commit

Permalink
docs(Docs): Regenrate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nduchak committed May 22, 2019
1 parent bb546c7 commit 36a076b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/api/node.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import Node from '@aeternity/aepp-sdk/es/node'
* [~loader(options)](#module_@aeternity/aepp-sdk/es/node--Node..loader)`function`
* [~getConsensusProtocolVersion(protocols, height)](#module_@aeternity/aepp-sdk/es/node--Node..getConsensusProtocolVersion)`Number`
* _async_
* [~remoteSwag(url)](#module_@aeternity/aepp-sdk/es/node--Node..remoteSwag)`Object`
* [~remoteSwag(url, axiosConfig)](#module_@aeternity/aepp-sdk/es/node--Node..remoteSwag)`Object`

<a id="exp_module_@aeternity/aepp-sdk/es/node--Node"></a>

Expand All @@ -29,6 +29,7 @@ import Node from '@aeternity/aepp-sdk/es/node'
| [options] | `Object` | <code>{}</code> | Options |
| options.url | `String` | | Base URL for Node |
| options.internalUrl | `String` | | Base URL for internal requests |
| options.axiosConfig | `String` | | Object with axios configuration. Example { config: {}, errorHandler: (err) => throw err } |

**Example**
```js
Expand Down Expand Up @@ -60,11 +61,11 @@ get consensus protocol version
| Param | Type | Description |
| --- | --- | --- |
| protocols | `Array` | Array of protocols |
| height | `Number` | Geigh |
| height | `Number` | Height |

<a id="module_@aeternity/aepp-sdk/es/node--Node..remoteSwag"></a>

#### Node~remoteSwag(url) ⇒ `Object`
#### Node~remoteSwag(url, axiosConfig) ⇒ `Object`
Obtain Swagger configuration from Node node

**Kind**: inner method of [`Node`](#exp_module_@aeternity/aepp-sdk/es/node--Node)
Expand All @@ -75,4 +76,5 @@ Obtain Swagger configuration from Node node
| Param | Type | Description |
| --- | --- | --- |
| url | `String` | Node base URL |
| axiosConfig | `Object` | Axios configuration object |

1 change: 1 addition & 0 deletions docs/api/utils/swagger.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ Swagger Stamp
| --- | --- | --- |
| options | `Object` | Initializer object |
| options.swag | `Object` | Swagger definition |
| options.axiosConfig | `Object` | Object with axios configuration. Example { config: {}, errorHandler: (err) => throw err } |

**Example**
```js
Expand Down

0 comments on commit 36a076b

Please sign in to comment.