danog/fast-srp
1
0
Fork 0
mirror of https://github.com/danog/fast-srp.git synced 2024-11-26 20:04:49 +01:00
Code Issues Projects Releases Wiki Activity
master
fast-srp/docs/modules.html
Supereg 3e1ddc35e0
Update docs
2021-03-09 12:33:57 +01:00

223 lines
11 KiB
HTML
Raw Permalink Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>fast-srp-hap</title>
<meta name="description" content="Documentation for fast-srp-hap">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
<script async src="assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">fast-srp-hap</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<h1>fast-srp-hap</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Classes</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class"><a href="classes/srp.html" class="tsd-kind-icon">SRP</a></li>
<li class="tsd-kind-class"><a href="classes/srpclient.html" class="tsd-kind-icon">Srp<wbr>Client</a></li>
<li class="tsd-kind-class"><a href="classes/srpserver.html" class="tsd-kind-icon">Srp<wbr>Server</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface"><a href="interfaces/baseidentity.html" class="tsd-kind-icon">Base<wbr>Identity</a></li>
<li class="tsd-kind-interface"><a href="interfaces/srpparams.html" class="tsd-kind-icon">Srp<wbr>Params</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Type aliases</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-type-alias"><a href="modules.html#genkeycallback" class="tsd-kind-icon">Gen<wbr>Key<wbr>Callback</a></li>
<li class="tsd-kind-type-alias"><a href="modules.html#identity" class="tsd-kind-icon">Identity</a></li>
<li class="tsd-kind-type-alias"><a href="modules.html#passwordidentity" class="tsd-kind-icon">Password<wbr>Identity</a></li>
<li class="tsd-kind-type-alias"><a href="modules.html#verifieridentity" class="tsd-kind-icon">Verifier<wbr>Identity</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Type aliases</h2>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="genkeycallback" class="tsd-anchor"></a>
<h3>Gen<wbr>Key<wbr>Callback</h3>
<div class="tsd-signature tsd-kind-icon">Gen<wbr>Key<wbr>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/homebridge/fast-srp/blob/3aaeb5b/src/srp.ts#L77">srp.ts:77</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>err: <span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
</li>
<li>
<h5>data: <span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="identity" class="tsd-anchor"></a>
<h3>Identity</h3>
<div class="tsd-signature tsd-kind-icon">Identity<span class="tsd-signature-symbol">:</span> <a href="modules.html#passwordidentity" class="tsd-signature-type" data-tsd-kind="Type alias">PasswordIdentity</a><span class="tsd-signature-symbol"> | </span><a href="modules.html#verifieridentity" class="tsd-signature-type" data-tsd-kind="Type alias">VerifierIdentity</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/homebridge/fast-srp/blob/3aaeb5b/src/srp.ts#L503">srp.ts:503</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="passwordidentity" class="tsd-anchor"></a>
<h3>Password<wbr>Identity</h3>
<div class="tsd-signature tsd-kind-icon">Password<wbr>Identity<span class="tsd-signature-symbol">:</span> <a href="interfaces/baseidentity.html" class="tsd-signature-type" data-tsd-kind="Interface">BaseIdentity</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/homebridge/fast-srp/blob/3aaeb5b/src/srp.ts#L500">srp.ts:500</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="verifieridentity" class="tsd-anchor"></a>
<h3>Verifier<wbr>Identity</h3>
<div class="tsd-signature tsd-kind-icon">Verifier<wbr>Identity<span class="tsd-signature-symbol">:</span> <a href="interfaces/baseidentity.html" class="tsd-signature-type" data-tsd-kind="Interface">BaseIdentity</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>verifier<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/homebridge/fast-srp/blob/3aaeb5b/src/srp.ts#L501">srp.ts:501</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="current ">
<a href="modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="classes/srp.html" class="tsd-kind-icon">SRP</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/srpclient.html" class="tsd-kind-icon">Srp<wbr>Client</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/srpserver.html" class="tsd-kind-icon">Srp<wbr>Server</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/baseidentity.html" class="tsd-kind-icon">Base<wbr>Identity</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/srpparams.html" class="tsd-kind-icon">Srp<wbr>Params</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#genkeycallback" class="tsd-kind-icon">Gen<wbr>Key<wbr>Callback</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#identity" class="tsd-kind-icon">Identity</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#passwordidentity" class="tsd-kind-icon">Password<wbr>Identity</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#verifieridentity" class="tsd-kind-icon">Verifier<wbr>Identity</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink