+

Updated for version 0.16.10

Introduction

RippleAPI is the official client library to the Ripple Consensus Ledger. Currently, RippleAPI is only available in JavaScript. Using RippleAPI, you can:

@@ -145,6 +146,14 @@ const api = new RippleAPI({ api.on('error', (errorCode, errorMessage) => { console.log(errorCode + ': ' + errorMessage); }); +api.on('connected', () => { + console.log('connected'); +}); +api.on('disconnected', (code) => { + // code - [close code](https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent) sent by the server + // will be 1000 if this was normal closure + console.log('disconnected, code:', code); +}); api.connect().then(() => { /* insert code here */ }).then(() => { @@ -1351,7 +1360,7 @@ const api = new RippleAPI(); type transactionType -The type of the tranasction. +The type of the transaction. specification @@ -4254,7 +4263,7 @@ const trustline = { } ] }; -return api.preparePayment(address, trustline).then(prepared => +return api.prepareTrustline(address, trustline).then(prepared => {/* ... */}); 
{
@@ -4991,7 +5000,7 @@ return api.combine(signedTransactions);
 
 resultCode
 string
-The result code returned by rippled. List of tranasction responses
+The result code returned by rippled. List of transaction responses
 
 
 resultMessage
@@ -5277,6 +5286,26 @@ return api.computeLedgerHash(ledger);
 
tooBusy: The server is too busy to help you now.
+

connected

+

This event is emitted after connection successfully opened.

+

Example

+
api.on('connected', () => {
+  console.log('Connection is open now.');
+});
+
+

disconnected

+

This event is emitted when connection is closed.

+

Return Value

+

The only parameter is a number containing the close code send by the server.

+

Example

+
api.on('disconnected', (code) => {
+  if (code !== 1000) {
+    console.log('Connection is closed due to error.');
+  } else {
+    console.log('Connection is closed normally.');
+  }
+});
+