UNPKG

ontology-ts-sdk

Version:

Comprehensive TypeScript library for the Ontology blockchain.

852 lines 54.2 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Claim | 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/_claim_claim_.html">&quot;claim/claim&quot;</a> </li> <li> <a href="_claim_claim_.claim.html">Claim</a> </li> </ul> <h1>Class Claim</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"> <div class="lead"> <p>Verifiable claim.</p> </div> <p>TODO: override verify to add claim proof verification.</p> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <a href="_claim_message_.message.html" class="tsd-signature-type">Message</a> <ul class="tsd-hierarchy"> <li> <span class="target">Claim</span> </li> </ul> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="_claim_claim_.claim.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_claim_claim_.claim.html#content" class="tsd-kind-icon">content</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_claim_claim_.claim.html#context" class="tsd-kind-icon">context</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_claim_claim_.claim.html#metadata" class="tsd-kind-icon">metadata</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_claim_claim_.claim.html#proof" class="tsd-kind-icon">proof</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_claim_claim_.claim.html#revocation" class="tsd-kind-icon">revocation</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_claim_claim_.claim.html#signature" class="tsd-kind-icon">signature</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_claim_claim_.claim.html#useproof" class="tsd-kind-icon">use<wbr>Proof</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_claim_claim_.claim.html#version" class="tsd-kind-icon">version</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="_claim_claim_.claim.html#attest" class="tsd-kind-icon">attest</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_claim_claim_.claim.html#getstatus" class="tsd-kind-icon">get<wbr>Status</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"><a href="_claim_claim_.claim.html#payloadfromjson" class="tsd-kind-icon">payload<wbr>FromJSON</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"><a href="_claim_claim_.claim.html#payloadtojson" class="tsd-kind-icon">payload<wbr>ToJSON</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_claim_claim_.claim.html#revoke" class="tsd-kind-icon">revoke</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="_claim_claim_.claim.html#serialize" class="tsd-kind-icon">serialize</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"><a href="_claim_claim_.claim.html#serializeheader" class="tsd-kind-icon">serialize<wbr>Header</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="_claim_claim_.claim.html#serializeproof" class="tsd-kind-icon">serialize<wbr>Proof</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_claim_claim_.claim.html#serializeunsigned" class="tsd-kind-icon">serialize<wbr>Unsigned</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_claim_claim_.claim.html#sign" class="tsd-kind-icon">sign</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="_claim_claim_.claim.html#verify" class="tsd-kind-icon">verify</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_claim_claim_.claim.html#deserialize" class="tsd-kind-icon">deserialize</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-protected tsd-is-static"><a href="_claim_claim_.claim.html#deserializeinternal" class="tsd-kind-icon">deserialize<wbr>Internal</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">new <wbr>Claim<span class="tsd-signature-symbol">(</span>metadata<span class="tsd-signature-symbol">: </span><a href="../interfaces/_claim_message_.metadata.html" class="tsd-signature-type">Metadata</a>, signature<span class="tsd-signature-symbol">?: </span><a href="_crypto_signature_.signature.html" class="tsd-signature-type">Signature</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span>, useProof<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_claim_claim_.claim.html" class="tsd-signature-type">Claim</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Overrides <a href="_claim_message_.message.html">Message</a>.<a href="_claim_message_.message.html#constructor">constructor</a></p> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/claim/claim.ts#L78">claim/claim.ts:78</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>metadata: <a href="../interfaces/_claim_message_.metadata.html" class="tsd-signature-type">Metadata</a></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> signature: <a href="_crypto_signature_.signature.html" class="tsd-signature-type">Signature</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> useProof: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_claim_claim_.claim.html" class="tsd-signature-type">Claim</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="content" class="tsd-anchor"></a> <h3>content</h3> <div class="tsd-signature tsd-kind-icon">content<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/claim/claim.ts#L74">claim/claim.ts:74</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="context" class="tsd-anchor"></a> <h3>context</h3> <div class="tsd-signature tsd-kind-icon">context<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/claim/claim.ts#L73">claim/claim.ts:73</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="metadata" class="tsd-anchor"></a> <h3>metadata</h3> <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_claim_message_.metadata.html" class="tsd-signature-type">Metadata</a></div> <aside class="tsd-sources"> <p>Inherited from <a href="_claim_message_.message.html">Message</a>.<a href="_claim_message_.message.html#metadata">metadata</a></p> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/claim/message.ts#L141">claim/message.ts:141</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="proof" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> proof</h3> <div class="tsd-signature tsd-kind-icon">proof<span class="tsd-signature-symbol">:</span> <a href="_claim_claimproof_.claimproof.html" class="tsd-signature-type">ClaimProof</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/claim/claim.ts#L78">claim/claim.ts:78</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="revocation" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> revocation</h3> <div class="tsd-signature tsd-kind-icon">revocation<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_claim_claim_.revocation.html" class="tsd-signature-type">Revocation</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/claim/claim.ts#L75">claim/claim.ts:75</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="signature" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> signature</h3> <div class="tsd-signature tsd-kind-icon">signature<span class="tsd-signature-symbol">:</span> <a href="_crypto_signature_.signature.html" class="tsd-signature-type">Signature</a></div> <aside class="tsd-sources"> <p>Inherited from <a href="_claim_message_.message.html">Message</a>.<a href="_claim_message_.message.html#signature">signature</a></p> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/claim/message.ts#L142">claim/message.ts:142</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="useproof" class="tsd-anchor"></a> <h3>use<wbr>Proof</h3> <div class="tsd-signature tsd-kind-icon">use<wbr>Proof<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/claim/claim.ts#L77">claim/claim.ts:77</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="version" class="tsd-anchor"></a> <h3>version</h3> <div class="tsd-signature tsd-kind-icon">version<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/claim/claim.ts#L72">claim/claim.ts:72</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="attest" class="tsd-anchor"></a> <h3>attest</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">attest<span class="tsd-signature-symbol">(</span>url<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><a href="_crypto_address_.address.html" class="tsd-signature-type">Address</a>, privateKey<span class="tsd-signature-symbol">: </span><a href="_crypto_privatekey_.privatekey.html" class="tsd-signature-type">PrivateKey</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">&lt;</span><span class="tsd-signature-type">boolean</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/claim/claim.ts#L140">claim/claim.ts:140</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Attests the claim onto blockchain.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>url: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Websocket endpoint of Ontology node</p> </div> </li> <li> <h5>gasPrice: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>gasPrice</p> </div> </li> <li> <h5>gasLimit: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>gasLimit</p> </div> </li> <li> <h5>payer: <a href="_crypto_address_.address.html" class="tsd-signature-type">Address</a></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>payer</p> </div> </div> </li> <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 to sign the transaction</p> </div> </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">boolean</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"> <a name="getstatus" class="tsd-anchor"></a> <h3>get<wbr>Status</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Status<span class="tsd-signature-symbol">(</span>url<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">boolean</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/claim/claim.ts#L193">claim/claim.ts:193</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets status of the claim attest.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>url: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Restful endpoint of Ontology node</p> </div> </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">boolean</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-overwrite tsd-is-protected"> <a name="payloadfromjson" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> payload<wbr>FromJSON</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"> <li class="tsd-signature tsd-kind-icon">payload<wbr>FromJSON<span class="tsd-signature-symbol">(</span>json<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><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Overrides <a href="_claim_message_.message.html">Message</a>.<a href="_claim_message_.message.html#payloadfromjson">payloadFromJSON</a></p> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/claim/claim.ts#L221">claim/claim.ts:221</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>json: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"> <a name="payloadtojson" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> payload<wbr>ToJSON</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"> <li class="tsd-signature tsd-kind-icon">payload<wbr>ToJSON<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"> <p>Overrides <a href="_claim_message_.message.html">Message</a>.<a href="_claim_message_.message.html#payloadtojson">payloadToJSON</a></p> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/claim/claim.ts#L212">claim/claim.ts:212</a></li> </ul> </aside> <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"> <a name="revoke" class="tsd-anchor"></a> <h3>revoke</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">revoke<span class="tsd-signature-symbol">(</span>url<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><a href="_crypto_address_.address.html" class="tsd-signature-type">Address</a>, privateKey<span class="tsd-signature-symbol">: </span><a href="_crypto_privatekey_.privatekey.html" class="tsd-signature-type">PrivateKey</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">&lt;</span><span class="tsd-signature-type">boolean</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/claim/claim.ts#L171">claim/claim.ts:171</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Revokes claim attest from blockchain.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>url: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Websocket endpoint of Ontology node</p> </div> </li> <li> <h5>gasPrice: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>gasPrice</p> </div> </li> <li> <h5>gasLimit: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>gasLimit</p> </div> </li> <li> <h5>payer: <a href="_crypto_address_.address.html" class="tsd-signature-type">Address</a></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>payer</p> </div> </div> </li> <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 to sign the transaction</p> </div> </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">boolean</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-overwrite"> <a name="serialize" class="tsd-anchor"></a> <h3>serialize</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">serialize<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"> <p>Overrides <a href="_claim_message_.message.html">Message</a>.<a href="_claim_message_.message.html#serialize">serialize</a></p> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/claim/claim.ts#L118">claim/claim.ts:118</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Serializes the claim into JWT/JWT-X format.</p> </div> <p>Override default implementation by adding proof if available.</p> </div> <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-overwrite tsd-is-protected"> <a name="serializeheader" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> serialize<wbr>Header</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"> <li class="tsd-signature tsd-kind-icon">serialize<wbr>Header<span class="tsd-signature-symbol">(</span>algorithm<span class="tsd-signature-symbol">: </span><a href="_crypto_signaturescheme_.signaturescheme.html" class="tsd-signature-type">SignatureScheme</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span>, publicKeyId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</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"> <p>Overrides <a href="_claim_message_.message.html">Message</a>.<a href="_claim_message_.message.html#serializeheader">serializeHeader</a></p> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/claim/claim.ts#L236">claim/claim.ts:236</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Serializes the header into JWT/JWT-X encoded header.</p> </div> <p>Override default implementation by adding proof if available.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>algorithm: <a href="_crypto_signaturescheme_.signaturescheme.html" class="tsd-signature-type">SignatureScheme</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5> <div class="tsd-comment tsd-typography"> <p>Signature algorithm used</p> </div> </li> <li> <h5>publicKeyId: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5> <div class="tsd-comment tsd-typography"> <p>The ID of a signature public key</p> </div> </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-protected"> <a name="serializeproof" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> serialize<wbr>Proof</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <li class="tsd-signature tsd-kind-icon">serialize<wbr>Proof<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/claim/claim.ts#L258">claim/claim.ts:258</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Serializes the proof into JWT-X.</p> </div> </div> <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-inherited"> <a name="serializeunsigned" class="tsd-anchor"></a> <h3>serialize<wbr>Unsigned</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">serialize<wbr>Unsigned<span class="tsd-signature-symbol">(</span>algorithm<span class="tsd-signature-symbol">?: </span><a href="_crypto_signaturescheme_.signaturescheme.html" class="tsd-signature-type">SignatureScheme</a>, publicKeyId<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">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="_claim_message_.message.html">Message</a>.<a href="_claim_message_.message.html#serializeunsigned">serializeUnsigned</a></p> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/claim/message.ts#L223">claim/message.ts:223</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Serializes the message without signature into JWT format.</p> </div> <p>Header might contain algorithm and public key id.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> algorithm: <a href="_crypto_signaturescheme_.signaturescheme.html" class="tsd-signature-type">SignatureScheme</a></h5> <div class="tsd-comment tsd-typography"> <p>Signature algorithm used</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> publicKeyId: <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>The ID of a signature public key</p> </div> </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-inherited"> <a name="sign" class="tsd-anchor"></a> <h3>sign</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">sign<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, publicKeyId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, privateKey<span class="tsd-signature-symbol">: </span><a href="_crypto_privatekey_.privatekey.html" class="tsd-signature-type">PrivateKey</a>, algorithm<span class="tsd-signature-symbol">?: </span><a href="_crypto_signaturescheme_.signaturescheme.html" class="tsd-signature-type">SignatureScheme</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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="_claim_message_.message.html">Message</a>.<a href="_claim_message_.message.html#sign">sign</a></p> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/claim/message.ts#L163">claim/message.ts:163</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Signs the message and store the signature inside the request.</p> </div> <p>If the algorithm is not specified, then default algorithm for Private key type is used.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>url: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Restful endpoint of Ontology node</p> </div> </li> <li> <h5>publicKeyId: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The ID of a signature public key</p> </div> </li> <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 to sign the request with</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> algorithm: <a href="_crypto_signaturescheme_.signaturescheme.html" class="tsd-signature-type">SignatureScheme</a></h5> <div class="tsd-comment tsd-typography"> <p>Signature algorithm used</p> </div> </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">void</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-overwrite"> <a name="verify" class="tsd-anchor"></a> <h3>verify</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">verify<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, checkAttest<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Overrides <a href="_claim_message_.message.html">Message</a>.<a href="_claim_message_.message.html#verify">verify</a></p> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/claim/claim.ts#L103">claim/claim.ts:103</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Overrides default message verification with added attest verification.</p> </div> <p>TODO: return more than boolean</p> <p>const VerifyOntidClaimResult = { CLAIM_NOT_ONCHAIN : &#39;CLAIM_NOT_ONCHAIN&#39;, INVALID_SIGNATURE : &#39;INVALID_SIGNATURE&#39;, PK_IN_REVOKED : &#39;PK_IN_REVOKED&#39;, NO_ISSUER_PK : &#39;NO_ISSUER_PK&#39;, EXPIRED_CLAIM : &#39;EXPIRED_CLAIM&#39;, REVOKED_CLAIM : &#39;REVOKED_CLAIM&#39;, VALID_CLAIM : &#39;VALID_CLAIM&#39; };</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>url: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Restful endpoint of Ontology node</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> checkAttest: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;true</span></h5> <div class="tsd-comment tsd-typography"> <p>Should be the attest tested</p> </div> </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">boolean</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="deserialize" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> deserialize</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">deserialize<span class="tsd-signature-symbol">(</span>jwt<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="_claim_claim_.claim.html" class="tsd-signature-type">Claim</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/claim/claim.ts#L68">claim/claim.ts:68</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>jwt: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_claim_claim_.claim.html" class="tsd-signature-type">Claim</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-protected tsd-is-static"> <a name="deserializeinternal" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagProtected">Protected</span> deserialize<wbr>Internal</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-protected tsd-is-static"> <li class="tsd-signature tsd-kind-icon">deserialize<wbr>Internal&lt;T&gt;<span class="tsd-signature-symbol">(</span>jwt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, creator<span class="tsd-signature-symbol">: </span><a href="../modules/_claim_message_.html#messagefactory" class="tsd-signature-type">MessageFactory</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="_claim_message_.message.html">Message</a>.<a href="_claim_message_.message.html#deserializeinternal">deserializeInternal</a></p> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/claim/message.ts#L81">claim/message.ts:81</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Deserializes the message from JWT format.</p> </div> <p>A concrete instance will be creater through the message factory method. This method is called from concrete class.</p> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>T<span class="tsd-signature-symbol">: </span><a href="_claim_message_.message.html" class="tsd-signature-type">Message</a></h4> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>jwt: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Encoded message</p> </div> </li> <li> <h5>creator: <a href="../modules/_claim_message_.html#messagefactory" class="tsd-signature-type">MessageFactory</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5> <div class="tsd-comment tsd-typography"> <p>Factory method</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class="current tsd-kind-external-module"> <a href="../modules/_claim_claim_.html">"claim/claim"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-enum tsd-parent-kind-external-module"> <a href="../enums/_claim_claim_.revocationtype.html" class="tsd-kind-icon">Revocation<wbr>Type</a> </li> <li class=" tsd-kind-enum tsd-parent-kind-external-module"> <a href="../enums/_claim_claim_.status.html" class="tsd-kind-icon">Status</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-external-module"> <a href="_claim_claim_.claim.html" class="tsd-kind-icon">Claim</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"> <a href="_claim_claim_.claim.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_claim_claim_.claim.html#content" class="tsd-kind-icon">content</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_claim_claim_.claim.html#context" class="tsd-kind-icon">context</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a href="_claim_claim_.claim.html#metadata" class="tsd-kind-icon">metadata</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_claim_claim_.claim.html#proof" class="tsd-kind-icon">proof</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_claim_claim_.claim.html#revocation" class="tsd-kind-icon">revocation</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a href="_claim_claim_.claim.html#signature" class="tsd-kind-icon">signature</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_claim_claim_.claim.html#useproof" class="tsd-kind-icon">use<wbr>Proof</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_claim_claim_.claim.html#version" class="tsd-kind-icon">version</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_claim_claim_.claim.html#attest" class="tsd-kind-icon">attest</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_claim_claim_.claim.html#getstatus" class="tsd-kind-icon">get<wbr>Status</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"> <a href="_claim_claim_.claim.html#payloadfromjson" class="tsd-kind-icon">payload<wbr>FromJSON</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"> <a href="_claim_claim_.claim.html#payloadtojson" class="tsd-kind-icon">payload<wbr>ToJSON</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_claim_claim_.claim.html#revoke" class="tsd-kind-icon">revoke</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a href="_claim_claim_.claim.html#serialize" class="tsd-kind-icon">serialize</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"> <a href="_claim_claim_.claim.html#serializeheader" class="tsd-kind-icon">serialize<wbr>Header</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <a href="_claim_claim_.claim.html#serializeproof" class="tsd-kind-icon">serialize<wbr>Proof</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a href="_claim_claim_.claim.html#serializeunsigned" class="tsd-kind-icon">serialize<wbr>Unsigned</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a href="_claim_claim_.claim.html#sign" class="tsd-kind-icon">sign</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a href="_claim_claim_.claim.html#verify" class="tsd-kind-icon">verify</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="_claim_claim_.claim.html#deserialize" class="tsd-kind-icon">deserialize</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-protected tsd-is-static"> <a href="_claim_claim_.claim.html#deserializeinternal" class="tsd-kind-icon">deserialize<wbr>Internal</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-class tsd-parent-kind-external-module"> <a href="_claim_claim_.getstatusresponse.html" class="tsd-kind-icon">Get<wbr>Status<wbr>Response</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="../interfaces/_claim_claim_.revocation.html" class="tsd-kind-icon">Revocation</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-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</