mirror of
				https://github.com/Xahau/xahau.js.git
				synced 2025-11-04 04:55:48 +00:00 
			
		
		
		
	docs: update README (#1762)
* update README * adds docs for LedgerEntry namespace
This commit is contained in:
		@@ -60,9 +60,9 @@ For more examples, see the [documentation](#documentation).
 | 
			
		||||
 | 
			
		||||
### Using xrpl.js with React Native
 | 
			
		||||
 | 
			
		||||
If you want to use `xrpl.js` with React Native you will need to have some of the NodeJS modules available. To help with this you can use a module like [rn-nodeify](https://github.com/tradle/rn-nodeify).
 | 
			
		||||
If you want to use `xrpl.js` with React Native you will need to install shims for core NodeJS modules. To help with this you can use a module like [rn-nodeify](https://github.com/tradle/rn-nodeify).
 | 
			
		||||
 | 
			
		||||
1. Install dependencies (you can use `npm` as well):
 | 
			
		||||
1. Install dependencies (you can use `yarn` as well):
 | 
			
		||||
 | 
			
		||||
    ```shell
 | 
			
		||||
    npm install react-native-crypto
 | 
			
		||||
@@ -122,7 +122,7 @@ import xrpl from 'https://dev.jspm.io/npm:xrpl';
 | 
			
		||||
 | 
			
		||||
+ [Get Started in Node.js](https://xrpl.org/get-started-using-node-js.html)
 | 
			
		||||
+ [Full Reference Documentation](https://js.xrpl.org)
 | 
			
		||||
+ [Code Samples](https://github.com/XRPLF/xrpl.js/tree/develop/docs/samples)
 | 
			
		||||
+ [Code Samples](https://github.com/XRPLF/xrpl.js/tree/develop/snippets/src)
 | 
			
		||||
 | 
			
		||||
### Mailing Lists
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -1,3 +1,11 @@
 | 
			
		||||
/**
 | 
			
		||||
 * LedgerEntry type definitions are exported in their own namespace to prevent
 | 
			
		||||
 * collisions of the DepositPreauth SLE and Transaction. LedgerEntries are used
 | 
			
		||||
 * by the client less often, and in most scenarios, like when parsing a
 | 
			
		||||
 * response, the client won't need to import the type. If it is required to use
 | 
			
		||||
 * a Ledger Entry, import `LedgerEntry`, and access individual ledger entry
 | 
			
		||||
 * types on the `LedgerEntry` namespace.
 | 
			
		||||
 */
 | 
			
		||||
export * as LedgerEntry from './ledger'
 | 
			
		||||
export {
 | 
			
		||||
  setTransactionFlagsToNumber,
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user