mirror of
https://github.com/alexgo-io/stacks.js.git
synced 2026-01-12 22:52:34 +08:00
363 lines
24 KiB
HTML
Vendored
363 lines
24 KiB
HTML
Vendored
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>storage | Stacks.js 1.4.1 Library Reference</title>
|
|
<meta name="description" content="Documentation for Stacks.js 1.4.1 Library Reference">
|
|
<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.js 1.4.1 Library Reference</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.js 1.4.1 Library Reference</a>
|
|
</li>
|
|
<li>
|
|
<a href="storage.html">storage</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Module storage</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">
|
|
<a href="#stacksstorage" id="stacksstorage" style="color: inherit; text-decoration: none;">
|
|
<h1>@stacks/storage</h1>
|
|
</a>
|
|
<p>Store and fetch files with Gaia, the decentralized storage system.</p>
|
|
<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
|
|
<h2>Installation</h2>
|
|
</a>
|
|
<pre><code><span style="color: #001080">npm</span><span style="color: #000000"> </span><span style="color: #001080">install</span><span style="color: #000000"> @</span><span style="color: #001080">stacks</span><span style="color: #000000">/</span><span style="color: #001080">storage</span>
|
|
</code></pre>
|
|
<a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
|
|
<h2>Usage</h2>
|
|
</a>
|
|
<a href="#initiating-a-storage-client" id="initiating-a-storage-client" style="color: inherit; text-decoration: none;">
|
|
<h3>Initiating a storage client</h3>
|
|
</a>
|
|
<pre><code class="language-typescript"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">UserSession</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">'@stacks/auth'</span><span style="color: #000000">;</span>
|
|
<span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">Storage</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">'@stacks/storage'</span><span style="color: #000000">;</span>
|
|
|
|
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">appConfig</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">AppConfig</span><span style="color: #000000">();</span>
|
|
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">userSession</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">UserSession</span><span style="color: #000000">({ </span><span style="color: #001080">appConfig</span><span style="color: #000000"> });</span>
|
|
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">storage</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">Storage</span><span style="color: #000000">({ </span><span style="color: #001080">userSession</span><span style="color: #000000"> });</span>
|
|
</code></pre>
|
|
<p>Note that you can also use an existing <code>userSession</code> object created during the authentication process.</p>
|
|
<a href="#put-file" id="put-file" style="color: inherit; text-decoration: none;">
|
|
<h3>Put file</h3>
|
|
</a>
|
|
<pre><code class="language-typescript"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">myData</span><span style="color: #000000"> = </span><span style="color: #267F99">JSON</span><span style="color: #000000">.</span><span style="color: #795E26">stringify</span><span style="color: #000000">({</span>
|
|
<span style="color: #000000"> </span><span style="color: #001080">hello:</span><span style="color: #000000"> </span><span style="color: #A31515">"world"</span><span style="color: #000000">,</span>
|
|
<span style="color: #000000"> </span><span style="color: #001080">num:</span><span style="color: #000000"> </span><span style="color: #098658">1</span>
|
|
<span style="color: #000000">});</span>
|
|
|
|
<span style="color: #001080">storage</span><span style="color: #000000">.</span><span style="color: #795E26">putFile</span><span style="color: #000000">(</span><span style="color: #A31515">'my_data.json'</span><span style="color: #000000">, </span><span style="color: #001080">myData</span><span style="color: #000000">));</span>
|
|
</code></pre>
|
|
<p>Store data at a different path</p>
|
|
<pre><code class="language-typescript"><span style="color: #001080">storage</span><span style="color: #000000">.</span><span style="color: #795E26">putFile</span><span style="color: #000000">(</span><span style="color: #A31515">'path/my_data.json'</span><span style="color: #000000">, </span><span style="color: #001080">myData</span><span style="color: #000000">));</span>
|
|
</code></pre>
|
|
<p>Put file with options</p>
|
|
<pre><code class="language-typescript"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">putFileOptions</span><span style="color: #000000"> = {</span>
|
|
<span style="color: #000000"> </span><span style="color: #008000">// override the default content type</span>
|
|
<span style="color: #000000"> </span><span style="color: #001080">contentType:</span><span style="color: #000000"> </span><span style="color: #A31515">'application/json'</span><span style="color: #000000">, </span>
|
|
<span style="color: #000000"> </span><span style="color: #008000">// override encrypting data by default</span>
|
|
<span style="color: #000000"> </span><span style="color: #008000">// you can also set encrypt to a private key to specify a custom encryption key</span>
|
|
<span style="color: #000000"> </span><span style="color: #001080">encrypt:</span><span style="color: #000000"> </span><span style="color: #0000FF">false</span><span style="color: #000000">, </span>
|
|
<span style="color: #000000"> </span><span style="color: #008000">// ignore automatic conflict prevention using etags</span>
|
|
<span style="color: #000000"> </span><span style="color: #001080">dangerouslyIgnoreEtag:</span><span style="color: #000000"> </span><span style="color: #0000FF">true</span>
|
|
<span style="color: #000000">}</span>
|
|
|
|
<span style="color: #001080">storage</span><span style="color: #000000">.</span><span style="color: #795E26">putFile</span><span style="color: #000000">(</span><span style="color: #A31515">'my_data.json'</span><span style="color: #000000">, </span><span style="color: #001080">myData</span><span style="color: #000000">, </span><span style="color: #001080">putFileOptions</span><span style="color: #000000">));</span>
|
|
</code></pre>
|
|
<a href="#get-file" id="get-file" style="color: inherit; text-decoration: none;">
|
|
<h3>Get file</h3>
|
|
</a>
|
|
<pre><code class="language-typescript"><span style="color: #001080">storage</span><span style="color: #000000">.</span><span style="color: #795E26">getFile</span><span style="color: #000000">(</span><span style="color: #A31515">'my_data.json'</span><span style="color: #000000">).</span><span style="color: #795E26">then</span><span style="color: #000000">((</span><span style="color: #001080">fileContent</span><span style="color: #000000">) </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
|
|
<span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">fileContent</span><span style="color: #000000">);</span>
|
|
<span style="color: #000000">});</span>
|
|
</code></pre>
|
|
<p>Get file with options</p>
|
|
<pre><code class="language-typescript"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">getFileOptions</span><span style="color: #000000"> = {</span>
|
|
<span style="color: #000000"> </span><span style="color: #001080">decrypt:</span><span style="color: #000000"> </span><span style="color: #0000FF">false</span><span style="color: #000000">,</span>
|
|
<span style="color: #000000"> </span><span style="color: #008000">// by default files stored are signed and can be verified for authenticity</span>
|
|
<span style="color: #000000"> </span><span style="color: #001080">verify:</span><span style="color: #000000"> </span><span style="color: #0000FF">false</span>
|
|
<span style="color: #000000">}</span>
|
|
|
|
<span style="color: #001080">storage</span><span style="color: #000000">.</span><span style="color: #795E26">getFile</span><span style="color: #000000">(</span><span style="color: #A31515">'my_data.json'</span><span style="color: #000000">, </span><span style="color: #001080">getFileOptions</span><span style="color: #000000">).</span><span style="color: #795E26">then</span><span style="color: #000000">((</span><span style="color: #001080">fileContent</span><span style="color: #000000">) </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
|
|
<span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">fileContent</span><span style="color: #000000">);</span>
|
|
<span style="color: #000000">});</span>
|
|
</code></pre>
|
|
<a href="#delete-file" id="delete-file" style="color: inherit; text-decoration: none;">
|
|
<h3>Delete file</h3>
|
|
</a>
|
|
<pre><code class="language-typescript"><span style="color: #001080">storage</span><span style="color: #000000">.</span><span style="color: #795E26">deleteFile</span><span style="color: #000000">(</span><span style="color: #A31515">'my_data.json'</span><span style="color: #000000">);</span>
|
|
</code></pre>
|
|
<p>Delete the file and the corresponding signature file if signed</p>
|
|
<pre><code class="language-typescript"><span style="color: #001080">storage</span><span style="color: #000000">.</span><span style="color: #795E26">deleteFile</span><span style="color: #000000">(</span><span style="color: #A31515">'my_data.json'</span><span style="color: #000000">, { </span><span style="color: #001080">wasSigned:</span><span style="color: #000000"> </span><span style="color: #0000FF">true</span><span style="color: #000000"> });</span>
|
|
</code></pre>
|
|
<a href="#list-file" id="list-file" style="color: inherit; text-decoration: none;">
|
|
<h3>List file</h3>
|
|
</a>
|
|
<p>List all files in the user's Gaia hub</p>
|
|
<pre><code class="language-typescript"><span style="color: #001080">storage</span><span style="color: #000000">.</span><span style="color: #795E26">listFiles</span><span style="color: #000000">((</span><span style="color: #001080">filename</span><span style="color: #000000">) </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
|
|
<span style="color: #000000"> </span><span style="color: #AF00DB">if</span><span style="color: #000000"> (</span><span style="color: #001080">filename</span><span style="color: #000000"> === </span><span style="color: #A31515">'my_data.json'</span><span style="color: #000000">) {</span>
|
|
<span style="color: #000000"> </span><span style="color: #AF00DB">return</span><span style="color: #000000"> </span><span style="color: #001080">storage</span><span style="color: #000000">.</span><span style="color: #795E26">getFile</span><span style="color: #000000">(</span><span style="color: #001080">filename</span><span style="color: #000000">).</span><span style="color: #795E26">then</span><span style="color: #000000">((</span><span style="color: #001080">fileContent</span><span style="color: #000000">) </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
|
|
<span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">fileContent</span><span style="color: #000000">);</span>
|
|
<span style="color: #000000"> </span><span style="color: #008000">// return false to stop iterating through files</span>
|
|
<span style="color: #000000"> </span><span style="color: #AF00DB">return</span><span style="color: #000000"> </span><span style="color: #0000FF">false</span><span style="color: #000000">;</span>
|
|
<span style="color: #000000"> })</span>
|
|
<span style="color: #000000"> } </span><span style="color: #AF00DB">else</span><span style="color: #000000"> {</span>
|
|
<span style="color: #000000"> </span><span style="color: #008000">// return true to continue iterating</span>
|
|
<span style="color: #000000"> </span><span style="color: #AF00DB">return</span><span style="color: #000000"> </span><span style="color: #0000FF">true</span><span style="color: #000000">;</span>
|
|
<span style="color: #000000"> }</span>
|
|
<span style="color: #000000">});</span>
|
|
</code></pre>
|
|
</div>
|
|
</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>Classes</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/storage.storage-1.html" class="tsd-kind-icon">Storage</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Interfaces</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/storage.gaiahubconfig.html" class="tsd-kind-icon">Gaia<wbr>Hub<wbr>Config</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/storage.getfileoptions.html" class="tsd-kind-icon">Get<wbr>File<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/storage.getfileurloptions.html" class="tsd-kind-icon">Get<wbr>File<wbr>Url<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/storage.putfileoptions.html" class="tsd-kind-icon">Put<wbr>File<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/storage.storageoptions.html" class="tsd-kind-icon">Storage<wbr>Options</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Functions</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="storage.html#deletefromgaiahub" class="tsd-kind-icon">delete<wbr>From<wbr>Gaia<wbr>Hub</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Functions</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="deletefromgaiahub" class="tsd-anchor"></a>
|
|
<h3>delete<wbr>From<wbr>Gaia<wbr>Hub</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">delete<wbr>From<wbr>Gaia<wbr>Hub<span class="tsd-signature-symbol">(</span>filename<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, hubConfig<span class="tsd-signature-symbol">: </span><a href="../interfaces/storage.gaiahubconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">GaiaHubConfig</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></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/storage/src/hub.ts#L105">packages/storage/src/hub.ts:105</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>filename: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>hubConfig: <a href="../interfaces/storage.gaiahubconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">GaiaHubConfig</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
</div>
|
|
</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">void</span><span class="tsd-signature-symbol">></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="auth.html">auth</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="bns.html">bns</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="cli.html">cli</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="common.html">common</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="encryption.html">encryption</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="keychain.html">keychain</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="network.html">network</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="profile.html">profile</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="stacking.html">stacking</a>
|
|
</li>
|
|
<li class="current tsd-kind-module">
|
|
<a href="storage.html">storage</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="transactions.html">transactions</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
<li class=" tsd-kind-module">
|
|
<a href="auth.html" class="tsd-kind-icon">auth</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="bns.html" class="tsd-kind-icon">bns</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="cli.html" class="tsd-kind-icon">cli</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="common.html" class="tsd-kind-icon">common</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="encryption.html" class="tsd-kind-icon">encryption</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="keychain.html" class="tsd-kind-icon">keychain</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="network.html" class="tsd-kind-icon">network</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="profile.html" class="tsd-kind-icon">profile</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="stacking.html" class="tsd-kind-icon">stacking</a>
|
|
</li>
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-module">
|
|
<a href="storage.html" class="tsd-kind-icon">storage</a>
|
|
<ul>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="../classes/storage.storage-1.html" class="tsd-kind-icon">Storage</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/storage.gaiahubconfig.html" class="tsd-kind-icon">Gaia<wbr>Hub<wbr>Config</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/storage.getfileoptions.html" class="tsd-kind-icon">Get<wbr>File<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/storage.getfileurloptions.html" class="tsd-kind-icon">Get<wbr>File<wbr>Url<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/storage.putfileoptions.html" class="tsd-kind-icon">Put<wbr>File<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/storage.storageoptions.html" class="tsd-kind-icon">Storage<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="storage.html#deletefromgaiahub" class="tsd-kind-icon">delete<wbr>From<wbr>Gaia<wbr>Hub</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
<li class=" tsd-kind-module">
|
|
<a href="transactions.html" class="tsd-kind-icon">transactions</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-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
|
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
|
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</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-class"><span class="tsd-kind-icon">Class</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> |