Skip to content

Commit 6302cfa

Browse files
committed
Updated docs
1 parent 30efd2b commit 6302cfa

File tree

10 files changed

+56
-44
lines changed

10 files changed

+56
-44
lines changed

docs/assets/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/classes/DB.html

Lines changed: 13 additions & 10 deletions
Large diffs are not rendered by default.

docs/classes/DBTransaction.html

Lines changed: 4 additions & 3 deletions
Large diffs are not rendered by default.

docs/classes/errors.ErrorDB.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/classes/errors.ErrorDBTransactionNotCommited.html renamed to docs/classes/errors.ErrorDBTransactionNotCommitted.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

docs/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ <h2>Benchmarks</h2>
2323
</a>
2424
<pre><code class="language-sh"><span class="hl-0">npm run bench</span>
2525
</code></pre>
26-
<p>View benchmarks here: <a href="https://github.com/MatrixAI/js-db/blob/master/benches/results/WorkerManager.chart.html">https://github.com/MatrixAI/js-db/blob/master/benches/results/WorkerManager.chart.html</a> with <a href="https://raw.githack.com/">https://raw.githack.com/</a></p>
26+
<p>View benchmarks here: <a href="https://github.com/MatrixAI/js-db/blob/master/benches/results">https://github.com/MatrixAI/js-db/blob/master/benches/results</a> with <a href="https://raw.githack.com/">https://raw.githack.com/</a></p>
2727

2828
<a href="#docs-generation" id="docs-generation" style="color: inherit; text-decoration: none;">
2929
<h3>Docs Generation</h3>
@@ -37,4 +37,4 @@ <h3>Publishing</h3>
3737
</a>
3838
<pre><code class="language-sh"><span class="hl-1"># npm login</span><br/><span class="hl-0">npm version patch </span><span class="hl-1"># 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>
3939
</code></pre>
40-
</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/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"><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-type-alias"><a href="modules.html#Crypto" class="tsd-kind-icon">Crypto</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#DBIterator" class="tsd-kind-icon">DBIterator</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#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"><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-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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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>
40+
</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/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"><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-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#DBIterator" class="tsd-kind-icon">DBIterator</a></li><li class="tsd-kind-type-alias"><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#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"><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-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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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)