Add documentation and documentation testing

This commit is contained in:
Chris Clark
2015-11-17 18:29:26 -08:00
parent f196304a56
commit 02a887776f
43 changed files with 4315 additions and 362 deletions

View File

@@ -0,0 +1,25 @@
## getBalances
`getBalances(address: string, options: Object): Promise<Array<Object>>`
Returns balances for a specified account.
### Parameters
<%- renderSchema('input/get-balances.json') %>
### Return Value
This method returns a promise that resolves with an array of objects with the following structure:
<%- renderSchema('output/get-balances.json') %>
### Example
```javascript
const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
return api.getBalances(address).then(balances =>
{/* ... */});
```
<%- renderFixture('responses/get-balances.json') %>