UNPKG

ontology-ts-sdk

Version:

Comprehensive TypeScript library for the Ontology blockchain.

751 lines 109 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>SDK | 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/_sdk_index_.html">&quot;sdk/index&quot;</a> </li> <li> <a href="_sdk_index_.sdk.html">SDK</a> </li> </ul> <h1>Class SDK</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">SDK</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 tsd-is-static"><a href="_sdk_index_.sdk.html#rest_port" class="tsd-kind-icon">REST_<wbr>PORT</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#server_node" class="tsd-kind-icon">SERVER_<wbr>NODE</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#socket_port" class="tsd-kind-icon">SOCKET_<wbr>PORT</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#adderssfrompublickey" class="tsd-kind-icon">adderss<wbr>From<wbr>Public<wbr>Key</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#claimong" class="tsd-kind-icon">claim<wbr>Ong</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#createaccount" class="tsd-kind-icon">create<wbr>Account</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#createidentity" class="tsd-kind-icon">create<wbr>Identity</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#createsharedwallet" class="tsd-kind-icon">create<wbr>Shared<wbr>Wallet</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#createwallet" class="tsd-kind-icon">create<wbr>Wallet</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#decryptencryptedprivatekey" class="tsd-kind-icon">decrypt<wbr>Encrypted<wbr>Private<wbr>Key</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#decryptmnemonicenc" class="tsd-kind-icon">decrypt<wbr>Mnemonic<wbr>Enc</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#exportaccounttokeystring" class="tsd-kind-icon">export<wbr>Account<wbr>ToKeystring</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#exportaccounttoqrcode" class="tsd-kind-icon">export<wbr>Account<wbr>ToQrcode</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#exportidentitytokeystring" class="tsd-kind-icon">export<wbr>Identity<wbr>ToKeystring</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#exportidentitytoqrcode" class="tsd-kind-icon">export<wbr>Identity<wbr>ToQrcode</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#exportwifprivakekey" class="tsd-kind-icon">export<wbr>Wif<wbr>Privake<wbr>Key</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#getbalance" class="tsd-kind-icon">get<wbr>Balance</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#getclaim" class="tsd-kind-icon">get<wbr>Claim</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#getdecrypterror" class="tsd-kind-icon">get<wbr>Decrypt<wbr>Error</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#getunclaimedong" class="tsd-kind-icon">get<wbr>Unclaimed<wbr>Ong</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#importaccountmnemonic" class="tsd-kind-icon">import<wbr>Account<wbr>Mnemonic</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#importaccountwithkeystore" class="tsd-kind-icon">import<wbr>Account<wbr>With<wbr>Keystore</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#importaccountwithprivatekey" class="tsd-kind-icon">import<wbr>Account<wbr>With<wbr>Private<wbr>Key</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#importaccountwithwallet" class="tsd-kind-icon">import<wbr>Account<wbr>With<wbr>Wallet</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#importaccountwithwif" class="tsd-kind-icon">import<wbr>Account<wbr>With<wbr>Wif</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#importidentityandcreatewallet" class="tsd-kind-icon">import<wbr>Identity<wbr>And<wbr>Create<wbr>Wallet</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#importidentitywithwallet" class="tsd-kind-icon">import<wbr>Identity<wbr>With<wbr>Wallet</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#makemultisigntransaction" class="tsd-kind-icon">make<wbr>Multi<wbr>Sign<wbr>Transaction</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#querysmartcodeeventbytxhash" class="tsd-kind-icon">query<wbr>Smart<wbr>Code<wbr>Event<wbr>ByTxhash</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#setrestport" class="tsd-kind-icon">set<wbr>Rest<wbr>Port</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#setservernode" class="tsd-kind-icon">set<wbr>Server<wbr>Node</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#setsocketport" class="tsd-kind-icon">set<wbr>Socket<wbr>Port</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#signdata" class="tsd-kind-icon">sign<wbr>Data</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#signmultiaddrtransaction" class="tsd-kind-icon">sign<wbr>Multi<wbr>Addr<wbr>Transaction</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#signselfclaim" class="tsd-kind-icon">sign<wbr>Self<wbr>Claim</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#transferassets" class="tsd-kind-icon">transfer<wbr>Assets</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_sdk_index_.sdk.html#transformpassword" class="tsd-kind-icon">transform<wbr>Password</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 tsd-is-static"> <a name="rest_port" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> REST_<wbr>PORT</h3> <div class="tsd-signature tsd-kind-icon">REST_<wbr>PORT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;HTTP_REST_PORT</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/sdk/index.ts#L59">sdk/index.ts:59</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a name="server_node" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> SERVER_<wbr>NODE</h3> <div class="tsd-signature tsd-kind-icon">SERVER_<wbr>NODE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;TEST_NODE</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/sdk/index.ts#L58">sdk/index.ts:58</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a name="socket_port" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> SOCKET_<wbr>PORT</h3> <div class="tsd-signature tsd-kind-icon">SOCKET_<wbr>PORT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;HTTP_WS_PORT</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/sdk/index.ts#L60">sdk/index.ts:60</a></li> </ul> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="adderssfrompublickey" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> adderss<wbr>From<wbr>Public<wbr>Key</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">adderss<wbr>From<wbr>Public<wbr>Key<span class="tsd-signature-symbol">(</span>publicKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<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">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/sdk/index.ts#L1121">sdk/index.ts:1121</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>publicKey: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>callback: <span class="tsd-signature-type">string</span></h5> </li> </ul> <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 tsd-is-static"> <a name="claimong" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> claim<wbr>Ong</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">claim<wbr>Ong<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, encryptedPrivateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, salt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, gasPrice<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, gasLimit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, payer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<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">object</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/sdk/index.ts#L747">sdk/index.ts:747</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> <li> <h5>value: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>encryptedPrivateKey: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>password: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>salt: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>gasPrice: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>gasLimit: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>payer: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>callback: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>error<span class="tsd-signature-symbol">: </span><a href="../enums/_error_.error_code.html" class="tsd-signature-type">ERROR_CODE</a></h5> </li> <li class="tsd-parameter"> <h5>result<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> </ul> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="createaccount" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> create<wbr>Account</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">create<wbr>Account<span class="tsd-signature-symbol">(</span>label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</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/sdk/index.ts#L352">sdk/index.ts:352</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>label: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>password: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>error<span class="tsd-signature-symbol">: </span><a href="../enums/_error_.error_code.html" class="tsd-signature-type">ERROR_CODE</a></h5> </li> <li class="tsd-parameter"> <h5>mnemonic<wbr>Enc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>result<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> </ul> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="createidentity" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> create<wbr>Identity</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">create<wbr>Identity<span class="tsd-signature-symbol">(</span>label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, payer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, gasPrice<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, gasLimit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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/sdk/index.ts#L297">sdk/index.ts:297</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>label: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>password: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>payer: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>gasPrice: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>gasLimit: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="createsharedwallet" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> create<wbr>Shared<wbr>Wallet</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">create<wbr>Shared<wbr>Wallet<span class="tsd-signature-symbol">(</span>requiredSignatureNum<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, allRelatedPks<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<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">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/sdk/index.ts#L1096">sdk/index.ts:1096</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>requiredSignatureNum: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>allRelatedPks: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>callback: <span class="tsd-signature-type">string</span></h5> </li> </ul> <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 tsd-is-static"> <a name="createwallet" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> create<wbr>Wallet</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">create<wbr>Wallet<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, payer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, gasPrice<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, gasLimit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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/sdk/index.ts#L108">sdk/index.ts:108</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>name: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>password: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>payer: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>gasPrice: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>gasLimit: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="decryptencryptedprivatekey" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> decrypt<wbr>Encrypted<wbr>Private<wbr>Key</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">decrypt<wbr>Encrypted<wbr>Private<wbr>Key<span class="tsd-signature-symbol">(</span>encryptedPrivateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, salt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</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/sdk/index.ts#L486">sdk/index.ts:486</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>encryptedPrivateKey: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>password: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>address: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>salt: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>result<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> </ul> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="decryptmnemonicenc" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> decrypt<wbr>Mnemonic<wbr>Enc</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">decrypt<wbr>Mnemonic<wbr>Enc<span class="tsd-signature-symbol">(</span>mnemonicEnc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, salt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<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">object</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/sdk/index.ts#L379">sdk/index.ts:379</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>mnemonicEnc: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>address: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>salt: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>password: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>callback: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>error<span class="tsd-signature-symbol">: </span><a href="../enums/_error_.error_code.html" class="tsd-signature-type">ERROR_CODE</a></h5> </li> <li class="tsd-parameter"> <h5>result<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> </ul> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="exportaccounttokeystring" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> export<wbr>Account<wbr>ToKeystring</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">export<wbr>Account<wbr>ToKeystring<span class="tsd-signature-symbol">(</span>accountDataStr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<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">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/sdk/index.ts#L868">sdk/index.ts:868</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>accountDataStr: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>callback: <span class="tsd-signature-type">string</span></h5> </li> </ul> <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 tsd-is-static"> <a name="exportaccounttoqrcode" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> export<wbr>Account<wbr>ToQrcode</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">export<wbr>Account<wbr>ToQrcode<span class="tsd-signature-symbol">(</span>accountDataStr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<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">object</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/sdk/index.ts#L842">sdk/index.ts:842</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>accountDataStr: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>callback: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>algorithm<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>salt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>parameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>curve<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> </ul> </li> <li class="tsd-parameter"> <h5>scrypt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>dk<wbr>Len<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>n<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>p<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>r<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> </ul> </li> </ul> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="exportidentitytokeystring" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> export<wbr>Identity<wbr>ToKeystring</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">export<wbr>Identity<wbr>ToKeystring<span class="tsd-signature-symbol">(</span>identityDataStr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<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">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/sdk/index.ts#L829">sdk/index.ts:829</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>identityDataStr: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>callback: <span class="tsd-signature-type">string</span></h5> </li> </ul> <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 tsd-is-static"> <a name="exportidentitytoqrcode" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> export<wbr>Identity<wbr>ToQrcode</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">export<wbr>Identity<wbr>ToQrcode<span class="tsd-signature-symbol">(</span>identityDataStr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<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">object</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/sdk/index.ts#L803">sdk/index.ts:803</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>identityDataStr: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>callback: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>algorithm<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>salt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>parameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>curve<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> </ul> </li> <li class="tsd-parameter"> <h5>scrypt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>dk<wbr>Len<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>n<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>p<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>r<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> </ul> </li> </ul> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="exportwifprivakekey" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> export<wbr>Wif<wbr>Privake<wbr>Key</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">export<wbr>Wif<wbr>Privake<wbr>Key<span class="tsd-signature-symbol">(</span>encryptedKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, salt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<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">object</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/sdk/index.ts#L916">sdk/index.ts:916</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>encryptedKey: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>password: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>address: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>salt: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>callback: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>error<span class="tsd-signature-symbol">: </span><a href="../enums/_error_.error_code.html" class="tsd-signature-type">ERROR_CODE</a></h5> </li> <li class="tsd-parameter"> <h5>result<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> </ul> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="getbalance" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Balance</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">get<wbr>Balance<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</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/sdk/index.ts#L646">sdk/index.ts:646</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> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="getclaim" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Claim</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">get<wbr>Claim<span class="tsd-signature-symbol">(</span>claimId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, context<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, issuer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, subject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, encryptedPrivateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, salt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, payer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, gasPrice<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, gasLimit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-de