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,23 @@
## getServerInfo
`getServerInfo(): Promise<object>`
Get status information about the server that the RippleAPI instance is connected to.
### Parameters
This method has no parameters.
### Return Value
This method returns a promise that resolves with an object with the following structure:
<%- renderSchema('output/get-server-info.json') %>
### Example
```javascript
return api.getServerInfo().then(info => {/* ... */});
```
<%- renderFixture('responses/get-server-info.json') %>