ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-12 00:35:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gw/add-nft-support
xahau.js/docs/interfaces/OfferCreateFlagsInterface.html
Nathan Nichols 14395ab58f build: update package.json version for release (#1755) 
* build: update xrpl.js for release
2021-10-20 11:34:58 -05:00

6 lines
11 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>OfferCreateFlagsInterface | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="OfferCreateFlagsInterface.html">OfferCreateFlagsInterface</a></li></ul><h1>Interface OfferCreateFlagsInterface</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Map of flags to boolean values representing <a href="OfferCreate.html">OfferCreate</a> transaction
flags.</p>
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-typescript"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">tx</span><span class="hl-1">: </span><span class="hl-8">OfferCreate</span><span class="hl-1"> = {</span><br/><span class="hl-0">Account:</span><span class="hl-1"> </span><span class="hl-5">&#39;rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd&#39;</span><span class="hl-1">,</span><br/><span class="hl-0">TakerGets:</span><span class="hl-1"> </span><span class="hl-5">&#39;43000.51&#39;</span><span class="hl-1">,</span><br/><span class="hl-0">TakerPays:</span><span class="hl-1"> </span><span class="hl-5">&#39;12928290425&#39;</span><span class="hl-1">,</span><br/><span class="hl-0">TransactionType:</span><span class="hl-1"> </span><span class="hl-5">&#39;OfferCreate&#39;</span><span class="hl-1">,</span><br/><span class="hl-0">Flags:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">tfPassive:</span><span class="hl-1"> </span><span class="hl-2">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">tfFillOrKill:</span><span class="hl-1"> </span><span class="hl-2">true</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-7">// Autofill the tx to see how flags actually look compared to the interface usage.</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">autofilledTx</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">autofill</span><span class="hl-1">(</span><span class="hl-0">tx</span><span class="hl-1">)</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">autofilledTx</span><span class="hl-1">)</span><br/><span class="hl-7">// {</span><br/><span class="hl-7">// Account: &#39;rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd&#39;,</span><br/><span class="hl-7">// TakerGets: &#39;43000.51&#39;,</span><br/><span class="hl-7">// TakerPays: &#39;12928290425&#39;,</span><br/><span class="hl-7">// TransactionType: &#39;OfferCreate&#39;,</span><br/><span class="hl-7">// Flags: 327680,</span><br/><span class="hl-7">// Sequence: 21970384,</span><br/><span class="hl-7">// Fee: &#39;12&#39;,</span><br/><span class="hl-7">// LastLedgerSequence: 21970404</span><br/><span class="hl-7">// }</span>
</code></pre>
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">GlobalFlags</span><ul class="tsd-hierarchy"><li><span class="target">OfferCreateFlagsInterface</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreateFlagsInterface.html#tfFillOrKill" class="tsd-kind-icon">tf<wbr/>Fill<wbr/>Or<wbr/>Kill</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreateFlagsInterface.html#tfImmediateOrCancel" class="tsd-kind-icon">tf<wbr/>Immediate<wbr/>Or<wbr/>Cancel</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreateFlagsInterface.html#tfPassive" class="tsd-kind-icon">tf<wbr/>Passive</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreateFlagsInterface.html#tfSell" class="tsd-kind-icon">tf<wbr/>Sell</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="tfFillOrKill" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr/>Fill<wbr/>Or<wbr/>Kill</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Fill<wbr/>Or<wbr/>Kill<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/offerCreate.ts#L85">src/models/transactions/offerCreate.ts:85</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="tfImmediateOrCancel" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr/>Immediate<wbr/>Or<wbr/>Cancel</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Immediate<wbr/>Or<wbr/>Cancel<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/offerCreate.ts#L84">src/models/transactions/offerCreate.ts:84</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="tfPassive" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr/>Passive</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Passive<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/offerCreate.ts#L83">src/models/transactions/offerCreate.ts:83</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="tfSell" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr/>Sell</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Sell<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/offerCreate.ts#L86">src/models/transactions/offerCreate.ts:86</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="OfferCreateFlagsInterface.html" class="tsd-kind-icon">Offer<wbr/>Create<wbr/>Flags<wbr/>Interface</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreateFlagsInterface.html#tfFillOrKill" class="tsd-kind-icon">tf<wbr/>Fill<wbr/>Or<wbr/>Kill</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreateFlagsInterface.html#tfImmediateOrCancel" class="tsd-kind-icon">tf<wbr/>Immediate<wbr/>Or<wbr/>Cancel</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreateFlagsInterface.html#tfPassive" class="tsd-kind-icon">tf<wbr/>Passive</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreateFlagsInterface.html#tfSell" class="tsd-kind-icon">tf<wbr/>Sell</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink