Skip to content

Commit f5aeada

Browse files
committed
docs: updated docs
1 parent 4737d5c commit f5aeada

File tree

5 files changed

+36
-19
lines changed

5 files changed

+36
-19
lines changed

docs/assets/search.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/classes/DB.html

+9-9
Large diffs are not rendered by default.

docs/classes/DBIterator.html

+1-1
Large diffs are not rendered by default.

docs/classes/DBTransaction.html

+16-8
Large diffs are not rendered by default.

docs/index.html

+9
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ <h1>js-db</h1>
1111
<li>Supports Snapshot-Isolation based transactions via <code>DBTransaction</code></li>
1212
<li>API supports &quot;key paths&quot; which can be used to manipulate &quot;levels&quot; of nested keys</li>
1313
<li>Value encryption (key-encryption is not supported yet) - requires additional work with block-encryption</li>
14+
<li>Uses RocksDB</li>
1415
</ul>
1516

1617
<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
@@ -49,6 +50,14 @@ <h3>Docs Generation</h3>
4950
<a href="#publishing" id="publishing" style="color: inherit; text-decoration: none;">
5051
<h3>Publishing</h3>
5152
</a>
53+
<p>Publishing is handled automatically by the staging pipeline.</p>
54+
<p>Prerelease:</p>
55+
<pre><code class="language-sh"><span class="hl-9"># npm login</span><br/><span class="hl-0">npm version prepatch --preid alpha </span><span class="hl-9"># premajor/preminor/prepatch</span><br/><span class="hl-0">git push --follow-tags</span>
56+
</code></pre>
57+
<p>Release:</p>
58+
<pre><code class="language-sh"><span class="hl-9"># npm login</span><br/><span class="hl-0">npm version patch </span><span class="hl-9"># major/minor/patch</span><br/><span class="hl-0">git push --follow-tags</span>
59+
</code></pre>
60+
<p>Manually:</p>
5261
<pre><code class="language-sh"><span class="hl-9"># npm login</span><br/><span class="hl-0">npm version patch </span><span class="hl-9"># major/minor/patch</span><br/><span class="hl-0">npm run build</span><br/><span class="hl-0">npm publish --access public</span><br/><span class="hl-0">git push</span><br/><span class="hl-0">git push --tags</span>
5362
</code></pre>
5463
</div></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><li class=" tsd-kind-namespace"><a href="modules/errors.html">errors</a></li><li class=" tsd-kind-namespace"><a href="modules/native.html">native</a></li><li class=" tsd-kind-namespace"><a href="modules/utils.html">utils</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class"><a href="classes/DB.html" class="tsd-kind-icon">DB</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/DBIterator.html" class="tsd-kind-icon">DBIterator</a></li><li class="tsd-kind-class"><a href="classes/DBTransaction.html" class="tsd-kind-icon">DBTransaction</a></li><li class="tsd-kind-interface"><a href="interfaces/FileSystem.html" class="tsd-kind-icon">File<wbr/>System</a></li><li class="tsd-kind-interface"><a href="interfaces/ToString.html" class="tsd-kind-icon">To<wbr/>String</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#Callback" class="tsd-kind-icon">Callback</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Crypto" class="tsd-kind-icon">Crypto</a></li><li class="tsd-kind-type-alias"><a href="modules.html#DBBatch" class="tsd-kind-icon">DBBatch</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#DBClearOptions" class="tsd-kind-icon">DBClear<wbr/>Options</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#DBCountOptions" class="tsd-kind-icon">DBCount<wbr/>Options</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#DBIteratorOptions" class="tsd-kind-icon">DBIterator<wbr/>Options</a></li><li class="tsd-kind-type-alias"><a href="modules.html#DBOp" class="tsd-kind-icon">DBOp</a></li><li class="tsd-kind-type-alias"><a href="modules.html#DBOps" class="tsd-kind-icon">DBOps</a></li><li class="tsd-kind-type-alias"><a href="modules.html#DBOptions" class="tsd-kind-icon">DBOptions</a></li><li class="tsd-kind-type-alias"><a href="modules.html#DBWorkerManagerInterface" class="tsd-kind-icon">DBWorker<wbr/>Manager<wbr/>Interface</a></li><li class="tsd-kind-type-alias"><a href="modules.html#KeyPath" class="tsd-kind-icon">Key<wbr/>Path</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LevelPath" class="tsd-kind-icon">Level<wbr/>Path</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#Merge" class="tsd-kind-icon">Merge</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MultiLockRequest" class="tsd-kind-icon">Multi<wbr/>Lock<wbr/>Request</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#Opaque" class="tsd-kind-icon">Opaque</a></li><li class="tsd-kind-type-alias"><a href="modules.html#POJO" class="tsd-kind-icon">POJO</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><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></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/main.js"></script></body></html>

0 commit comments

Comments
 (0)