ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-12-06 17:27:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

update reference docs and add readme to homepage (#2112)

Browse Source
This commit is contained in:
jonathanlei
2022-10-13 09:21:28 -07:00
committed by GitHub
parent 9df848fcc6
commit 1ceae703db
214 changed files with 3761 additions and 3651 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/types/LedgerEntry.LedgerEntry.html
View File

@@ -16,7 +16,7 @@
<h1>Type alias LedgerEntry</h1></div>
<div class="tsd-signature">Ledger<wbr/>Entry<span class="tsd-signature-symbol">:</span> <a href="../interfaces/LedgerEntry.AccountRoot.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountRoot</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/LedgerEntry.Amendments.html" class="tsd-signature-type" data-tsd-kind="Interface">Amendments</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/LedgerEntry.Check.html" class="tsd-signature-type" data-tsd-kind="Interface">Check</a><span class="tsd-signature-symbol"> | </span><a href="../modules/LedgerEntry.html" class="tsd-signature-type" data-tsd-kind="Namespace">LedgerEntry</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/LedgerEntry.DepositPreauth.html" class="tsd-signature-type" data-tsd-kind="Interface">DepositPreauth</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/LedgerEntry.DirectoryNode.html" class="tsd-signature-type" data-tsd-kind="Interface">DirectoryNode</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/LedgerEntry.Escrow.html" class="tsd-signature-type" data-tsd-kind="Interface">Escrow</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/LedgerEntry.FeeSettings.html" class="tsd-signature-type" data-tsd-kind="Interface">FeeSettings</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/LedgerEntry.LedgerHashes.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerHashes</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/LedgerEntry.NegativeUNL.html" class="tsd-signature-type" data-tsd-kind="Interface">NegativeUNL</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/LedgerEntry.Offer.html" class="tsd-signature-type" data-tsd-kind="Interface">Offer</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/LedgerEntry.PayChannel.html" class="tsd-signature-type" data-tsd-kind="Interface">PayChannel</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/LedgerEntry.RippleState.html" class="tsd-signature-type" data-tsd-kind="Interface">RippleState</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/LedgerEntry.SignerList.html" class="tsd-signature-type" data-tsd-kind="Interface">SignerList</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/LedgerEntry.Ticket.html" class="tsd-signature-type" data-tsd-kind="Interface">Ticket</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/ledger/LedgerEntry.ts#L16">packages/xrpl/src/models/ledger/LedgerEntry.ts:16</a></li></ul></aside></div>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/LedgerEntry.ts#L16">packages/xrpl/src/models/ledger/LedgerEntry.ts:16</a></li></ul></aside></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

2
docs/types/PathFindRequest.html
View File

@@ -20,7 +20,7 @@ time. For a simpler version that is supported by JSON-RPC, see the
<code>ripple_path_find</code> method.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/methods/pathFind.ts#L53">packages/xrpl/src/models/methods/pathFind.ts:53</a></li></ul></aside></div>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/methods/pathFind.ts#L53">packages/xrpl/src/models/methods/pathFind.ts:53</a></li></ul></aside></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

2
docs/types/Request.html
View File

File diff suppressed because one or more lines are too long

2
docs/types/Response.html
View File

File diff suppressed because one or more lines are too long

2
docs/types/Stream.html
View File

@@ -15,7 +15,7 @@
<h1>Type alias Stream</h1></div>
<div class="tsd-signature">Stream<span class="tsd-signature-symbol">:</span> <a href="../interfaces/LedgerStream.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerStream</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ValidationStream.html" class="tsd-signature-type" data-tsd-kind="Interface">ValidationStream</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/TransactionStream.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionStream</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/PathFindStream.html" class="tsd-signature-type" data-tsd-kind="Interface">PathFindStream</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/PeerStatusStream.html" class="tsd-signature-type" data-tsd-kind="Interface">PeerStatusStream</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/OrderBookStream.html" class="tsd-signature-type" data-tsd-kind="Interface">OrderBookStream</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ConsensusStream.html" class="tsd-signature-type" data-tsd-kind="Interface">ConsensusStream</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/methods/subscribe.ts#L417">packages/xrpl/src/models/methods/subscribe.ts:417</a></li></ul></aside></div>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/methods/subscribe.ts#L417">packages/xrpl/src/models/methods/subscribe.ts:417</a></li></ul></aside></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

2
docs/types/Transaction.html
View File

@@ -15,7 +15,7 @@
<h1>Type alias Transaction</h1></div>
<div class="tsd-signature">Transaction<span class="tsd-signature-symbol">:</span> <a href="../interfaces/AccountDelete.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountDelete</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/AccountSet.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountSet</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/CheckCancel.html" class="tsd-signature-type" data-tsd-kind="Interface">CheckCancel</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/CheckCash.html" class="tsd-signature-type" data-tsd-kind="Interface">CheckCash</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/CheckCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">CheckCreate</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/DepositPreauth.html" class="tsd-signature-type" data-tsd-kind="Interface">DepositPreauth</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/EscrowCancel.html" class="tsd-signature-type" data-tsd-kind="Interface">EscrowCancel</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/EscrowCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">EscrowCreate</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/EscrowFinish.html" class="tsd-signature-type" data-tsd-kind="Interface">EscrowFinish</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/NFTokenAcceptOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTokenAcceptOffer</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/NFTokenBurn.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTokenBurn</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/NFTokenCancelOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTokenCancelOffer</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/NFTokenCreateOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTokenCreateOffer</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/NFTokenMint.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTokenMint</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/OfferCancel.html" class="tsd-signature-type" data-tsd-kind="Interface">OfferCancel</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/OfferCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">OfferCreate</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Payment.html" class="tsd-signature-type" data-tsd-kind="Interface">Payment</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/PaymentChannelClaim.html" class="tsd-signature-type" data-tsd-kind="Interface">PaymentChannelClaim</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/PaymentChannelCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">PaymentChannelCreate</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/PaymentChannelFund.html" class="tsd-signature-type" data-tsd-kind="Interface">PaymentChannelFund</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SetRegularKey.html" class="tsd-signature-type" data-tsd-kind="Interface">SetRegularKey</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SignerListSet.html" class="tsd-signature-type" data-tsd-kind="Interface">SignerListSet</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/TicketCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">TicketCreate</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/TrustSet.html" class="tsd-signature-type" data-tsd-kind="Interface">TrustSet</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/transactions/transaction.ts#L57">packages/xrpl/src/models/transactions/transaction.ts:57</a></li></ul></aside></div>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/transactions/transaction.ts#L57">packages/xrpl/src/models/transactions/transaction.ts:57</a></li></ul></aside></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">