nanohash
Version:
Generate 64bits-based numeric ids readable as short strings too!
833 lines • 46.5 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>NanoHash | 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="../modules/_index_.html">"index"</a>
</li>
<li>
<a href="_index_.nanohash.html">NanoHash</a>
</li>
</ul>
<h1>Class NanoHash</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>Creates an instance of nanohash based on size and alphabet needs</p>
</div>
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><pre><code class="language-javascript"><span class="hljs-keyword">const</span> nhash = nanohash({ <span class="hljs-attr">size</span>: <span class="hljs-number">6</span>, <span class="hljs-attr">alphabet</span>: <span class="hljs-string">"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"</span> })</code></pre>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">NanoHash</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>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface tsd-parent-kind-class"><a href="../interfaces/_index_.nanohash.hashobject.html" class="tsd-kind-icon">hash<wbr>Object</a></li>
<li class="tsd-kind-interface tsd-parent-kind-class"><a href="../interfaces/_index_.nanohash.options.html" class="tsd-kind-icon">options</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Type aliases</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-type-alias tsd-parent-kind-class tsd-is-static"><a href="_index_.nanohash.html#bulkmethod" class="tsd-kind-icon">Bulk<wbr>Method</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-class tsd-is-static"><a href="_index_.nanohash.html#dehashmethod" class="tsd-kind-icon">Dehash<wbr>Method</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-class tsd-is-static"><a href="_index_.nanohash.html#faunacode" class="tsd-kind-icon">Fauna<wbr>Code</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-class tsd-is-static"><a href="_index_.nanohash.html#faunacodemethod" class="tsd-kind-icon">Fauna<wbr>Code<wbr>Method</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-class tsd-is-static"><a href="_index_.nanohash.html#faunaid" class="tsd-kind-icon">FaunaID</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-class tsd-is-static"><a href="_index_.nanohash.html#faunaidmethod" class="tsd-kind-icon">Fauna<wbr>IdMethod</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-class tsd-is-static"><a href="_index_.nanohash.html#generatemethod" class="tsd-kind-icon">Generate<wbr>Method</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-class tsd-is-static"><a href="_index_.nanohash.html#hashmethod" class="tsd-kind-icon">Hash<wbr>Method</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-class tsd-is-static"><a href="_index_.nanohash.html#id" class="tsd-kind-icon">ID</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-class tsd-is-static"><a href="_index_.nanohash.html#code" class="tsd-kind-icon">code</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_index_.nanohash.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="_index_.nanohash.html#alphabet" class="tsd-kind-icon">alphabet</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_index_.nanohash.html#codetable" class="tsd-kind-icon">codetable</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_index_.nanohash.html#codetable99" class="tsd-kind-icon">codetable99</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_index_.nanohash.html#hashtable" class="tsd-kind-icon">hashtable</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_index_.nanohash.html#hashtable99" class="tsd-kind-icon">hashtable99</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_index_.nanohash.html#maxsize" class="tsd-kind-icon">max<wbr>Size</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_index_.nanohash.html#prefix" class="tsd-kind-icon">prefix</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_index_.nanohash.html#size" class="tsd-kind-icon">size</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="_index_.nanohash.html#bulk" class="tsd-kind-icon">bulk</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_index_.nanohash.html#dehash" class="tsd-kind-icon">dehash</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_index_.nanohash.html#faunacode-1" class="tsd-kind-icon">fauna<wbr>Code</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_index_.nanohash.html#faunaid-1" class="tsd-kind-icon">fauna<wbr>Id</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_index_.nanohash.html#generate" class="tsd-kind-icon">generate</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_index_.nanohash.html#hash" class="tsd-kind-icon">hash</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 tsd-parent-kind-class tsd-is-static">
<a name="bulkmethod" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> Bulk<wbr>Method</h3>
<div class="tsd-signature tsd-kind-icon">Bulk<wbr>Method<span class="tsd-signature-symbol">:</span> <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><span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gahabeen/nanohash/blob/7ae213f/src/index.ts#L34">index.ts:34</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><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><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<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 <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-class tsd-is-static">
<a name="dehashmethod" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> Dehash<wbr>Method</h3>
<div class="tsd-signature tsd-kind-icon">Dehash<wbr>Method<span class="tsd-signature-symbol">:</span> <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><span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gahabeen/nanohash/blob/7ae213f/src/index.ts#L36">index.ts:36</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><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><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<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 <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-class tsd-is-static">
<a name="faunacode" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> Fauna<wbr>Code</h3>
<div class="tsd-signature tsd-kind-icon">Fauna<wbr>Code<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/gahabeen/nanohash/blob/7ae213f/src/index.ts#L31">index.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-class tsd-is-static">
<a name="faunacodemethod" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> Fauna<wbr>Code<wbr>Method</h3>
<div class="tsd-signature tsd-kind-icon">Fauna<wbr>Code<wbr>Method<span class="tsd-signature-symbol">:</span> <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><span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gahabeen/nanohash/blob/7ae213f/src/index.ts#L38">index.ts:38</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><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><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<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 <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-class tsd-is-static">
<a name="faunaid" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> FaunaID</h3>
<div class="tsd-signature tsd-kind-icon">FaunaID<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/gahabeen/nanohash/blob/7ae213f/src/index.ts#L30">index.ts:30</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-class tsd-is-static">
<a name="faunaidmethod" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> Fauna<wbr>IdMethod</h3>
<div class="tsd-signature tsd-kind-icon">Fauna<wbr>IdMethod<span class="tsd-signature-symbol">:</span> <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><span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gahabeen/nanohash/blob/7ae213f/src/index.ts#L37">index.ts:37</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><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><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<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 <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-class tsd-is-static">
<a name="generatemethod" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> Generate<wbr>Method</h3>
<div class="tsd-signature tsd-kind-icon">Generate<wbr>Method<span class="tsd-signature-symbol">:</span> <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><span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gahabeen/nanohash/blob/7ae213f/src/index.ts#L33">index.ts:33</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><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><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<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 <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-class tsd-is-static">
<a name="hashmethod" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> Hash<wbr>Method</h3>
<div class="tsd-signature tsd-kind-icon">Hash<wbr>Method<span class="tsd-signature-symbol">:</span> <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><span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gahabeen/nanohash/blob/7ae213f/src/index.ts#L35">index.ts:35</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><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><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<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 <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-class tsd-is-static">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> ID</h3>
<div class="tsd-signature tsd-kind-icon">ID<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/gahabeen/nanohash/blob/7ae213f/src/index.ts#L27">index.ts:27</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-class tsd-is-static">
<a name="code" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> code</h3>
<div class="tsd-signature tsd-kind-icon">code<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/gahabeen/nanohash/blob/7ae213f/src/index.ts#L28">index.ts:28</a></li>
</ul>
</aside>
</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">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Nano<wbr>Hash<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_index_.nanohash.options.html" class="tsd-signature-type">options</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_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#L71">index.ts:71</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> options: <a href="../interfaces/_index_.nanohash.options.html" class="tsd-signature-type">options</a><span class="tsd-signature-symbol"> = {}</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_index_.nanohash.html" class="tsd-signature-type">NanoHash</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="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"> = presets.SHORT_REF.alphabet</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gahabeen/nanohash/blob/7ae213f/src/index.ts#L65">index.ts:65</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="codetable" class="tsd-anchor"></a>
<h3>codetable</h3>
<div class="tsd-signature tsd-kind-icon">codetable<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#L69">index.ts:69</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="codetable99" class="tsd-anchor"></a>
<h3>codetable99</h3>
<div class="tsd-signature tsd-kind-icon">codetable99<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#L71">index.ts:71</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="hashtable" class="tsd-anchor"></a>
<h3>hashtable</h3>
<div class="tsd-signature tsd-kind-icon">hashtable<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#L68">index.ts:68</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="hashtable99" class="tsd-anchor"></a>
<h3>hashtable99</h3>
<div class="tsd-signature tsd-kind-icon">hashtable99<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#L70">index.ts:70</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="maxsize" class="tsd-anchor"></a>
<h3>max<wbr>Size</h3>
<div class="tsd-signature tsd-kind-icon">max<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 9</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gahabeen/nanohash/blob/7ae213f/src/index.ts#L64">index.ts:64</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="prefix" class="tsd-anchor"></a>
<h3>prefix</h3>
<div class="tsd-signature tsd-kind-icon">prefix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "1"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gahabeen/nanohash/blob/7ae213f/src/index.ts#L66">index.ts:66</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="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"> = 6</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gahabeen/nanohash/blob/7ae213f/src/index.ts#L63">index.ts:63</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="bulk" class="tsd-anchor"></a>
<h3>bulk</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">bulk<span class="tsd-signature-symbol">(</span>n<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_index_.nanohash.html#id" class="tsd-signature-type">ID</a><span class="tsd-signature-symbol">[]</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#L119">index.ts:119</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Generates n iterations of unique numeric string ID (each reversible to code)</p>
</div>
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><p> const code = nhash.bulk(5)
// output: [ '1075226254449', '1563743314555', '1015201022261', '1271320203729', '1465116152533' ]</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> n: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 10</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_index_.nanohash.html#id" class="tsd-signature-type">ID</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="dehash" class="tsd-anchor"></a>
<h3>dehash</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">dehash<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">?: </span><a href="_index_.nanohash.html#id" class="tsd-signature-type">ID</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_index_.nanohash.html#code" class="tsd-signature-type">code</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#L165">index.ts:165</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns a code from an ID (made from .hash() or .generate())</p>
</div>
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><p> const countryName = nhash.dehash("1412710231214")
// output: France</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> id: <a href="_index_.nanohash.html#id" class="tsd-signature-type">ID</a><span class="tsd-signature-symbol"> = ""</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_index_.nanohash.html#code" class="tsd-signature-type">code</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="faunacode-1" class="tsd-anchor"></a>
<h3>fauna<wbr>Code</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">fauna<wbr>Code<span class="tsd-signature-symbol">(</span>faunaId<span class="tsd-signature-symbol">: </span><a href="_index_.nanohash.html#faunaid" class="tsd-signature-type">FaunaID</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_index_.nanohash.html#faunacode" class="tsd-signature-type">FaunaCode</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#L190">index.ts:190</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns a code from a Fauna ID (generated by Fauna)</p>
</div>
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><p> const code = nhash.faunaCode("258296287713034771")
// output: эh3ъmöýRt</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>faunaId: <a href="_index_.nanohash.html#faunaid" class="tsd-signature-type">FaunaID</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_index_.nanohash.html#faunacode" class="tsd-signature-type">FaunaCode</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="faunaid-1" class="tsd-anchor"></a>
<h3>fauna<wbr>Id</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">fauna<wbr>Id<span class="tsd-signature-symbol">(</span>faunaCode<span class="tsd-signature-symbol">: </span><a href="_index_.nanohash.html#faunacode" class="tsd-signature-type">FaunaCode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_index_.nanohash.html#faunaid" class="tsd-signature-type">FaunaID</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#L229">index.ts:229</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns a Fauna ID from a code (from .faunaCode())</p>
</div>
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><p> const faunaID = nhash.faunaId("эh3ъmöýRt")
// output: 258296287713034771</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>faunaCode: <a href="_index_.nanohash.html#faunacode" class="tsd-signature-type">FaunaCode</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_index_.nanohash.html#faunaid" class="tsd-signature-type">FaunaID</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="generate" class="tsd-anchor"></a>
<h3>generate</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">generate<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_index_.nanohash.html#id" class="tsd-signature-type">ID</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#L104">index.ts:104</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Generates a unique numeric string ID (reversible to code)</p>
</div>
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><p> const code = nhash.generate()
// output: Xe7ZRY</p>
</dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <a href="_index_.nanohash.html#id" class="tsd-signature-type">ID</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="hash" class="tsd-anchor"></a>
<h3>hash</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">hash<span class="tsd-signature-symbol">(</span>code<span class="tsd-signature-symbol">: </span><a href="_index_.nanohash.html#code" class="tsd-signature-type">code</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_index_.nanohash.html#id" class="tsd-signature-type">ID</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#L136">index.ts:136</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Convert a string code to a numeric string ID (reversible)</p>
</div>
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><p> const countryID = nhash.hash("France")
// output: 1412710231214</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>code: <a href="_index_.nanohash.html#code" class="tsd-signature-type">code</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_index_.nanohash.html#id" class="tsd-signature-type">ID</a></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_fauna_.html">"fauna"</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_hashtable_.html">"hashtable"</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/_index_.html">"index"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-module">
<a href="_index_.nanohash.html" class="tsd-kind-icon">Nano<wbr>Hash</a>
<ul>
<li class=" tsd-kind-interface tsd-parent-kind-class">
<a href="../interfaces/_index_.nanohash.hashobject.html" class="tsd-kind-icon">hash<wbr>Object</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-class">
<a href="../interfaces/_index_.nanohash.options.html" class="tsd-kind-icon">options</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-class tsd-is-static">
<a href="_index_.nanohash.html#bulkmethod" class="tsd-kind-icon">Bulk<wbr>Method</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-class tsd-is-static">
<a href="_index_.nanohash.html#dehashmethod" class="tsd-kind-icon">Dehash<wbr>Method</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-class tsd-is-static">
<a href="_index_.nanohash.html#faunacode" class="tsd-kind-icon">Fauna<wbr>Code</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-class tsd-is-static">
<a href="_index_.nanohash.html#faunacodemethod" class="tsd-kind-icon">Fauna<wbr>Code<wbr>Method</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-class tsd-is-static">
<a href="_index_.nanohash.html#faunaid" class="tsd-kind-icon">FaunaID</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-class tsd-is-static">
<a href="_index_.nanohash.html#faunaidmethod" class="tsd-kind-icon">Fauna<wbr>IdMethod</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-class tsd-is-static">
<a href="_index_.nanohash.html#generatemethod" class="tsd-kind-icon">Generate<wbr>Method</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-class tsd-is-static">
<a href="_index_.nanohash.html#hashmethod" class="tsd-kind-icon">Hash<wbr>Method</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-class tsd-is-static">
<a href="_index_.nanohash.html#id" class="tsd-kind-icon">ID</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-class tsd-is-static">
<a href="_index_.nanohash.html#code" class="tsd-kind-icon">code</a>
</li>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="_index_.nanohash.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_index_.nanohash.html#alphabet" class="tsd-kind-icon">alphabet</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_index_.nanohash.html#codetable" class="tsd-kind-icon">codetable</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_index_.nanohash.html#codetable99" class="tsd-kind-icon">codetable99</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_index_.nanohash.html#hashtable" class="tsd-kind-icon">hashtable</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_index_.nanohash.html#hashtable99" class="tsd-kind-icon">hashtable99</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_index_.nanohash.html#maxsize" class="tsd-kind-icon">max<wbr>Size</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_index_.nanohash.html#prefix" class="tsd-kind-icon">prefix</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_index_.nanohash.html#size" class="tsd-kind-icon">size</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_index_.nanohash.html#bulk" class="tsd-kind-icon">bulk</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_index_.nanohash.html#dehash" class="tsd-kind-icon">dehash</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_index_.nanohash.html#faunacode-1" class="tsd-kind-icon">fauna<wbr>Code</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_index_.nanohash.html#faunaid-1" class="tsd-kind-icon">fauna<wbr>Id</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_index_.nanohash.html#generate" class="tsd-kind-icon">generate</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_index_.nanohash.html#hash" class="tsd-kind-icon">hash</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/_index_.html#inversetable" class="tsd-kind-icon">inverse<wbr>Table</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/_index_.html#nanohash-1" class="tsd-kind-icon">nanohash</a>
</li>
<li class=" tsd-kind-object-literal tsd-parent-kind-module">
<a href="../modules/_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">
<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>
</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>