mirror of
https://github.com/alexgo-io/stacks-blockchain-api.git
synced 2026-04-28 12:55:41 +08:00
708 lines
49 KiB
HTML
708 lines
49 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>BaseAPI | @stacks/blockchain-api-client</title>
|
|
<meta name="description" content="Documentation for @stacks/blockchain-api-client">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
<script async src="../assets/js/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-index="../assets/js/search.json" data-base="..">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</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">@stacks/blockchain-api-client</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">@stacks/blockchain-api-client</a>
|
|
</li>
|
|
<li>
|
|
<a href="../modules/generated_runtime.html">generated/runtime</a>
|
|
</li>
|
|
<li>
|
|
<a href="generated_runtime.baseapi.html">BaseAPI</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class BaseAPI</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>This is the base class for all generated API classes.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">BaseAPI</span>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<a href="generated.accountsapi.html" class="tsd-signature-type" data-tsd-kind="Class">AccountsApi</a>
|
|
</li>
|
|
<li>
|
|
<a href="generated.blocksapi.html" class="tsd-signature-type" data-tsd-kind="Class">BlocksApi</a>
|
|
</li>
|
|
<li>
|
|
<a href="generated.faucetsapi.html" class="tsd-signature-type" data-tsd-kind="Class">FaucetsApi</a>
|
|
</li>
|
|
<li>
|
|
<a href="generated.feesapi.html" class="tsd-signature-type" data-tsd-kind="Class">FeesApi</a>
|
|
</li>
|
|
<li>
|
|
<a href="generated.fungibletokensapi.html" class="tsd-signature-type" data-tsd-kind="Class">FungibleTokensApi</a>
|
|
</li>
|
|
<li>
|
|
<a href="generated.infoapi.html" class="tsd-signature-type" data-tsd-kind="Class">InfoApi</a>
|
|
</li>
|
|
<li>
|
|
<a href="generated.microblocksapi.html" class="tsd-signature-type" data-tsd-kind="Class">MicroblocksApi</a>
|
|
</li>
|
|
<li>
|
|
<a href="generated.namesapi.html" class="tsd-signature-type" data-tsd-kind="Class">NamesApi</a>
|
|
</li>
|
|
<li>
|
|
<a href="generated.nonfungibletokensapi.html" class="tsd-signature-type" data-tsd-kind="Class">NonFungibleTokensApi</a>
|
|
</li>
|
|
<li>
|
|
<a href="generated.rosettaapi.html" class="tsd-signature-type" data-tsd-kind="Class">RosettaApi</a>
|
|
</li>
|
|
<li>
|
|
<a href="generated.searchapi.html" class="tsd-signature-type" data-tsd-kind="Class">SearchApi</a>
|
|
</li>
|
|
<li>
|
|
<a href="generated.smartcontractsapi.html" class="tsd-signature-type" data-tsd-kind="Class">SmartContractsApi</a>
|
|
</li>
|
|
<li>
|
|
<a href="generated.stackingrewardsapi.html" class="tsd-signature-type" data-tsd-kind="Class">StackingRewardsApi</a>
|
|
</li>
|
|
<li>
|
|
<a href="generated.transactionsapi.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionsApi</a>
|
|
</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>Constructors</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="generated_runtime.baseapi.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section tsd-is-private-protected">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="generated_runtime.baseapi.html#configuration" class="tsd-kind-icon">configuration</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="generated_runtime.baseapi.html#middleware" class="tsd-kind-icon">middleware</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Methods</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private"><a href="generated_runtime.baseapi.html#clone" class="tsd-kind-icon">clone</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="generated_runtime.baseapi.html#createfetchparams" class="tsd-kind-icon">create<wbr>Fetch<wbr>Params</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="generated_runtime.baseapi.html#fetchapi" class="tsd-kind-icon">fetch<wbr>Api</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="generated_runtime.baseapi.html#request" class="tsd-kind-icon">request</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="generated_runtime.baseapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="generated_runtime.baseapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="generated_runtime.baseapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Constructors</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|
<h3>constructor</h3>
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>BaseAPI<span class="tsd-signature-symbol">(</span>configuration<span class="tsd-signature-symbol">?: </span><a href="generated_runtime.configuration.html" class="tsd-signature-type" data-tsd-kind="Class">Configuration</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="generated_runtime.baseapi.html" class="tsd-signature-type" data-tsd-kind="Class">BaseAPI</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/runtime.ts#L25">src/generated/runtime.ts:25</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>configuration: <a href="generated_runtime.configuration.html" class="tsd-signature-type" data-tsd-kind="Class">Configuration</a><span class="tsd-signature-symbol"> = ...</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="generated_runtime.baseapi.html" class="tsd-signature-type" data-tsd-kind="Class">BaseAPI</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-private-protected">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
|
|
<a name="configuration" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagProtected">Protected</span> configuration</h3>
|
|
<div class="tsd-signature tsd-kind-icon">configuration<span class="tsd-signature-symbol">:</span> <a href="generated_runtime.configuration.html" class="tsd-signature-type" data-tsd-kind="Class">Configuration</a><span class="tsd-signature-symbol"> = ...</span></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a name="middleware" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> middleware</h3>
|
|
<div class="tsd-signature tsd-kind-icon">middleware<span class="tsd-signature-symbol">:</span> <a href="../interfaces/generated_runtime.middleware.html" class="tsd-signature-type" data-tsd-kind="Interface">Middleware</a><span class="tsd-signature-symbol">[]</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/runtime.ts#L25">src/generated/runtime.ts:25</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Methods</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private">
|
|
<a name="clone" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> clone</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private">
|
|
<li class="tsd-signature tsd-kind-icon">clone<T><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/runtime.ts#L107">src/generated/runtime.ts:107</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Create a shallow clone of <code>this</code> by constructing a new instance
|
|
and then shallow cloning data members.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
<ul class="tsd-type-parameters">
|
|
<li>
|
|
<h4>T<span class="tsd-signature-symbol">: </span><a href="generated_runtime.baseapi.html" class="tsd-signature-type" data-tsd-kind="Class">BaseAPI</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<a name="createfetchparams" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> create<wbr>Fetch<wbr>Params</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Fetch<wbr>Params<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated_runtime.requestopts.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOpts</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>init<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>cache<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestCache</span><span class="tsd-signature-symbol">; </span>credentials<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestCredentials</span><span class="tsd-signature-symbol">; </span>headers<span class="tsd-signature-symbol">: </span><a href="../modules/generated_runtime.html#httpheaders" class="tsd-signature-type" data-tsd-kind="Type alias">HTTPHeaders</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HeadersInit</span><span class="tsd-signature-symbol">; </span>integrity<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>keepalive<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>method<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>mode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestMode</span><span class="tsd-signature-symbol">; </span>redirect<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestRedirect</span><span class="tsd-signature-symbol">; </span>referrer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>referrerPolicy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ReferrerPolicy</span><span class="tsd-signature-symbol">; </span>signal<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">; </span>window<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/runtime.ts#L56">src/generated/runtime.ts:56</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>context: <a href="../interfaces/generated_runtime.requestopts.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOpts</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>init<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>cache<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestCache</span><span class="tsd-signature-symbol">; </span>credentials<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestCredentials</span><span class="tsd-signature-symbol">; </span>headers<span class="tsd-signature-symbol">: </span><a href="../modules/generated_runtime.html#httpheaders" class="tsd-signature-type" data-tsd-kind="Type alias">HTTPHeaders</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HeadersInit</span><span class="tsd-signature-symbol">; </span>integrity<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>keepalive<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>method<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>mode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestMode</span><span class="tsd-signature-symbol">; </span>redirect<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestRedirect</span><span class="tsd-signature-symbol">; </span>referrer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>referrerPolicy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ReferrerPolicy</span><span class="tsd-signature-symbol">; </span>signal<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">; </span>window<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>init<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>cache<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestCache</span><span class="tsd-signature-symbol">; </span>credentials<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestCredentials</span><span class="tsd-signature-symbol">; </span>headers<span class="tsd-signature-symbol">: </span><a href="../modules/generated_runtime.html#httpheaders" class="tsd-signature-type" data-tsd-kind="Type alias">HTTPHeaders</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HeadersInit</span><span class="tsd-signature-symbol">; </span>integrity<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>keepalive<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>method<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>mode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestMode</span><span class="tsd-signature-symbol">; </span>redirect<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestRedirect</span><span class="tsd-signature-symbol">; </span>referrer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>referrerPolicy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ReferrerPolicy</span><span class="tsd-signature-symbol">; </span>signal<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">; </span>window<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A BodyInit object or null to set request's body.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> cache<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestCache</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A string indicating how the request will interact with the browser's cache to set request's cache.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>credentials<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestCredentials</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. Sets request's credentials.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>headers<span class="tsd-signature-symbol">: </span><a href="../modules/generated_runtime.html#httpheaders" class="tsd-signature-type" data-tsd-kind="Type alias">HTTPHeaders</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HeadersInit</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A Headers object, an object literal, or an array of two-item arrays to set request's headers.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> integrity<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A cryptographic hash of the resource to be fetched by request. Sets request's integrity.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> keepalive<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A boolean to set request's keepalive.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>method<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A string to set request's method.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> mode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestMode</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A string to indicate whether the request will use CORS, or will be restricted to same-origin URLs. Sets request's mode.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> redirect<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestRedirect</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A string indicating whether request follows redirects, results in an error upon encountering a redirect, or returns the redirect (in an opaque fashion). Sets request's redirect.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> referrer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A string whose value is a same-origin URL, "about:client", or the empty string, to set request's referrer.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> referrer<wbr>Policy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ReferrerPolicy</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A referrer policy to set request's referrerPolicy.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> signal<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AbortSignal</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>An AbortSignal to set request's signal.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> window<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Can only be null. Used to disassociate request from any Window.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<a name="fetchapi" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> fetch<wbr>Api</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<li class="tsd-signature tsd-kind-icon">fetch<wbr>Api<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, init<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/runtime.ts#L79">src/generated/runtime.ts:79</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>url: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>init: <span class="tsd-signature-type">RequestInit</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<a name="request" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagProtected">Protected</span> request</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<li class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated_runtime.requestopts.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOpts</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/runtime.ts#L47">src/generated/runtime.ts:47</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>context: <a href="../interfaces/generated_runtime.requestopts.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOpts</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
|
|
<a name="withmiddleware" class="tsd-anchor"></a>
|
|
<h3>with<wbr>Middleware</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
|
|
<li class="tsd-signature tsd-kind-icon">with<wbr>Middleware<T><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>middlewares<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated_runtime.middleware.html" class="tsd-signature-type" data-tsd-kind="Interface">Middleware</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/runtime.ts#L31">src/generated/runtime.ts:31</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
<ul class="tsd-type-parameters">
|
|
<li>
|
|
<h4>T<span class="tsd-signature-symbol">: </span><a href="generated_runtime.baseapi.html" class="tsd-signature-type" data-tsd-kind="Class">BaseAPI</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>middlewares: <a href="../interfaces/generated_runtime.middleware.html" class="tsd-signature-type" data-tsd-kind="Interface">Middleware</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
|
|
<a name="withpostmiddleware" class="tsd-anchor"></a>
|
|
<h3>with<wbr>Post<wbr>Middleware</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
|
|
<li class="tsd-signature tsd-kind-icon">with<wbr>Post<wbr>Middleware<T><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>postMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated_runtime.responsecontext.html" class="tsd-signature-type" data-tsd-kind="Interface">ResponseContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/runtime.ts#L42">src/generated/runtime.ts:42</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
<ul class="tsd-type-parameters">
|
|
<li>
|
|
<h4>T<span class="tsd-signature-symbol">: </span><a href="generated_runtime.baseapi.html" class="tsd-signature-type" data-tsd-kind="Class">BaseAPI</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>postMiddlewares: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated_runtime.responsecontext.html" class="tsd-signature-type" data-tsd-kind="Interface">ResponseContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
|
|
<a name="withpremiddleware" class="tsd-anchor"></a>
|
|
<h3>with<wbr>Pre<wbr>Middleware</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
|
|
<li class="tsd-signature tsd-kind-icon">with<wbr>Pre<wbr>Middleware<T><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>preMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated_runtime.requestcontext.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/generated_runtime.fetchparams.html" class="tsd-signature-type" data-tsd-kind="Interface">FetchParams</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/runtime.ts#L37">src/generated/runtime.ts:37</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
<ul class="tsd-type-parameters">
|
|
<li>
|
|
<h4>T<span class="tsd-signature-symbol">: </span><a href="generated_runtime.baseapi.html" class="tsd-signature-type" data-tsd-kind="Class">BaseAPI</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>preMiddlewares: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated_runtime.requestcontext.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/generated_runtime.fetchparams.html" class="tsd-signature-type" data-tsd-kind="Interface">FetchParams</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
|
</li>
|
|
</ul>
|
|
</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">Modules</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="../modules/generated.html">generated</a>
|
|
</li>
|
|
<li class="current tsd-kind-module">
|
|
<a href="../modules/generated_runtime.html">generated/runtime</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="../modules/socket_io.html">socket-<wbr>io</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="../modules/ws.html">ws</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-class tsd-parent-kind-module">
|
|
<a href="generated_runtime.baseapi.html" class="tsd-kind-icon">BaseAPI</a>
|
|
<ul>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
<a href="generated_runtime.baseapi.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
|
|
<a href="generated_runtime.baseapi.html#configuration" class="tsd-kind-icon">configuration</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a href="generated_runtime.baseapi.html#middleware" class="tsd-kind-icon">middleware</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private">
|
|
<a href="generated_runtime.baseapi.html#clone" class="tsd-kind-icon">clone</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<a href="generated_runtime.baseapi.html#createfetchparams" class="tsd-kind-icon">create<wbr>Fetch<wbr>Params</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<a href="generated_runtime.baseapi.html#fetchapi" class="tsd-kind-icon">fetch<wbr>Api</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<a href="generated_runtime.baseapi.html#request" class="tsd-kind-icon">request</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
|
|
<a href="generated_runtime.baseapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
|
|
<a href="generated_runtime.baseapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
|
|
<a href="generated_runtime.baseapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="generated_runtime.blobapiresponse.html" class="tsd-kind-icon">Blob<wbr>Api<wbr>Response</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="generated_runtime.configuration.html" class="tsd-kind-icon">Configuration</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter">
|
|
<a href="generated_runtime.jsonapiresponse.html" class="tsd-kind-icon">JSONApi<wbr>Response</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="generated_runtime.requirederror.html" class="tsd-kind-icon">Required<wbr>Error</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="generated_runtime.textapiresponse.html" class="tsd-kind-icon">Text<wbr>Api<wbr>Response</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="generated_runtime.voidapiresponse.html" class="tsd-kind-icon">Void<wbr>Api<wbr>Response</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
|
|
<a href="../interfaces/generated_runtime.apiresponse.html" class="tsd-kind-icon">Api<wbr>Response</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/generated_runtime.configurationparameters.html" class="tsd-kind-icon">Configuration<wbr>Parameters</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/generated_runtime.consume.html" class="tsd-kind-icon">Consume</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/generated_runtime.fetchparams.html" class="tsd-kind-icon">Fetch<wbr>Params</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/generated_runtime.middleware.html" class="tsd-kind-icon">Middleware</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/generated_runtime.requestcontext.html" class="tsd-kind-icon">Request<wbr>Context</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/generated_runtime.requestopts.html" class="tsd-kind-icon">Request<wbr>Opts</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/generated_runtime.responsecontext.html" class="tsd-kind-icon">Response<wbr>Context</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
|
|
<a href="../interfaces/generated_runtime.responsetransformer.html" class="tsd-kind-icon">Response<wbr>Transformer</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="../modules/generated_runtime.html#fetchapi" class="tsd-kind-icon">FetchAPI</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="../modules/generated_runtime.html#httpbody" class="tsd-kind-icon">HTTPBody</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="../modules/generated_runtime.html#httpheaders" class="tsd-kind-icon">HTTPHeaders</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="../modules/generated_runtime.html#httpmethod" class="tsd-kind-icon">HTTPMethod</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="../modules/generated_runtime.html#httpquery" class="tsd-kind-icon">HTTPQuery</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="../modules/generated_runtime.html#json" class="tsd-kind-icon">Json</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="../modules/generated_runtime.html#modelpropertynaming" class="tsd-kind-icon">Model<wbr>Property<wbr>Naming</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="../modules/generated_runtime.html#base_path" class="tsd-kind-icon">BASE_<wbr>PATH</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="../modules/generated_runtime.html#collection_formats" class="tsd-kind-icon">COLLECTION_<wbr>FORMATS</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="../modules/generated_runtime.html#canconsumeform" class="tsd-kind-icon">can<wbr>Consume<wbr>Form</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="../modules/generated_runtime.html#exists" class="tsd-kind-icon">exists</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="../modules/generated_runtime.html#mapvalues" class="tsd-kind-icon">map<wbr>Values</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="../modules/generated_runtime.html#querystring" class="tsd-kind-icon">querystring</a>
|
|
</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-variable"><span class="tsd-kind-icon">Variable</span></li>
|
|
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
|
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected 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-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
|
</ul>
|
|
</div>
|
|
</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/js/main.js"></script>
|
|
</body>
|
|
</html> |