nanohash

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>"index" | nanohash</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">nanohash</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="_index_.html">"index"</a> </li> </ul> <h1>Module "index"</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 tsd-parent-kind-module"><a href="../classes/_index_.nanohash.html" class="tsd-kind-icon">Nano<wbr>Hash</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_index_.html#inversetable" class="tsd-kind-icon">inverse<wbr>Table</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="_index_.html#nanohash-1" class="tsd-kind-icon">nanohash</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Object literals</h3> <ul class="tsd-index-list"> <li class="tsd-kind-object-literal tsd-parent-kind-module"><a href="_index_.html#presets" class="tsd-kind-icon">presets</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"> <a name="inversetable" class="tsd-anchor"></a> <h3>inverse<wbr>Table</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">inverse<wbr>Table<span class="tsd-signature-symbol">(</span>htable<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">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gahabeen/nanohash/blob/7ae213f/src/index.ts#L5">index.ts:5</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>htable: <span class="tsd-signature-type">any</span></h5> </li> </ul> <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-function tsd-parent-kind-module"> <a name="nanohash-1" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> nanohash</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">nanohash<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<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-symbol">: </span><a href="../classes/_index_.nanohash.html" class="tsd-signature-type">NanoHash</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gahabeen/nanohash/blob/7ae213f/src/index.ts#L259">index.ts:259</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="../classes/_index_.nanohash.html" class="tsd-signature-type">NanoHash</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Object literals</h2> <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-module"> <a name="presets" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> presets</h3> <div class="tsd-signature tsd-kind-icon">presets<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gahabeen/nanohash/blob/7ae213f/src/index.ts#L41">index.ts:41</a></li> </ul> </aside> <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal"> <a name="presets.human_readable_ref" class="tsd-anchor"></a> <h3>HUMAN_<wbr>READABLE_<wbr>REF</h3> <div class="tsd-signature tsd-kind-icon">HUMAN_<wbr>READABLE_<wbr>REF<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gahabeen/nanohash/blob/7ae213f/src/index.ts#L42">index.ts:42</a></li> </ul> </aside> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="presets.human_readable_ref.alphabet" class="tsd-anchor"></a> <h3>alphabet</h3> <div class="tsd-signature tsd-kind-icon">alphabet<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "ABCDEFGHJKLMNPQRSTUVWXYZ23456789"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gahabeen/nanohash/blob/7ae213f/src/index.ts#L44">index.ts:44</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="presets.human_readable_ref.size" class="tsd-anchor"></a> <h3>size</h3> <div class="tsd-signature tsd-kind-icon">size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 5</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gahabeen/nanohash/blob/7ae213f/src/index.ts#L45">index.ts:45</a></li> </ul> </aside> </section> </section> <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal"> <a name="presets.short_ref" class="tsd-anchor"></a> <h3>SHORT_<wbr>REF</h3> <div class="tsd-signature tsd-kind-icon">SHORT_<wbr>REF<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gahabeen/nanohash/blob/7ae213f/src/index.ts#L47">index.ts:47</a></li> </ul> </aside> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="presets.short_ref.alphabet-1" class="tsd-anchor"></a> <h3>alphabet</h3> <div class="tsd-signature tsd-kind-icon">alphabet<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gahabeen/nanohash/blob/7ae213f/src/index.ts#L49">index.ts:49</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="presets.short_ref.size-1" class="tsd-anchor"></a> <h3>size</h3> <div class="tsd-signature tsd-kind-icon">size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 6</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gahabeen/nanohash/blob/7ae213f/src/index.ts#L50">index.ts:50</a></li> </ul> </aside> </section> </section> </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=" tsd-kind-module"> <a href="_fauna_.html">"fauna"</a> </li> <li class=" tsd-kind-module"> <a href="_hashtable_.html">"hashtable"</a> </li> <li class="current tsd-kind-module"> <a href="_index_.html">"index"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="../classes/_index_.nanohash.html" class="tsd-kind-icon">Nano<wbr>Hash</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"> <a href="_index_.html#inversetable" class="tsd-kind-icon">inverse<wbr>Table</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="_index_.html#nanohash-1" class="tsd-kind-icon">nanohash</a> </li> <li class=" tsd-kind-object-literal tsd-parent-kind-module"> <a href="_index_.html#presets" class="tsd-kind-icon">presets</a> </li> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>