Skip to content

Commit

Permalink
Updated docs and tsconfig to support JSON and decorators
Browse files Browse the repository at this point in the history
  • Loading branch information
@CMCDragonkai
CMCDragonkai committed Nov 8, 2021
1 parent fe66d06 commit b8ebdcf
Show file tree
Hide file tree
Showing 24 changed files with 1,313 additions and 183 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

88 changes: 51 additions & 37 deletions docs/classes/DB.default.html
View file

Large diffs are not rendered by default.

50 changes: 25 additions & 25 deletions docs/classes/Transaction.default.html
View file

Large diffs are not rendered by default.

60 changes: 44 additions & 16 deletions docs/classes/errors.ErrorDB.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,12 @@ <h3>Hierarchy</h3>
<li>
<a href="errors.ErrorDBDestroyed.html" class="tsd-signature-type" data-tsd-kind="Class">ErrorDBDestroyed</a>
</li>
<li>
<a href="errors.ErrorDBCreate.html" class="tsd-signature-type" data-tsd-kind="Class">ErrorDBCreate</a>
</li>
<li>
<a href="errors.ErrorDBDelete.html" class="tsd-signature-type" data-tsd-kind="Class">ErrorDBDelete</a>
</li>
<li>
<a href="errors.ErrorDBLevelPrefix.html" class="tsd-signature-type" data-tsd-kind="Class">ErrorDBLevelPrefix</a>
</li>
Expand Down Expand Up @@ -114,15 +120,16 @@ <h3>Hierarchy</h3>
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="errors.ErrorDB.html#constructor" class="tsd-kind-icon">constructor</a></li>
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="errors.ErrorDB.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited tsd-is-external">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="errors.ErrorDB.html#data" class="tsd-kind-icon">data</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.ErrorDB.html#message" class="tsd-kind-icon">message</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.ErrorDB.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.ErrorDB.html#stack" class="tsd-kind-icon">stack</a></li>
Expand All @@ -139,35 +146,48 @@ <h3>Methods</h3>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>ErrorDB<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="errors.ErrorDB.html" class="tsd-signature-type" data-tsd-kind="Class">ErrorDB</a></li>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>ErrorDB<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><a href="../modules/types.html#POJO" class="tsd-signature-type" data-tsd-kind="Type alias">POJO</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="errors.ErrorDB.html" class="tsd-signature-type" data-tsd-kind="Class">ErrorDB</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from CustomError.constructor</p>
<p>Overrides CustomError.constructor</p>
<ul>
<li>Defined in node_modules/ts-custom-error/dist/custom-error.d.ts:3</li>
<li>Defined in <a href="https://github.com/MatrixAI/js-db/blob/master/src/errors.ts#L7">src/errors.ts:7</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> message: <span class="tsd-signature-type">string</span></h5>
<h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x27;&#x27;</span></h5>
</li>
<li>
<h5>data: <a href="../modules/types.html#POJO" class="tsd-signature-type" data-tsd-kind="Type alias">POJO</a><span class="tsd-signature-symbol"> = {}</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="errors.ErrorDB.html" class="tsd-signature-type" data-tsd-kind="Class">ErrorDB</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-external">
<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="data" class="tsd-anchor"></a>
<h3>data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <a href="../modules/types.html#POJO" class="tsd-signature-type" data-tsd-kind="Type alias">POJO</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/MatrixAI/js-db/blob/master/src/errors.ts#L6">src/errors.ts:6</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="message" class="tsd-anchor"></a>
<h3>message</h3>
Expand Down Expand Up @@ -322,9 +342,12 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<li class="current tsd-kind-class tsd-parent-kind-module">
<a href="errors.ErrorDB.html" class="tsd-kind-icon">ErrorDB</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="errors.ErrorDB.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="errors.ErrorDB.html#data" class="tsd-kind-icon">data</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="errors.ErrorDB.html#message" class="tsd-kind-icon">message</a>
</li>
Expand All @@ -350,9 +373,15 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="errors.ErrorDBCommitted.html" class="tsd-kind-icon">ErrorDBCommitted</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="errors.ErrorDBCreate.html" class="tsd-kind-icon">ErrorDBCreate</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="errors.ErrorDBDecrypt.html" class="tsd-kind-icon">ErrorDBDecrypt</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="errors.ErrorDBDelete.html" class="tsd-kind-icon">ErrorDBDelete</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="errors.ErrorDBDestroyed.html" class="tsd-kind-icon">ErrorDBDestroyed</a>
</li>
Expand Down Expand Up @@ -388,14 +417,13 @@ <h2>Legend</h2>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<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>
</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-interface"><span class="tsd-kind-icon">Interface</span></li>
</ul>
</div>
</div>
Expand Down
41 changes: 33 additions & 8 deletions docs/classes/errors.ErrorDBCommitted.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,10 @@ <h3>Constructors</h3>
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="errors.ErrorDBCommitted.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited tsd-is-external">
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="errors.ErrorDBCommitted.html#data" class="tsd-kind-icon">data</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.ErrorDBCommitted.html#message" class="tsd-kind-icon">message</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.ErrorDBCommitted.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.ErrorDBCommitted.html#stack" class="tsd-kind-icon">stack</a></li>
Expand All @@ -116,29 +117,43 @@ <h2>Constructors</h2>
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>ErrorDBCommitted<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="errors.ErrorDBCommitted.html" class="tsd-signature-type" data-tsd-kind="Class">ErrorDBCommitted</a></li>
<li class="tsd-signature tsd-kind-icon">new <wbr>ErrorDBCommitted<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><a href="../modules/types.html#POJO" class="tsd-signature-type" data-tsd-kind="Type alias">POJO</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="errors.ErrorDBCommitted.html" class="tsd-signature-type" data-tsd-kind="Class">ErrorDBCommitted</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="errors.ErrorDB.html">ErrorDB</a>.<a href="errors.ErrorDB.html#constructor">constructor</a></p>
<ul>
<li>Defined in node_modules/ts-custom-error/dist/custom-error.d.ts:3</li>
<li>Defined in <a href="https://github.com/MatrixAI/js-db/blob/master/src/errors.ts#L7">src/errors.ts:7</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> message: <span class="tsd-signature-type">string</span></h5>
<h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x27;&#x27;</span></h5>
</li>
<li>
<h5>data: <a href="../modules/types.html#POJO" class="tsd-signature-type" data-tsd-kind="Type alias">POJO</a><span class="tsd-signature-symbol"> = {}</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="errors.ErrorDBCommitted.html" class="tsd-signature-type" data-tsd-kind="Class">ErrorDBCommitted</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-external">
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="data" class="tsd-anchor"></a>
<h3>data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <a href="../modules/types.html#POJO" class="tsd-signature-type" data-tsd-kind="Type alias">POJO</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="errors.ErrorDB.html">ErrorDB</a>.<a href="errors.ErrorDB.html#data">data</a></p>
<ul>
<li>Defined in <a href="https://github.com/MatrixAI/js-db/blob/master/src/errors.ts#L6">src/errors.ts:6</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="message" class="tsd-anchor"></a>
<h3>message</h3>
Expand Down Expand Up @@ -299,6 +314,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a href="errors.ErrorDBCommitted.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="errors.ErrorDBCommitted.html#data" class="tsd-kind-icon">data</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="errors.ErrorDBCommitted.html#message" class="tsd-kind-icon">message</a>
</li>
Expand All @@ -321,9 +339,15 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="errors.ErrorDBCreate.html" class="tsd-kind-icon">ErrorDBCreate</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="errors.ErrorDBDecrypt.html" class="tsd-kind-icon">ErrorDBDecrypt</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="errors.ErrorDBDelete.html" class="tsd-kind-icon">ErrorDBDelete</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="errors.ErrorDBDestroyed.html" class="tsd-kind-icon">ErrorDBDestroyed</a>
</li>
Expand Down Expand Up @@ -360,13 +384,14 @@ <h2>Legend</h2>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<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-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</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-class"><span class="tsd-kind-icon">Class</span></li>
</ul>
</div>
</div>
Expand Down
Loading

0 comments on commit b8ebdcf

Please sign in to comment.