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

10
docs/enums/OfferCreateFlags.html
View File

@@ -17,7 +17,7 @@
<div class="tsd-comment tsd-typography"><p>Transaction Flags for an OfferCreate Transaction.</p>
</div></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/transactions/offerCreate.ts#L17">packages/xrpl/src/models/transactions/offerCreate.ts:17</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/transactions/offerCreate.ts#L17">packages/xrpl/src/models/transactions/offerCreate.ts:17</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -43,7 +43,7 @@ otherwise, the transaction uses the result code tesSUCCESS even when it was
killed without trading any currency.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/transactions/offerCreate.ts#L40">packages/xrpl/src/models/transactions/offerCreate.ts:40</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/transactions/offerCreate.ts#L40">packages/xrpl/src/models/transactions/offerCreate.ts:40</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfImmediateOrCancel" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>tf<wbr/>Immediate<wbr/>Or<wbr/>Cancel</span><a href="#tfImmediateOrCancel" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">tf<wbr/>Immediate<wbr/>Or<wbr/>Cancel<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">131072</span></div>
@@ -54,7 +54,7 @@ the ledger. If the offer cannot match any offers immediately, it executes
has the result code tesSUCCESS, but creates no Offer objects in the ledger.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/transactions/offerCreate.ts#L31">packages/xrpl/src/models/transactions/offerCreate.ts:31</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/transactions/offerCreate.ts#L31">packages/xrpl/src/models/transactions/offerCreate.ts:31</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfPassive" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>tf<wbr/>Passive</span><a href="#tfPassive" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">tf<wbr/>Passive<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">65536</span></div>
@@ -63,7 +63,7 @@ instead becomes an Offer object in the ledger. It still consumes offers
that cross it.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/transactions/offerCreate.ts#L23">packages/xrpl/src/models/transactions/offerCreate.ts:23</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/transactions/offerCreate.ts#L23">packages/xrpl/src/models/transactions/offerCreate.ts:23</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfSell" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>tf<wbr/>Sell</span><a href="#tfSell" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">tf<wbr/>Sell<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">524288</span></div>
@@ -71,7 +71,7 @@ that cross it.</p>
the TakerPays amount in exchange.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/transactions/offerCreate.ts#L45">packages/xrpl/src/models/transactions/offerCreate.ts:45</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/transactions/offerCreate.ts#L45">packages/xrpl/src/models/transactions/offerCreate.ts:45</a></li></ul></aside></section></section></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">