ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2026-02-18 12:52:28 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
xahau.js/docs/types/Request.html
Raj Patel 8995e3d579 Docgen issue fix (#2910) 
* fix: use .mts extension to emit ES Modules

* add comments and Apppliction type

* update docs
2025-03-07 20:07:47 -05:00

8 lines
13 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html class="default" lang="en" data-base=".."><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=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-M7HKJJ3');
</script><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Request | 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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-M7HKJJ3" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></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"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="Request.html">Request</a></li></ul><h1>Type Alias Request</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Request</span><span class="tsd-signature-symbol">:</span><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/AccountChannelsRequest.html" class="tsd-signature-type tsd-kind-interface">AccountChannelsRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/AccountCurrenciesRequest.html" class="tsd-signature-type tsd-kind-interface">AccountCurrenciesRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/AccountInfoRequest.html" class="tsd-signature-type tsd-kind-interface">AccountInfoRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/AccountLinesRequest.html" class="tsd-signature-type tsd-kind-interface">AccountLinesRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/AccountNFTsRequest.html" class="tsd-signature-type tsd-kind-interface">AccountNFTsRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/AccountObjectsRequest.html" class="tsd-signature-type tsd-kind-interface">AccountObjectsRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/AccountOffersRequest.html" class="tsd-signature-type tsd-kind-interface">AccountOffersRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/AccountTxRequest.html" class="tsd-signature-type tsd-kind-interface">AccountTxRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/GatewayBalancesRequest.html" class="tsd-signature-type tsd-kind-interface">GatewayBalancesRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/NoRippleCheckRequest.html" class="tsd-signature-type tsd-kind-interface">NoRippleCheckRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/LedgerRequest.html" class="tsd-signature-type tsd-kind-interface">LedgerRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/LedgerClosedRequest.html" class="tsd-signature-type tsd-kind-interface">LedgerClosedRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/LedgerCurrentRequest.html" class="tsd-signature-type tsd-kind-interface">LedgerCurrentRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/LedgerDataRequest.html" class="tsd-signature-type tsd-kind-interface">LedgerDataRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/LedgerEntryRequest.html" class="tsd-signature-type tsd-kind-interface">LedgerEntryRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="SimulateRequest.html" class="tsd-signature-type tsd-kind-type-alias">SimulateRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/SubmitRequest.html" class="tsd-signature-type tsd-kind-interface">SubmitRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/SubmitMultisignedRequest.html" class="tsd-signature-type tsd-kind-interface">SubmitMultisignedRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/TransactionEntryRequest.html" class="tsd-signature-type tsd-kind-interface">TransactionEntryRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/TxRequest.html" class="tsd-signature-type tsd-kind-interface">TxRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/BookOffersRequest.html" class="tsd-signature-type tsd-kind-interface">BookOffersRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/DepositAuthorizedRequest.html" class="tsd-signature-type tsd-kind-interface">DepositAuthorizedRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="PathFindRequest.html" class="tsd-signature-type tsd-kind-type-alias">PathFindRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/RipplePathFindRequest.html" class="tsd-signature-type tsd-kind-interface">RipplePathFindRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/ChannelVerifyRequest.html" class="tsd-signature-type tsd-kind-interface">ChannelVerifyRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/SubscribeRequest.html" class="tsd-signature-type tsd-kind-interface">SubscribeRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/UnsubscribeRequest.html" class="tsd-signature-type tsd-kind-interface">UnsubscribeRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/FeeRequest.html" class="tsd-signature-type tsd-kind-interface">FeeRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/ManifestRequest.html" class="tsd-signature-type tsd-kind-interface">ManifestRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/ServerDefinitionsRequest.html" class="tsd-signature-type tsd-kind-interface">ServerDefinitionsRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/ServerInfoRequest.html" class="tsd-signature-type tsd-kind-interface">ServerInfoRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/ServerStateRequest.html" class="tsd-signature-type tsd-kind-interface">ServerStateRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="FeatureRequest.html" class="tsd-signature-type tsd-kind-type-alias">FeatureRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/PingRequest.html" class="tsd-signature-type tsd-kind-interface">PingRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/RandomRequest.html" class="tsd-signature-type tsd-kind-interface">RandomRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/NFTBuyOffersRequest.html" class="tsd-signature-type tsd-kind-interface">NFTBuyOffersRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/NFTSellOffersRequest.html" class="tsd-signature-type tsd-kind-interface">NFTSellOffersRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/NFTInfoRequest.html" class="tsd-signature-type tsd-kind-interface">NFTInfoRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/NFTHistoryRequest.html" class="tsd-signature-type tsd-kind-interface">NFTHistoryRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/NFTsByIssuerRequest.html" class="tsd-signature-type tsd-kind-interface">NFTsByIssuerRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/AMMInfoRequest.html" class="tsd-signature-type tsd-kind-interface">AMMInfoRequest</a><br/>    <span class="tsd-signature-symbol">|</span> <a href="../interfaces/GetAggregatePriceRequest.html" class="tsd-signature-type tsd-kind-interface">GetAggregatePriceRequest</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/methods/index.ts#L195">packages/xrpl/src/models/methods/index.ts:195</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">xrpl</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
Reference in New Issue View Git Blame Copy Permalink