nanohash
Version:
Generate 64bits-based numeric ids readable as short strings too!
311 lines • 14.6 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>options | 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="../classes/_index_.nanohash.html">NanoHash</a>
</li>
<li>
<a href="_index_.nanohash.options.html">options</a>
</li>
</ul>
<h1>Interface options</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">options</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_index_.nanohash.options.html#alphabet" class="tsd-kind-icon">alphabet</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_index_.nanohash.options.html#hashtable" class="tsd-kind-icon">hashtable</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_index_.nanohash.options.html#maxsize" class="tsd-kind-icon">max<wbr>Size</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_index_.nanohash.options.html#prefix" class="tsd-kind-icon">prefix</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_index_.nanohash.options.html#size" class="tsd-kind-icon">size</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="alphabet" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> alphabet</h3>
<div class="tsd-signature tsd-kind-icon">alphabet<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#L15">index.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="hashtable" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> hashtable</h3>
<div class="tsd-signature tsd-kind-icon">hashtable<span class="tsd-signature-symbol">:</span> <a href="_index_.nanohash.hashobject.html" class="tsd-signature-type">hashObject</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gahabeen/nanohash/blob/7ae213f/src/index.ts#L19">index.ts:19</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="maxsize" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gahabeen/nanohash/blob/7ae213f/src/index.ts#L18">index.ts:18</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="prefix" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> prefix</h3>
<div class="tsd-signature tsd-kind-icon">prefix<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#L20">index.ts:20</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="size" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> size</h3>
<div class="tsd-signature tsd-kind-icon">size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gahabeen/nanohash/blob/7ae213f/src/index.ts#L17">index.ts:17</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="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="../classes/_index_.nanohash.html" class="tsd-kind-icon">Nano<wbr>Hash</a>
<ul>
<li class=" tsd-kind-interface tsd-parent-kind-class">
<a href="_index_.nanohash.hashobject.html" class="tsd-kind-icon">hash<wbr>Object</a>
</li>
<li class="current tsd-kind-interface tsd-parent-kind-class">
<a href="_index_.nanohash.options.html" class="tsd-kind-icon">options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_index_.nanohash.options.html#alphabet" class="tsd-kind-icon">alphabet</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_index_.nanohash.options.html#hashtable" class="tsd-kind-icon">hashtable</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_index_.nanohash.options.html#maxsize" class="tsd-kind-icon">max<wbr>Size</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_index_.nanohash.options.html#prefix" class="tsd-kind-icon">prefix</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_index_.nanohash.options.html#size" class="tsd-kind-icon">size</a>
</li>
</ul>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-class tsd-is-static">
<a href="../classes/_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="../classes/_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="../classes/_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="../classes/_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="../classes/_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="../classes/_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="../classes/_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="../classes/_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="../classes/_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="../classes/_index_.nanohash.html#code" class="tsd-kind-icon">code</a>
</li>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="../classes/_index_.nanohash.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="../classes/_index_.nanohash.html#alphabet" class="tsd-kind-icon">alphabet</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="../classes/_index_.nanohash.html#codetable" class="tsd-kind-icon">codetable</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="../classes/_index_.nanohash.html#codetable99" class="tsd-kind-icon">codetable99</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="../classes/_index_.nanohash.html#hashtable" class="tsd-kind-icon">hashtable</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="../classes/_index_.nanohash.html#hashtable99" class="tsd-kind-icon">hashtable99</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="../classes/_index_.nanohash.html#maxsize" class="tsd-kind-icon">max<wbr>Size</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="../classes/_index_.nanohash.html#prefix" class="tsd-kind-icon">prefix</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="../classes/_index_.nanohash.html#size" class="tsd-kind-icon">size</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="../classes/_index_.nanohash.html#bulk" class="tsd-kind-icon">bulk</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="../classes/_index_.nanohash.html#dehash" class="tsd-kind-icon">dehash</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="../classes/_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="../classes/_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="../classes/_index_.nanohash.html#generate" class="tsd-kind-icon">generate</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="../classes/_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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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>