Fix generateAddress docs and add error event listener to boilerplate

This commit is contained in:
Chris Clark
2015-11-30 14:54:15 -08:00
parent cfc21fde8c
commit 809d981987
10 changed files with 83 additions and 30 deletions

View File

@@ -8,6 +8,9 @@ const {RippleAPI} = require('ripple-lib');
const api = new RippleAPI({
server: 'wss://s1.ripple.com' // Public rippled server hosted by Ripple, Inc.
});
api.on('error', (errorCode, errorMessage) => {
console.log(errorCode + ': ' + errorMessage);
});
api.connect().then(() => {
/* insert code here */
}).then(() => {
@@ -27,6 +30,10 @@ All the code snippets in this documentation assume that you have surrounded them
If you omit the "catch" section, errors may not be visible.
</aside>
<aside class="notice">
The "error" event is emitted whenever an error occurs that cannot be associated with a specific request. If the listener is not registered, an exception will be thrown whenever the event is emitted.
</aside>
### Parameters
The RippleAPI constructor optionally takes one argument, an object with the following options:

View File

@@ -20,7 +20,7 @@ api.on('ledger', ledger => {
## error
This event is emitted when there is an error on the connection to the server.
This event is emitted when there is an error on the connection to the server that cannot be associated to a specific request.
### Return Value

View File

@@ -6,7 +6,7 @@ Generate a new Ripple address and corresponding secret.
### Parameters
This method has no parameters.
<%- renderSchema('input/generate-address.json') %>
### Return Value
@@ -17,8 +17,7 @@ This method returns an object with the following structure:
### Example
```javascript
return api.generateAddress()
.then(result => {/* ... */});
return api.generateAddress();
```
<%- renderFixture('responses/generate-address.json') %>