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

fix: load osano first in docs site (#2202)

Browse Source
This commit is contained in:
justinr1234
2023-02-06 11:23:52 -06:00
committed by GitHub
parent 5fe480ece4
commit cb8cec2caa
224 changed files with 2242 additions and 2633 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/interfaces/SubscribeRequest.html
View File

@@ -1,4 +1,4 @@
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><script>
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><script src="https://cmp.osano.com/AzyjT6TIZMlgyLyy8/ad2447d5-f101-40df-b92e-d6452b5ecac0/osano.js"></script><script>
(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
@@ -33,7 +33,7 @@ certain events happen. Expects a response in the form of a.
<ul class="tsd-hierarchy">
<li><span class="target">SubscribeRequest</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/c74ffddf/packages/xrpl/src/models/methods/subscribe.ts#L46">packages/xrpl/src/models/methods/subscribe.ts:46</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L46">packages/xrpl/src/models/methods/subscribe.ts:46</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">
@@ -63,14 +63,14 @@ The server sends a notification for any transaction that affects at least
one of these accounts.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/c74ffddf/packages/xrpl/src/models/methods/subscribe.ts#L56">packages/xrpl/src/models/methods/subscribe.ts:56</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L56">packages/xrpl/src/models/methods/subscribe.ts:56</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="accounts_proposed" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>accounts_<wbr/>proposed</span><a href="#accounts_proposed" 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">accounts_<wbr/>proposed<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
<div class="tsd-comment tsd-typography"><p>Like accounts, but include transactions that are not yet finalized.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/c74ffddf/packages/xrpl/src/models/methods/subscribe.ts#L58">packages/xrpl/src/models/methods/subscribe.ts:58</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L58">packages/xrpl/src/models/methods/subscribe.ts:58</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="api_version" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>api_<wbr/>version</span><a href="#api_version" 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">api_<wbr/>version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
@@ -78,7 +78,7 @@ one of these accounts.</p>
</div><aside class="tsd-sources">
<p>Inherited from BaseRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/c74ffddf/packages/xrpl/src/models/methods/baseMethod.ts#L14">packages/xrpl/src/models/methods/baseMethod.ts:14</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/baseMethod.ts#L14">packages/xrpl/src/models/methods/baseMethod.ts:14</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="books" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>books</span><a href="#books" 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">books<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Book</span><span class="tsd-signature-symbol">[]</span></div>
@@ -86,13 +86,13 @@ one of these accounts.</p>
Below.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/c74ffddf/packages/xrpl/src/models/methods/subscribe.ts#L63">packages/xrpl/src/models/methods/subscribe.ts:63</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L63">packages/xrpl/src/models/methods/subscribe.ts:63</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="command" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>command</span><a href="#command" 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">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;subscribe&quot;</span></div><aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/c74ffddf/packages/xrpl/src/models/methods/subscribe.ts#L47">packages/xrpl/src/models/methods/subscribe.ts:47</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L47">packages/xrpl/src/models/methods/subscribe.ts:47</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="id" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>id</span><a href="#id" 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">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
@@ -102,14 +102,14 @@ know which request prompted which response.</p>
</div><aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/c74ffddf/packages/xrpl/src/models/methods/baseMethod.ts#L10">packages/xrpl/src/models/methods/baseMethod.ts:10</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/baseMethod.ts#L10">packages/xrpl/src/models/methods/baseMethod.ts:10</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="streams" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>streams</span><a href="#streams" 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">streams<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">StreamType</span><span class="tsd-signature-symbol">[]</span></div>
<div class="tsd-comment tsd-typography"><p>Array of string names of generic streams to subscribe to.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/c74ffddf/packages/xrpl/src/models/methods/subscribe.ts#L49">packages/xrpl/src/models/methods/subscribe.ts:49</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L49">packages/xrpl/src/models/methods/subscribe.ts:49</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="url" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>url</span><a href="#url" 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">url<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -117,21 +117,21 @@ know which request prompted which response.</p>
Admin-only.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/c74ffddf/packages/xrpl/src/models/methods/subscribe.ts#L68">packages/xrpl/src/models/methods/subscribe.ts:68</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L68">packages/xrpl/src/models/methods/subscribe.ts:68</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="url_password" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>url_<wbr/>password</span><a href="#url_password" 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">url_<wbr/>password<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>Password to provide for basic authentication at the callback URL.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/c74ffddf/packages/xrpl/src/models/methods/subscribe.ts#L72">packages/xrpl/src/models/methods/subscribe.ts:72</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L72">packages/xrpl/src/models/methods/subscribe.ts:72</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="url_username" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>url_<wbr/>username</span><a href="#url_username" 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">url_<wbr/>username<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>Username to provide for basic authentication at the callback URL.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/c74ffddf/packages/xrpl/src/models/methods/subscribe.ts#L70">packages/xrpl/src/models/methods/subscribe.ts:70</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L70">packages/xrpl/src/models/methods/subscribe.ts:70</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">