kylefang/stacks-blockchain-api
1
0
Fork 0
mirror of https://github.com/alexgo-io/stacks-blockchain-api.git synced 2026-01-12 22:43:34 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
stacks-blockchain-api/client/classes/socket_io.stacksapisocketclient.html

714 lines
43 KiB
HTML
Raw Permalink Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>StacksApiSocketClient | @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/socket_io.html">socket-io</a>
</li>
<li>
<a href="socket_io.stacksapisocketclient.html">StacksApiSocketClient</a>
</li>
</ul>
<h1>Class StacksApiSocketClient</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>
<span class="target">StacksApiSocketClient</span>
</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="socket_io.stacksapisocketclient.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="socket_io.stacksapisocketclient.html#socket" class="tsd-kind-icon">socket</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="socket_io.stacksapisocketclient.html#handlesubscription" class="tsd-kind-icon">handle<wbr>Subscription</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="socket_io.stacksapisocketclient.html#logevents" class="tsd-kind-icon">log<wbr>Events</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="socket_io.stacksapisocketclient.html#subscribeaddressstxbalance" class="tsd-kind-icon">subscribe<wbr>Address<wbr>Stx<wbr>Balance</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="socket_io.stacksapisocketclient.html#subscribeaddresstransactions" class="tsd-kind-icon">subscribe<wbr>Address<wbr>Transactions</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="socket_io.stacksapisocketclient.html#subscribeblocks" class="tsd-kind-icon">subscribe<wbr>Blocks</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="socket_io.stacksapisocketclient.html#subscribemempool" class="tsd-kind-icon">subscribe<wbr>Mempool</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="socket_io.stacksapisocketclient.html#subscribemicroblocks" class="tsd-kind-icon">subscribe<wbr>Microblocks</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="socket_io.stacksapisocketclient.html#subscribetransaction" class="tsd-kind-icon">subscribe<wbr>Transaction</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="socket_io.stacksapisocketclient.html#unsubscribeaddressstxbalance" class="tsd-kind-icon">unsubscribe<wbr>Address<wbr>Stx<wbr>Balance</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="socket_io.stacksapisocketclient.html#unsubscribeaddresstransactions" class="tsd-kind-icon">unsubscribe<wbr>Address<wbr>Transactions</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="socket_io.stacksapisocketclient.html#unsubscribeblocks" class="tsd-kind-icon">unsubscribe<wbr>Blocks</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="socket_io.stacksapisocketclient.html#unsubscribemempool" class="tsd-kind-icon">unsubscribe<wbr>Mempool</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="socket_io.stacksapisocketclient.html#unsubscribemicroblocks" class="tsd-kind-icon">unsubscribe<wbr>Microblocks</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="socket_io.stacksapisocketclient.html#unsubscribetransaction" class="tsd-kind-icon">unsubscribe<wbr>Transaction</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="socket_io.stacksapisocketclient.html#connect" class="tsd-kind-icon">connect</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>Stacks<wbr>Api<wbr>Socket<wbr>Client<span class="tsd-signature-symbol">(</span>socket<span class="tsd-signature-symbol">: </span><a href="../modules/socket_io.html#stacksapisocket" class="tsd-signature-type" data-tsd-kind="Type alias">StacksApiSocket</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="socket_io.stacksapisocketclient.html" class="tsd-signature-type" data-tsd-kind="Class">StacksApiSocketClient</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/socket-io/index.ts#L33">src/socket-io/index.ts:33</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>socket: <a href="../modules/socket_io.html#stacksapisocket" class="tsd-signature-type" data-tsd-kind="Type alias">StacksApiSocket</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="socket_io.stacksapisocketclient.html" class="tsd-signature-type" data-tsd-kind="Class">StacksApiSocketClient</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="socket" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> socket</h3>
<div class="tsd-signature tsd-kind-icon">socket<span class="tsd-signature-symbol">:</span> <a href="../modules/socket_io.html#stacksapisocket" class="tsd-signature-type" data-tsd-kind="Type alias">StacksApiSocket</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/socket-io/index.ts#L33">src/socket-io/index.ts:33</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="handlesubscription" class="tsd-anchor"></a>
<h3>handle<wbr>Subscription</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">handle<wbr>Subscription<span class="tsd-signature-symbol">(</span>topic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Topic</span>, subscribe<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>unsubscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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">
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/socket-io/index.ts#L52">src/socket-io/index.ts:52</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>topic: <span class="tsd-signature-type">Topic</span></h5>
</li>
<li>
<h5>subscribe: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>unsubscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> }</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>unsubscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="logevents" class="tsd-anchor"></a>
<h3>log<wbr>Events</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">log<wbr>Events<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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/socket-io/index.ts#L123">src/socket-io/index.ts:123</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="subscribeaddressstxbalance" class="tsd-anchor"></a>
<h3>subscribe<wbr>Address<wbr>Stx<wbr>Balance</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">subscribe<wbr>Address<wbr>Stx<wbr>Balance<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>unsubscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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">
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/socket-io/index.ts#L107">src/socket-io/index.ts:107</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>address: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>unsubscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> }</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>unsubscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="subscribeaddresstransactions" class="tsd-anchor"></a>
<h3>subscribe<wbr>Address<wbr>Transactions</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">subscribe<wbr>Address<wbr>Transactions<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>unsubscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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">
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/socket-io/index.ts#L99">src/socket-io/index.ts:99</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>address: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>unsubscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> }</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>unsubscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="subscribeblocks" class="tsd-anchor"></a>
<h3>subscribe<wbr>Blocks</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">subscribe<wbr>Blocks<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>unsubscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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">
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/socket-io/index.ts#L75">src/socket-io/index.ts:75</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>unsubscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> }</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>unsubscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="subscribemempool" class="tsd-anchor"></a>
<h3>subscribe<wbr>Mempool</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">subscribe<wbr>Mempool<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>unsubscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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">
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/socket-io/index.ts#L91">src/socket-io/index.ts:91</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>unsubscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> }</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>unsubscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="subscribemicroblocks" class="tsd-anchor"></a>
<h3>subscribe<wbr>Microblocks</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">subscribe<wbr>Microblocks<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>unsubscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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">
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/socket-io/index.ts#L83">src/socket-io/index.ts:83</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>unsubscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> }</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>unsubscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="subscribetransaction" class="tsd-anchor"></a>
<h3>subscribe<wbr>Transaction</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">subscribe<wbr>Transaction<span class="tsd-signature-symbol">(</span>txId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>unsubscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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">
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/socket-io/index.ts#L115">src/socket-io/index.ts:115</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>txId: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>unsubscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> }</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>unsubscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="unsubscribeaddressstxbalance" class="tsd-anchor"></a>
<h3>unsubscribe<wbr>Address<wbr>Stx<wbr>Balance</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">unsubscribe<wbr>Address<wbr>Stx<wbr>Balance<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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/socket-io/index.ts#L111">src/socket-io/index.ts:111</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>address: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="unsubscribeaddresstransactions" class="tsd-anchor"></a>
<h3>unsubscribe<wbr>Address<wbr>Transactions</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">unsubscribe<wbr>Address<wbr>Transactions<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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/socket-io/index.ts#L103">src/socket-io/index.ts:103</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>address: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="unsubscribeblocks" class="tsd-anchor"></a>
<h3>unsubscribe<wbr>Blocks</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">unsubscribe<wbr>Blocks<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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/socket-io/index.ts#L79">src/socket-io/index.ts:79</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="unsubscribemempool" class="tsd-anchor"></a>
<h3>unsubscribe<wbr>Mempool</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">unsubscribe<wbr>Mempool<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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/socket-io/index.ts#L95">src/socket-io/index.ts:95</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="unsubscribemicroblocks" class="tsd-anchor"></a>
<h3>unsubscribe<wbr>Microblocks</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">unsubscribe<wbr>Microblocks<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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/socket-io/index.ts#L87">src/socket-io/index.ts:87</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="unsubscribetransaction" class="tsd-anchor"></a>
<h3>unsubscribe<wbr>Transaction</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">unsubscribe<wbr>Transaction<span class="tsd-signature-symbol">(</span>txId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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/socket-io/index.ts#L119">src/socket-io/index.ts:119</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>txId: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="connect" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> connect</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">connect<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">?: </span><a href="../interfaces/socket_io.stacksapisocketconnectionoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">StacksApiSocketConnectionOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="socket_io.stacksapisocketclient.html" class="tsd-signature-type" data-tsd-kind="Class">StacksApiSocketClient</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/socket-io/index.ts#L39">src/socket-io/index.ts:39</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <a href="../interfaces/socket_io.stacksapisocketconnectionoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">StacksApiSocketConnectionOptions</a><span class="tsd-signature-symbol"> = {}</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="socket_io.stacksapisocketclient.html" class="tsd-signature-type" data-tsd-kind="Class">StacksApiSocketClient</a></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=" tsd-kind-module">
<a href="../modules/generated_runtime.html">generated/runtime</a>
</li>
<li class="current 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="socket_io.stacksapisocketclient.html" class="tsd-kind-icon">Stacks<wbr>Api<wbr>Socket<wbr>Client</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="socket_io.stacksapisocketclient.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="socket_io.stacksapisocketclient.html#socket" class="tsd-kind-icon">socket</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="socket_io.stacksapisocketclient.html#handlesubscription" class="tsd-kind-icon">handle<wbr>Subscription</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="socket_io.stacksapisocketclient.html#logevents" class="tsd-kind-icon">log<wbr>Events</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="socket_io.stacksapisocketclient.html#subscribeaddressstxbalance" class="tsd-kind-icon">subscribe<wbr>Address<wbr>Stx<wbr>Balance</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="socket_io.stacksapisocketclient.html#subscribeaddresstransactions" class="tsd-kind-icon">subscribe<wbr>Address<wbr>Transactions</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="socket_io.stacksapisocketclient.html#subscribeblocks" class="tsd-kind-icon">subscribe<wbr>Blocks</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="socket_io.stacksapisocketclient.html#subscribemempool" class="tsd-kind-icon">subscribe<wbr>Mempool</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="socket_io.stacksapisocketclient.html#subscribemicroblocks" class="tsd-kind-icon">subscribe<wbr>Microblocks</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="socket_io.stacksapisocketclient.html#subscribetransaction" class="tsd-kind-icon">subscribe<wbr>Transaction</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="socket_io.stacksapisocketclient.html#unsubscribeaddressstxbalance" class="tsd-kind-icon">unsubscribe<wbr>Address<wbr>Stx<wbr>Balance</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="socket_io.stacksapisocketclient.html#unsubscribeaddresstransactions" class="tsd-kind-icon">unsubscribe<wbr>Address<wbr>Transactions</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="socket_io.stacksapisocketclient.html#unsubscribeblocks" class="tsd-kind-icon">unsubscribe<wbr>Blocks</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="socket_io.stacksapisocketclient.html#unsubscribemempool" class="tsd-kind-icon">unsubscribe<wbr>Mempool</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="socket_io.stacksapisocketclient.html#unsubscribemicroblocks" class="tsd-kind-icon">unsubscribe<wbr>Microblocks</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="socket_io.stacksapisocketclient.html#unsubscribetransaction" class="tsd-kind-icon">unsubscribe<wbr>Transaction</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="socket_io.stacksapisocketclient.html#connect" class="tsd-kind-icon">connect</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/socket_io.stacksapisocketconnectionoptions.html" class="tsd-kind-icon">Stacks<wbr>Api<wbr>Socket<wbr>Connection<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/socket_io.html#stacksapisocket" class="tsd-kind-icon">Stacks<wbr>Api<wbr>Socket</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-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>
<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-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-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-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
<ul class="tsd-legend">
<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>
Reference in New Issue View Git Blame Copy Permalink