mirror of
https://github.com/alexgo-io/stacks-blockchain-api.git
synced 2026-05-11 02:11:28 +08:00
652 lines
43 KiB
HTML
652 lines
43 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>InfoApi | @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">
|
|
</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>
|
|
<input type="checkbox" id="tsd-filter-only-exported" />
|
|
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../globals.html">Globals</a>
|
|
</li>
|
|
<li>
|
|
<a href="infoapi.html">InfoApi</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class InfoApi</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<a href="baseapi.html" class="tsd-signature-type">BaseAPI</a>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">InfoApi</span>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel">
|
|
<h3>Implements</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li><a href="../interfaces/infoapiinterface.html" class="tsd-signature-type">InfoApiInterface</a></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 tsd-is-inherited">
|
|
<h3>Constructors</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="infoapi.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section tsd-is-inherited tsd-is-private-protected">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="infoapi.html#configuration" class="tsd-kind-icon">configuration</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"><a href="infoapi.html#getcoreapiinfo" class="tsd-kind-icon">get<wbr>Core<wbr>Api<wbr>Info</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="infoapi.html#getcoreapiinforaw" class="tsd-kind-icon">get<wbr>Core<wbr>Api<wbr>Info<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="infoapi.html#getnetworkblocktimebynetwork" class="tsd-kind-icon">get<wbr>Network<wbr>Block<wbr>Time<wbr>ByNetwork</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="infoapi.html#getnetworkblocktimebynetworkraw" class="tsd-kind-icon">get<wbr>Network<wbr>Block<wbr>Time<wbr>ByNetwork<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="infoapi.html#getnetworkblocktimes" class="tsd-kind-icon">get<wbr>Network<wbr>Block<wbr>Times</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="infoapi.html#getnetworkblocktimesraw" class="tsd-kind-icon">get<wbr>Network<wbr>Block<wbr>Times<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="infoapi.html#getpoxinfo" class="tsd-kind-icon">get<wbr>Pox<wbr>Info</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="infoapi.html#getpoxinforaw" class="tsd-kind-icon">get<wbr>Pox<wbr>Info<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="infoapi.html#getstatus" class="tsd-kind-icon">get<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="infoapi.html#getstatusraw" class="tsd-kind-icon">get<wbr>Status<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="infoapi.html#request" class="tsd-kind-icon">request</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="infoapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="infoapi.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 tsd-is-inherited"><a href="infoapi.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 tsd-is-inherited">
|
|
<h2>Constructors</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|
<h3>constructor</h3>
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Info<wbr>Api<span class="tsd-signature-symbol">(</span>configuration<span class="tsd-signature-symbol">?: </span><a href="configuration.html" class="tsd-signature-type">Configuration</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="infoapi.html" class="tsd-signature-type">InfoApi</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#constructor">constructor</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L25">client/src/generated/runtime.ts:25</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> configuration: <a href="configuration.html" class="tsd-signature-type">Configuration</a><span class="tsd-signature-symbol"> = new Configuration()</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="infoapi.html" class="tsd-signature-type">InfoApi</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-private-protected">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited 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="configuration.html" class="tsd-signature-type">Configuration</a></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#configuration">configuration</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L27">client/src/generated/runtime.ts:27</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">
|
|
<a name="getcoreapiinfo" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Core<wbr>Api<wbr>Info</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Core<wbr>Api<wbr>Info<span class="tsd-signature-symbol">(</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><a href="../interfaces/corenodeinforesponse.html" class="tsd-signature-type">CoreNodeInfoResponse</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Implementation of <a href="../interfaces/infoapiinterface.html">InfoApiInterface</a>.<a href="../interfaces/infoapiinterface.html#getcoreapiinfo">getCoreApiInfo</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/InfoApi.ts#L147">client/src/generated/apis/InfoApi.ts:147</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Get Core API information
|
|
Get Core API info</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/corenodeinforesponse.html" class="tsd-signature-type">CoreNodeInfoResponse</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getcoreapiinforaw" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Core<wbr>Api<wbr>Info<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Core<wbr>Api<wbr>Info<wbr>Raw<span class="tsd-signature-symbol">(</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><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/corenodeinforesponse.html" class="tsd-signature-type">CoreNodeInfoResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Implementation of <a href="../interfaces/infoapiinterface.html">InfoApiInterface</a>.<a href="../interfaces/infoapiinterface.html#getcoreapiinforaw">getCoreApiInfoRaw</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/InfoApi.ts#L128">client/src/generated/apis/InfoApi.ts:128</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Get Core API information
|
|
Get Core API info</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/corenodeinforesponse.html" class="tsd-signature-type">CoreNodeInfoResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getnetworkblocktimebynetwork" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Network<wbr>Block<wbr>Time<wbr>ByNetwork</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Network<wbr>Block<wbr>Time<wbr>ByNetwork<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getnetworkblocktimebynetworkrequest.html" class="tsd-signature-type">GetNetworkBlockTimeByNetworkRequest</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><a href="../interfaces/networkblocktimeresponse.html" class="tsd-signature-type">NetworkBlockTimeResponse</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Implementation of <a href="../interfaces/infoapiinterface.html">InfoApiInterface</a>.<a href="../interfaces/infoapiinterface.html#getnetworkblocktimebynetwork">getNetworkBlockTimeByNetwork</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/InfoApi.ts#L177">client/src/generated/apis/InfoApi.ts:177</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Get a given network's target block time</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/getnetworkblocktimebynetworkrequest.html" class="tsd-signature-type">GetNetworkBlockTimeByNetworkRequest</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/networkblocktimeresponse.html" class="tsd-signature-type">NetworkBlockTimeResponse</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getnetworkblocktimebynetworkraw" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Network<wbr>Block<wbr>Time<wbr>ByNetwork<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Network<wbr>Block<wbr>Time<wbr>ByNetwork<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getnetworkblocktimebynetworkrequest.html" class="tsd-signature-type">GetNetworkBlockTimeByNetworkRequest</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><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/networkblocktimeresponse.html" class="tsd-signature-type">NetworkBlockTimeResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Implementation of <a href="../interfaces/infoapiinterface.html">InfoApiInterface</a>.<a href="../interfaces/infoapiinterface.html#getnetworkblocktimebynetworkraw">getNetworkBlockTimeByNetworkRaw</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/InfoApi.ts#L155">client/src/generated/apis/InfoApi.ts:155</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Get a given network's target block time</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/getnetworkblocktimebynetworkrequest.html" class="tsd-signature-type">GetNetworkBlockTimeByNetworkRequest</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/networkblocktimeresponse.html" class="tsd-signature-type">NetworkBlockTimeResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getnetworkblocktimes" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Network<wbr>Block<wbr>Times</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Network<wbr>Block<wbr>Times<span class="tsd-signature-symbol">(</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><a href="../interfaces/networkblocktimesresponse.html" class="tsd-signature-type">NetworkBlockTimesResponse</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Implementation of <a href="../interfaces/infoapiinterface.html">InfoApiInterface</a>.<a href="../interfaces/infoapiinterface.html#getnetworkblocktimes">getNetworkBlockTimes</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/InfoApi.ts#L203">client/src/generated/apis/InfoApi.ts:203</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Get the network target block time</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/networkblocktimesresponse.html" class="tsd-signature-type">NetworkBlockTimesResponse</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getnetworkblocktimesraw" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Network<wbr>Block<wbr>Times<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Network<wbr>Block<wbr>Times<wbr>Raw<span class="tsd-signature-symbol">(</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><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/networkblocktimesresponse.html" class="tsd-signature-type">NetworkBlockTimesResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Implementation of <a href="../interfaces/infoapiinterface.html">InfoApiInterface</a>.<a href="../interfaces/infoapiinterface.html#getnetworkblocktimesraw">getNetworkBlockTimesRaw</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/InfoApi.ts#L185">client/src/generated/apis/InfoApi.ts:185</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Get the network target block time</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/networkblocktimesresponse.html" class="tsd-signature-type">NetworkBlockTimesResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getpoxinfo" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Pox<wbr>Info</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Pox<wbr>Info<span class="tsd-signature-symbol">(</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><a href="../interfaces/corenodepoxresponse.html" class="tsd-signature-type">CoreNodePoxResponse</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Implementation of <a href="../interfaces/infoapiinterface.html">InfoApiInterface</a>.<a href="../interfaces/infoapiinterface.html#getpoxinfo">getPoxInfo</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/InfoApi.ts#L231">client/src/generated/apis/InfoApi.ts:231</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Get Proof of Transfer (PoX) information. Can be used for Stacking.
|
|
Get PoX details</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/corenodepoxresponse.html" class="tsd-signature-type">CoreNodePoxResponse</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getpoxinforaw" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Pox<wbr>Info<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Pox<wbr>Info<wbr>Raw<span class="tsd-signature-symbol">(</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><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/corenodepoxresponse.html" class="tsd-signature-type">CoreNodePoxResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Implementation of <a href="../interfaces/infoapiinterface.html">InfoApiInterface</a>.<a href="../interfaces/infoapiinterface.html#getpoxinforaw">getPoxInfoRaw</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/InfoApi.ts#L212">client/src/generated/apis/InfoApi.ts:212</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Get Proof of Transfer (PoX) information. Can be used for Stacking.
|
|
Get PoX details</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/corenodepoxresponse.html" class="tsd-signature-type">CoreNodePoxResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getstatus" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Status</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Status<span class="tsd-signature-symbol">(</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">void</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Implementation of <a href="../interfaces/infoapiinterface.html">InfoApiInterface</a>.<a href="../interfaces/infoapiinterface.html#getstatus">getStatus</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/InfoApi.ts#L259">client/src/generated/apis/InfoApi.ts:259</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Get Blockchain API status
|
|
Get Blockchain API status</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <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></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getstatusraw" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Status<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Status<wbr>Raw<span class="tsd-signature-symbol">(</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><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Implementation of <a href="../interfaces/infoapiinterface.html">InfoApiInterface</a>.<a href="../interfaces/infoapiinterface.html#getstatusraw">getStatusRaw</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/InfoApi.ts#L240">client/src/generated/apis/InfoApi.ts:240</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Get Blockchain API status
|
|
Get Blockchain API status</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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-inherited 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-inherited 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/requestopts.html" class="tsd-signature-type">RequestOpts</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">Response</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#request">request</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L47">client/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/requestopts.html" class="tsd-signature-type">RequestOpts</a></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 tsd-is-inherited">
|
|
<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 tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">with<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>middlewares<span class="tsd-signature-symbol">: </span><a href="../interfaces/middleware.html" class="tsd-signature-type">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">
|
|
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withmiddleware">withMiddleware</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L31">client/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="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>middlewares: <a href="../interfaces/middleware.html" class="tsd-signature-type">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 tsd-is-inherited">
|
|
<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 tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">with<wbr>Post<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>postMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"post"</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">
|
|
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withpostmiddleware">withPostMiddleware</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L42">client/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="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>postMiddlewares: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"post"</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 tsd-is-inherited">
|
|
<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 tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">with<wbr>Pre<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>preMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"pre"</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">
|
|
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withpremiddleware">withPreMiddleware</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L37">client/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="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>preMiddlewares: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"pre"</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="globals ">
|
|
<a href="../globals.html"><em>Globals</em></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">
|
|
<a href="infoapi.html" class="tsd-kind-icon">Info<wbr>Api</a>
|
|
<ul>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="infoapi.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
|
<a href="infoapi.html#configuration" class="tsd-kind-icon">configuration</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="infoapi.html#getcoreapiinfo" class="tsd-kind-icon">get<wbr>Core<wbr>Api<wbr>Info</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="infoapi.html#getcoreapiinforaw" class="tsd-kind-icon">get<wbr>Core<wbr>Api<wbr>Info<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="infoapi.html#getnetworkblocktimebynetwork" class="tsd-kind-icon">get<wbr>Network<wbr>Block<wbr>Time<wbr>ByNetwork</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="infoapi.html#getnetworkblocktimebynetworkraw" class="tsd-kind-icon">get<wbr>Network<wbr>Block<wbr>Time<wbr>ByNetwork<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="infoapi.html#getnetworkblocktimes" class="tsd-kind-icon">get<wbr>Network<wbr>Block<wbr>Times</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="infoapi.html#getnetworkblocktimesraw" class="tsd-kind-icon">get<wbr>Network<wbr>Block<wbr>Times<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="infoapi.html#getpoxinfo" class="tsd-kind-icon">get<wbr>Pox<wbr>Info</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="infoapi.html#getpoxinforaw" class="tsd-kind-icon">get<wbr>Pox<wbr>Info<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="infoapi.html#getstatus" class="tsd-kind-icon">get<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="infoapi.html#getstatusraw" class="tsd-kind-icon">get<wbr>Status<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
|
<a href="infoapi.html#request" class="tsd-kind-icon">request</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
|
<a href="infoapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
|
<a href="infoapi.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 tsd-is-inherited">
|
|
<a href="infoapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
</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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><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>
|
|
</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-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>
|
|
</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> |