Skip to content

Commit a1a1fa6

Browse files
CMCDragonkaiCMCDragonkai
committed
Updated docs
1 parent de901ec commit a1a1fa6

35 files changed

+534
-153
lines changed

‎docs/assets/highlight.css

+53-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,24 @@
11
:root {
22
--light-hl-0: #000000;
33
--dark-hl-0: #D4D4D4;
4-
--light-hl-1: #008000;
5-
--dark-hl-1: #6A9955;
6-
--light-hl-2: #795E26;
7-
--dark-hl-2: #DCDCAA;
4+
--light-hl-1: #AF00DB;
5+
--dark-hl-1: #C586C0;
6+
--light-hl-2: #001080;
7+
--dark-hl-2: #9CDCFE;
8+
--light-hl-3: #A31515;
9+
--dark-hl-3: #CE9178;
10+
--light-hl-4: #0000FF;
11+
--dark-hl-4: #569CD6;
12+
--light-hl-5: #795E26;
13+
--dark-hl-5: #DCDCAA;
14+
--light-hl-6: #0070C1;
15+
--dark-hl-6: #4FC1FF;
16+
--light-hl-7: #098658;
17+
--dark-hl-7: #B5CEA8;
18+
--light-hl-8: #267F99;
19+
--dark-hl-8: #4EC9B0;
20+
--light-hl-9: #008000;
21+
--dark-hl-9: #6A9955;
822
--light-code-background: #F5F5F5;
923
--dark-code-background: #1E1E1E;
1024
}
@@ -13,31 +27,66 @@
1327
--hl-0: var(--light-hl-0);
1428
--hl-1: var(--light-hl-1);
1529
--hl-2: var(--light-hl-2);
30+
--hl-3: var(--light-hl-3);
31+
--hl-4: var(--light-hl-4);
32+
--hl-5: var(--light-hl-5);
33+
--hl-6: var(--light-hl-6);
34+
--hl-7: var(--light-hl-7);
35+
--hl-8: var(--light-hl-8);
36+
--hl-9: var(--light-hl-9);
1637
--code-background: var(--light-code-background);
1738
} }
1839

1940
@media (prefers-color-scheme: dark) { :root {
2041
--hl-0: var(--dark-hl-0);
2142
--hl-1: var(--dark-hl-1);
2243
--hl-2: var(--dark-hl-2);
44+
--hl-3: var(--dark-hl-3);
45+
--hl-4: var(--dark-hl-4);
46+
--hl-5: var(--dark-hl-5);
47+
--hl-6: var(--dark-hl-6);
48+
--hl-7: var(--dark-hl-7);
49+
--hl-8: var(--dark-hl-8);
50+
--hl-9: var(--dark-hl-9);
2351
--code-background: var(--dark-code-background);
2452
} }
2553

2654
body.light {
2755
--hl-0: var(--light-hl-0);
2856
--hl-1: var(--light-hl-1);
2957
--hl-2: var(--light-hl-2);
58+
--hl-3: var(--light-hl-3);
59+
--hl-4: var(--light-hl-4);
60+
--hl-5: var(--light-hl-5);
61+
--hl-6: var(--light-hl-6);
62+
--hl-7: var(--light-hl-7);
63+
--hl-8: var(--light-hl-8);
64+
--hl-9: var(--light-hl-9);
3065
--code-background: var(--light-code-background);
3166
}
3267

3368
body.dark {
3469
--hl-0: var(--dark-hl-0);
3570
--hl-1: var(--dark-hl-1);
3671
--hl-2: var(--dark-hl-2);
72+
--hl-3: var(--dark-hl-3);
73+
--hl-4: var(--dark-hl-4);
74+
--hl-5: var(--dark-hl-5);
75+
--hl-6: var(--dark-hl-6);
76+
--hl-7: var(--dark-hl-7);
77+
--hl-8: var(--dark-hl-8);
78+
--hl-9: var(--dark-hl-9);
3779
--code-background: var(--dark-code-background);
3880
}
3981

4082
.hl-0 { color: var(--hl-0); }
4183
.hl-1 { color: var(--hl-1); }
4284
.hl-2 { color: var(--hl-2); }
85+
.hl-3 { color: var(--hl-3); }
86+
.hl-4 { color: var(--hl-4); }
87+
.hl-5 { color: var(--hl-5); }
88+
.hl-6 { color: var(--hl-6); }
89+
.hl-7 { color: var(--hl-7); }
90+
.hl-8 { color: var(--hl-8); }
91+
.hl-9 { color: var(--hl-9); }
4392
pre, code { background: var(--code-background); }

‎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

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

‎docs/classes/DBIterator.html

+1
Large diffs are not rendered by default.

‎docs/classes/DBTransaction.html

+36-2
Large diffs are not rendered by default.

‎docs/classes/errors.ErrorDB.html

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

‎docs/classes/errors.ErrorDBCreate.html

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

‎docs/classes/errors.ErrorDBDecrypt.html

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

‎docs/classes/errors.ErrorDBDelete.html

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

‎docs/classes/errors.ErrorDBDestroyed.html

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

‎docs/classes/errors.ErrorDBIterator.html

+29
Large diffs are not rendered by default.

‎docs/classes/errors.ErrorDBIteratorBusy.html

+29
Large diffs are not rendered by default.

‎docs/classes/errors.ErrorDBIteratorDestroyed.html

+29
Large diffs are not rendered by default.

‎docs/classes/errors.ErrorDBKey.html

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

‎docs/classes/errors.ErrorDBNotRunning.html

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

‎docs/classes/errors.ErrorDBParseKey.html

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

‎docs/classes/errors.ErrorDBParseValue.html

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

‎docs/classes/errors.ErrorDBRunning.html

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

‎docs/classes/errors.ErrorDBTransaction.html

+29
Large diffs are not rendered by default.

‎docs/classes/errors.ErrorDBTransactionCommitted.html

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

‎docs/classes/errors.ErrorDBTransactionConflict.html

+29
Large diffs are not rendered by default.

‎docs/classes/errors.ErrorDBTransactionDestroyed.html

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

‎docs/classes/errors.ErrorDBTransactionLockType.html

+29
Large diffs are not rendered by default.

‎docs/classes/errors.ErrorDBTransactionNotCommitted.html

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

‎docs/classes/errors.ErrorDBTransactionNotCommittedNorRollbacked.html

+29
Large diffs are not rendered by default.

‎docs/classes/errors.ErrorDBTransactionRollbacked.html

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

‎docs/index.html

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

‎docs/interfaces/FileSystem.html

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

‎docs/interfaces/ToString.html

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ToString | @matrixai/db</title><meta name="description" content="Documentation for @matrixai/db"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@matrixai/db</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></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="../modules.html">@matrixai/db</a></li><li><a href="ToString.html">ToString</a></li></ul><h1>Interface ToString </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">
2+
<p>Any type that can be turned into a string</p>
3+
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ToString</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>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="ToString.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li></ul></section></div></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-interface"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link">to<wbr/>String<a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/MatrixAI/js-db/blob/master/src/types.ts#L24">js-db/src/types.ts:24</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></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=""><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/rocksdb.html">rocksdb</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="current tsd-kind-interface"><a href="ToString.html" class="tsd-kind-icon">To<wbr/>String</a><ul><li class="tsd-kind-method tsd-parent-kind-interface"><a href="ToString.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li></ul></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>

‎docs/interfaces/rocksdb.RocksDB.html

+1
Large diffs are not rendered by default.

‎docs/interfaces/rocksdb.RocksDBP.html

+1
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)