UNPKG

ontology-ts-sdk

Version:

Comprehensive TypeScript library for the Ontology blockchain.

553 lines 29.9 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Account | ontology-ts-sdk</title> <meta name="description" content=""> <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.js" 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">ontology-ts-sdk</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="../modules/_account_.html">&quot;account&quot;</a> </li> <li> <a href="_account_.account.html">Account</a> </li> </ul> <h1>Class Account</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">Account</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>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_account_.account.html#address" class="tsd-kind-icon">address</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_account_.account.html#enc_alg" class="tsd-kind-icon">enc-<wbr>alg</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_account_.account.html#encryptedkey" class="tsd-kind-icon">encrypted<wbr>Key</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_account_.account.html#extra" class="tsd-kind-icon">extra</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_account_.account.html#isdefault" class="tsd-kind-icon">is<wbr>Default</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_account_.account.html#label" class="tsd-kind-icon">label</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_account_.account.html#lock" class="tsd-kind-icon">lock</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_account_.account.html#publickey" class="tsd-kind-icon">public<wbr>Key</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_account_.account.html#salt" class="tsd-kind-icon">salt</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="_account_.account.html#tojson" class="tsd-kind-icon">to<wbr>Json</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_account_.account.html#tojsonobj" class="tsd-kind-icon">to<wbr>Json<wbr>Obj</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_account_.account.html#create" class="tsd-kind-icon">create</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_account_.account.html#importaccount" class="tsd-kind-icon">import<wbr>Account</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_account_.account.html#parsejson" class="tsd-kind-icon">parse<wbr>Json</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_account_.account.html#parsejsonobj" class="tsd-kind-icon">parse<wbr>Json<wbr>Obj</a></li> </ul> </section> </div> </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="address" class="tsd-anchor"></a> <h3>address</h3> <div class="tsd-signature tsd-kind-icon">address<span class="tsd-signature-symbol">:</span> <a href="_crypto_address_.address.html" class="tsd-signature-type">Address</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/account.ts#L127">account.ts:127</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="enc_alg" class="tsd-anchor"></a> <h3>enc-<wbr>alg</h3> <div class="tsd-signature tsd-kind-icon">enc-<wbr>alg<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;&quot;aes-256-gcm&quot;</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/account.ts#L134">account.ts:134</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="encryptedkey" class="tsd-anchor"></a> <h3>encrypted<wbr>Key</h3> <div class="tsd-signature tsd-kind-icon">encrypted<wbr>Key<span class="tsd-signature-symbol">:</span> <a href="_crypto_privatekey_.privatekey.html" class="tsd-signature-type">PrivateKey</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/account.ts#L130">account.ts:130</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="extra" class="tsd-anchor"></a> <h3>extra</h3> <div class="tsd-signature tsd-kind-icon">extra<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/account.ts#L131">account.ts:131</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="isdefault" class="tsd-anchor"></a> <h3>is<wbr>Default</h3> <div class="tsd-signature tsd-kind-icon">is<wbr>Default<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/account.ts#L138">account.ts:138</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="label" class="tsd-anchor"></a> <h3>label</h3> <div class="tsd-signature tsd-kind-icon">label<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/account.ts#L128">account.ts:128</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="lock" class="tsd-anchor"></a> <h3>lock</h3> <div class="tsd-signature tsd-kind-icon">lock<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/account.ts#L129">account.ts:129</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="publickey" class="tsd-anchor"></a> <h3>public<wbr>Key</h3> <div class="tsd-signature tsd-kind-icon">public<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/account.ts#L137">account.ts:137</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="salt" class="tsd-anchor"></a> <h3>salt</h3> <div class="tsd-signature tsd-kind-icon">salt<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/account.ts#L135">account.ts:135</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="tojson" class="tsd-anchor"></a> <h3>to<wbr>Json</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">to<wbr>Json<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/account.ts#L140">account.ts:140</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="tojsonobj" class="tsd-anchor"></a> <h3>to<wbr>Json<wbr>Obj</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">to<wbr>Json<wbr>Obj<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/account.ts#L150">account.ts:150</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Serializes to JSON object.</p> </div> <p>Returned object will not be stringified.</p> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="create" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> create</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>privateKey<span class="tsd-signature-symbol">: </span><a href="_crypto_privatekey_.privatekey.html" class="tsd-signature-type">PrivateKey</a>, password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, label<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_scrypt_.scryptparams.html" class="tsd-signature-type">ScryptParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_account_.account.html" class="tsd-signature-type">Account</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/account.ts#L73">account.ts:73</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Creates Account object encrypting specified private key.</p> </div> <p>The account does not need to be registered on blockchain.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>privateKey: <a href="_crypto_privatekey_.privatekey.html" class="tsd-signature-type">PrivateKey</a></h5> <div class="tsd-comment tsd-typography"> <p>Private key associated with the account</p> </div> </li> <li> <h5>password: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Password use to encrypt the private key</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> label: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Custom label</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> params: <a href="../interfaces/_scrypt_.scryptparams.html" class="tsd-signature-type">ScryptParams</a></h5> <div class="tsd-comment tsd-typography"> <p>Optional scrypt params</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_account_.account.html" class="tsd-signature-type">Account</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="importaccount" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> import<wbr>Account</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">import<wbr>Account<span class="tsd-signature-symbol">(</span>label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, encryptedPrivateKey<span class="tsd-signature-symbol">: </span><a href="_crypto_privatekey_.privatekey.html" class="tsd-signature-type">PrivateKey</a>, password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, address<span class="tsd-signature-symbol">: </span><a href="_crypto_address_.address.html" class="tsd-signature-type">Address</a>, saltBase64<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_scrypt_.scryptparams.html" class="tsd-signature-type">ScryptParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_account_.account.html" class="tsd-signature-type">Account</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/account.ts#L33">account.ts:33</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Import account</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>label: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Account&#39;s label</p> </div> </li> <li> <h5>encryptedPrivateKey: <a href="_crypto_privatekey_.privatekey.html" class="tsd-signature-type">PrivateKey</a></h5> <div class="tsd-comment tsd-typography"> <p>Encrypted private key</p> </div> </li> <li> <h5>password: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>User&#39;s password to decrypt private key</p> </div> </li> <li> <h5>address: <a href="_crypto_address_.address.html" class="tsd-signature-type">Address</a></h5> <div class="tsd-comment tsd-typography"> <p>Account&#39;s address</p> </div> </li> <li> <h5>saltBase64: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Salt to decrypt</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> params: <a href="../interfaces/_scrypt_.scryptparams.html" class="tsd-signature-type">ScryptParams</a></h5> <div class="tsd-comment tsd-typography"> <p>Params used to decrypt</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_account_.account.html" class="tsd-signature-type">Account</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="parsejson" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> parse<wbr>Json</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">parse<wbr>Json<span class="tsd-signature-symbol">(</span>json<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><a href="_account_.account.html" class="tsd-signature-type">Account</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/account.ts#L97">account.ts:97</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>json: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_account_.account.html" class="tsd-signature-type">Account</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="parsejsonobj" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> parse<wbr>Json<wbr>Obj</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">parse<wbr>Json<wbr>Obj<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_account_.account.html" class="tsd-signature-type">Account</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/account.ts#L108">account.ts:108</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Deserializes JSON object.</p> </div> <p>Object should be real object, not stringified.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>obj: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>JSON object</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_account_.account.html" class="tsd-signature-type">Account</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="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class="current tsd-kind-external-module"> <a href="../modules/_account_.html">"account"</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-external-module"> <a href="_account_.account.html" class="tsd-kind-icon">Account</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_account_.account.html#address" class="tsd-kind-icon">address</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_account_.account.html#enc_alg" class="tsd-kind-icon">enc-<wbr>alg</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_account_.account.html#encryptedkey" class="tsd-kind-icon">encrypted<wbr>Key</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_account_.account.html#extra" class="tsd-kind-icon">extra</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_account_.account.html#isdefault" class="tsd-kind-icon">is<wbr>Default</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_account_.account.html#label" class="tsd-kind-icon">label</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_account_.account.html#lock" class="tsd-kind-icon">lock</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_account_.account.html#publickey" class="tsd-kind-icon">public<wbr>Key</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_account_.account.html#salt" class="tsd-kind-icon">salt</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_account_.account.html#tojson" class="tsd-kind-icon">to<wbr>Json</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_account_.account.html#tojsonobj" class="tsd-kind-icon">to<wbr>Json<wbr>Obj</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="_account_.account.html#create" class="tsd-kind-icon">create</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="_account_.account.html#importaccount" class="tsd-kind-icon">import<wbr>Account</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="_account_.account.html#parsejson" class="tsd-kind-icon">parse<wbr>Json</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="_account_.account.html#parsejsonobj" class="tsd-kind-icon">parse<wbr>Json<wbr>Obj</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-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <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-index-signature"><span class="tsd-kind-icon">Index signature</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-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</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> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <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> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <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> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</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> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</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> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</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> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</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-call-signature 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="http://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>