diff options
| author | Nick Van Doorn <vandoorn.nick@gmail.com> | 2019-03-02 02:53:12 -0800 |
|---|---|---|
| committer | Nick Van Doorn <vandoorn.nick@gmail.com> | 2019-03-02 02:54:02 -0800 |
| commit | 6ab09f89019dcfa7942dfcf261a5d2fd0fcd6e47 (patch) | |
| tree | 807dfe23b54988749deddc2bab517942ce161b2d | |
| parent | 438b369d5efdfdf8e7ea3b70540f5e7cf9929e93 (diff) | |
Docz
36 files changed, 112 insertions, 135 deletions
diff --git a/client/readme.md b/client/readme.md index 92753d4..b9eef81 100644 --- a/client/readme.md +++ b/client/readme.md @@ -1,9 +1,3 @@ -# naive +# naive-client - - -[Read the docs](https://nvandoorn.github.io/naive/) - -A small NoSQL database with an API similar to Firebase backed by a static JSON file. - -Useful for prototyping or situations where size is small and data integrity is not that important +Connect your client to a hosted `naive-core` instance using `naive-server`. diff --git a/core/readme.md b/core/readme.md index 92753d4..dc7fad9 100644 --- a/core/readme.md +++ b/core/readme.md @@ -1,9 +1,3 @@ -# naive +# naive-core - - -[Read the docs](https://nvandoorn.github.io/naive/) - -A small NoSQL database with an API similar to Firebase backed by a static JSON file. - -Useful for prototyping or situations where size is small and data integrity is not that important +Implements the core of the `naive` database. Most users will interact with this package using `naive-client` and `naive-server`. diff --git a/docs/client/index.html b/docs/client/index.html index 7aa6a0c..af54dd1 100644 --- a/docs/client/index.html +++ b/docs/client/index.html @@ -64,11 +64,8 @@ <div class="row"> <div class="col-8 col-content"> <div class="tsd-panel tsd-typography"> - <h1 id="naive">naive</h1> - <p><img src="https://api.travis-ci.org/nvandoorn/naive.svg?branch=master" alt="build status" title="Build Status"></p> - <p><a href="https://nvandoorn.github.io/naive/">Read the docs</a></p> - <p>A small NoSQL database with an API similar to Firebase backed by a static JSON file.</p> - <p>Useful for prototyping or situations where size is small and data integrity is not that important</p> + <h1 id="naive-client">naive-client</h1> + <p>Connect your client to a hosted <code>naive-core</code> instance using <code>naive-server</code>.</p> </div> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> diff --git a/docs/client/interfaces/_client_src_config_model_.config.html b/docs/client/interfaces/_client_src_config_model_.config.html index c704d71..ac36102 100644 --- a/docs/client/interfaces/_client_src_config_model_.config.html +++ b/docs/client/interfaces/_client_src_config_model_.config.html @@ -99,7 +99,7 @@ <div class="tsd-signature tsd-kind-icon">http<wbr>Url<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/nvandoorn/naive/blob/cc3c82a/client/src/config.model.ts#L3">client/src/config.model.ts:3</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/client/src/config.model.ts#L3">client/src/config.model.ts:3</a></li> </ul> </aside> </section> @@ -109,7 +109,7 @@ <div class="tsd-signature tsd-kind-icon">ws<wbr>Url<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/nvandoorn/naive/blob/cc3c82a/client/src/config.model.ts#L2">client/src/config.model.ts:2</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/client/src/config.model.ts#L2">client/src/config.model.ts:2</a></li> </ul> </aside> </section> diff --git a/docs/client/interfaces/_client_src_database_connection_.callbackref.html b/docs/client/interfaces/_client_src_database_connection_.callbackref.html index f08a269..cae899b 100644 --- a/docs/client/interfaces/_client_src_database_connection_.callbackref.html +++ b/docs/client/interfaces/_client_src_database_connection_.callbackref.html @@ -99,7 +99,7 @@ <div class="tsd-signature tsd-kind-icon">callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/client/src/database-connection.ts#L24">client/src/database-connection.ts:24</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/client/src/database-connection.ts#L24">client/src/database-connection.ts:24</a></li> </ul> </aside> <div class="tsd-type-declaration"> @@ -130,7 +130,7 @@ <div class="tsd-signature tsd-kind-icon">id<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/nvandoorn/naive/blob/cc3c82a/client/src/database-connection.ts#L23">client/src/database-connection.ts:23</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/client/src/database-connection.ts#L23">client/src/database-connection.ts:23</a></li> </ul> </aside> </section> diff --git a/docs/client/interfaces/_client_src_database_connection_model_.databaseconnection.html b/docs/client/interfaces/_client_src_database_connection_model_.databaseconnection.html index 572a9da..d8321f1 100644 --- a/docs/client/interfaces/_client_src_database_connection_model_.databaseconnection.html +++ b/docs/client/interfaces/_client_src_database_connection_model_.databaseconnection.html @@ -107,7 +107,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/client/src/database-connection.model.ts#L3">client/src/database-connection.model.ts:3</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/client/src/database-connection.model.ts#L3">client/src/database-connection.model.ts:3</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> @@ -124,7 +124,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/client/src/database-connection.model.ts#L2">client/src/database-connection.model.ts:2</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/client/src/database-connection.model.ts#L2">client/src/database-connection.model.ts:2</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> @@ -141,7 +141,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/client/src/database-connection.model.ts#L6">client/src/database-connection.model.ts:6</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/client/src/database-connection.model.ts#L6">client/src/database-connection.model.ts:6</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> @@ -164,7 +164,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/client/src/database-connection.model.ts#L7">client/src/database-connection.model.ts:7</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/client/src/database-connection.model.ts#L7">client/src/database-connection.model.ts:7</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> @@ -187,7 +187,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/client/src/database-connection.model.ts#L4">client/src/database-connection.model.ts:4</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/client/src/database-connection.model.ts#L4">client/src/database-connection.model.ts:4</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> @@ -231,7 +231,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/client/src/database-connection.model.ts#L5">client/src/database-connection.model.ts:5</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/client/src/database-connection.model.ts#L5">client/src/database-connection.model.ts:5</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> diff --git a/docs/client/interfaces/_lib_database_change_model_.databasechange.html b/docs/client/interfaces/_lib_database_change_model_.databasechange.html index 99c2edf..52396c2 100644 --- a/docs/client/interfaces/_lib_database_change_model_.databasechange.html +++ b/docs/client/interfaces/_lib_database_change_model_.databasechange.html @@ -99,7 +99,7 @@ <div class="tsd-signature tsd-kind-icon">change<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Object</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/lib/database-change.model.ts#L3">lib/database-change.model.ts:3</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/lib/database-change.model.ts#L3">lib/database-change.model.ts:3</a></li> </ul> </aside> </section> @@ -109,7 +109,7 @@ <div class="tsd-signature tsd-kind-icon">path<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/nvandoorn/naive/blob/cc3c82a/lib/database-change.model.ts#L2">lib/database-change.model.ts:2</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/lib/database-change.model.ts#L2">lib/database-change.model.ts:2</a></li> </ul> </aside> </section> diff --git a/docs/client/modules/_client_src_database_connection_.html b/docs/client/modules/_client_src_database_connection_.html index 1f446c7..5f0c89a 100644 --- a/docs/client/modules/_client_src_database_connection_.html +++ b/docs/client/modules/_client_src_database_connection_.html @@ -99,7 +99,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/client/src/database-connection.ts#L32">client/src/database-connection.ts:32</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/client/src/database-connection.ts#L32">client/src/database-connection.ts:32</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -129,7 +129,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/client/src/database-connection.ts#L10">client/src/database-connection.ts:10</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/client/src/database-connection.ts#L10">client/src/database-connection.ts:10</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> diff --git a/docs/client/modules/_lib_path_.html b/docs/client/modules/_lib_path_.html index 6cf6223..44d586f 100644 --- a/docs/client/modules/_lib_path_.html +++ b/docs/client/modules/_lib_path_.html @@ -92,7 +92,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in lib/path.ts:7</li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/lib/path.ts#L7">lib/path.ts:7</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> @@ -115,7 +115,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in lib/path.ts:1</li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/lib/path.ts#L1">lib/path.ts:1</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> diff --git a/docs/client/modules/_lib_util_.html b/docs/client/modules/_lib_util_.html index 76d58fc..deb3d67 100644 --- a/docs/client/modules/_lib_util_.html +++ b/docs/client/modules/_lib_util_.html @@ -92,7 +92,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/lib/util.ts#L9">lib/util.ts:9</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/lib/util.ts#L9">lib/util.ts:9</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -120,7 +120,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/lib/util.ts#L4">lib/util.ts:4</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/lib/util.ts#L4">lib/util.ts:4</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> diff --git a/docs/core/classes/_core_src_database_.database.html b/docs/core/classes/_core_src_database_.database.html index 8f46e5c..20c49d9 100644 --- a/docs/core/classes/_core_src_database_.database.html +++ b/docs/core/classes/_core_src_database_.database.html @@ -145,7 +145,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.ts#L62">core/src/database.ts:62</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.ts#L62">core/src/database.ts:62</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> @@ -167,7 +167,7 @@ <div class="tsd-signature tsd-kind-icon">buff<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.ts#L56">core/src/database.ts:56</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.ts#L56">core/src/database.ts:56</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -182,7 +182,7 @@ <div class="tsd-signature tsd-kind-icon">change<wbr>Handlers<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_core_src_change_handlers_model_.changehandlers.html" class="tsd-signature-type">ChangeHandlers</a></div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.ts#L62">core/src/database.ts:62</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.ts#L62">core/src/database.ts:62</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -199,7 +199,7 @@ <div class="tsd-signature tsd-kind-icon">ctx<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_core_src_context_model_.context.html" class="tsd-signature-type">Context</a></div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.ts#L63">core/src/database.ts:63</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.ts#L63">core/src/database.ts:63</a></li> </ul> </aside> </section> @@ -217,7 +217,7 @@ <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_core_src_database_model_.databaseinterface.html">DatabaseInterface</a>.<a href="../interfaces/_core_src_database_model_.databaseinterface.html#flush">flush</a></p> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.ts#L124">core/src/database.ts:124</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.ts#L124">core/src/database.ts:124</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> @@ -234,7 +234,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.ts#L201">core/src/database.ts:201</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.ts#L201">core/src/database.ts:201</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> @@ -252,7 +252,7 @@ <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_core_src_database_model_.databaseinterface.html">DatabaseInterface</a>.<a href="../interfaces/_core_src_database_model_.databaseinterface.html#init">init</a></p> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.ts#L65">core/src/database.ts:65</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.ts#L65">core/src/database.ts:65</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> @@ -270,7 +270,7 @@ <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_core_src_database_model_.databaseinterface.html">DatabaseInterface</a>.<a href="../interfaces/_core_src_database_model_.databaseinterface.html#read">read</a></p> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.ts#L78">core/src/database.ts:78</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.ts#L78">core/src/database.ts:78</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> @@ -294,7 +294,7 @@ <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_core_src_database_model_.databaseinterface.html">DatabaseInterface</a>.<a href="../interfaces/_core_src_database_model_.databaseinterface.html#remove">remove</a></p> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.ts#L120">core/src/database.ts:120</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.ts#L120">core/src/database.ts:120</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> @@ -317,7 +317,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.ts#L145">core/src/database.ts:145</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.ts#L145">core/src/database.ts:145</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -358,7 +358,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.ts#L98">core/src/database.ts:98</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.ts#L98">core/src/database.ts:98</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> @@ -384,7 +384,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.ts#L196">core/src/database.ts:196</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.ts#L196">core/src/database.ts:196</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -410,7 +410,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.ts#L107">core/src/database.ts:107</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.ts#L107">core/src/database.ts:107</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> @@ -467,7 +467,7 @@ <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_core_src_database_model_.databaseinterface.html">DatabaseInterface</a>.<a href="../interfaces/_core_src_database_model_.databaseinterface.html#tostring">toString</a></p> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.ts#L129">core/src/database.ts:129</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.ts#L129">core/src/database.ts:129</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> @@ -484,7 +484,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.ts#L116">core/src/database.ts:116</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.ts#L116">core/src/database.ts:116</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> @@ -507,7 +507,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.ts#L85">core/src/database.ts:85</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.ts#L85">core/src/database.ts:85</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> diff --git a/docs/core/classes/_lib_error_model_.naiveerror.html b/docs/core/classes/_lib_error_model_.naiveerror.html index cef897e..ad54e19 100644 --- a/docs/core/classes/_lib_error_model_.naiveerror.html +++ b/docs/core/classes/_lib_error_model_.naiveerror.html @@ -117,7 +117,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/lib/error.model.ts#L18">lib/error.model.ts:18</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/lib/error.model.ts#L18">lib/error.model.ts:18</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> @@ -139,7 +139,7 @@ <div class="tsd-signature tsd-kind-icon">code<span class="tsd-signature-symbol">:</span> <a href="../enums/_lib_error_model_.naiveerrorcode.html" class="tsd-signature-type">NaiveErrorCode</a></div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/lib/error.model.ts#L19">lib/error.model.ts:19</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/lib/error.model.ts#L19">lib/error.model.ts:19</a></li> </ul> </aside> </section> diff --git a/docs/core/enums/_lib_error_model_.naiveerrorcode.html b/docs/core/enums/_lib_error_model_.naiveerrorcode.html index e58cb48..8a3bcf7 100644 --- a/docs/core/enums/_lib_error_model_.naiveerrorcode.html +++ b/docs/core/enums/_lib_error_model_.naiveerrorcode.html @@ -91,7 +91,7 @@ <div class="tsd-signature tsd-kind-icon">OUT_<wbr>OF_<wbr>SPACE<span class="tsd-signature-symbol">:</span> </div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/lib/error.model.ts#L3">lib/error.model.ts:3</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/lib/error.model.ts#L3">lib/error.model.ts:3</a></li> </ul> </aside> </section> @@ -101,7 +101,7 @@ <div class="tsd-signature tsd-kind-icon">UNCAUGHT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 0</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/lib/error.model.ts#L2">lib/error.model.ts:2</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/lib/error.model.ts#L2">lib/error.model.ts:2</a></li> </ul> </aside> </section> diff --git a/docs/core/index.html b/docs/core/index.html index cf0fb9b..dbb94ba 100644 --- a/docs/core/index.html +++ b/docs/core/index.html @@ -64,11 +64,8 @@ <div class="row"> <div class="col-8 col-content"> <div class="tsd-panel tsd-typography"> - <h1 id="naive">naive</h1> - <p><img src="https://api.travis-ci.org/nvandoorn/naive.svg?branch=master" alt="build status" title="Build Status"></p> - <p><a href="https://nvandoorn.github.io/naive/">Read the docs</a></p> - <p>A small NoSQL database with an API similar to Firebase backed by a static JSON file.</p> - <p>Useful for prototyping or situations where size is small and data integrity is not that important</p> + <h1 id="naive-core">naive-core</h1> + <p>Implements the core of the <code>naive</code> database. Most users will interact with this package using <code>naive-client</code> and <code>naive-server</code>.</p> </div> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> diff --git a/docs/core/interfaces/_core_src_context_model_.context.html b/docs/core/interfaces/_core_src_context_model_.context.html index 8808f52..cd41b55 100644 --- a/docs/core/interfaces/_core_src_context_model_.context.html +++ b/docs/core/interfaces/_core_src_context_model_.context.html @@ -100,7 +100,7 @@ <div class="tsd-signature tsd-kind-icon">cache<wbr>Path<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/nvandoorn/naive/blob/cc3c82a/core/src/context.model.ts#L13">core/src/context.model.ts:13</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/context.model.ts#L13">core/src/context.model.ts:13</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -115,7 +115,7 @@ <div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/context.model.ts#L9">core/src/context.model.ts:9</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/context.model.ts#L9">core/src/context.model.ts:9</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -154,7 +154,7 @@ <div class="tsd-signature tsd-kind-icon">max<wbr>DbSizeMB<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/nvandoorn/naive/blob/cc3c82a/core/src/context.model.ts#L17">core/src/context.model.ts:17</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/context.model.ts#L17">core/src/context.model.ts:17</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> diff --git a/docs/core/interfaces/_core_src_database_model_.databaseinterface.html b/docs/core/interfaces/_core_src_database_model_.databaseinterface.html index 9131367..e36a3f4 100644 --- a/docs/core/interfaces/_core_src_database_model_.databaseinterface.html +++ b/docs/core/interfaces/_core_src_database_model_.databaseinterface.html @@ -114,7 +114,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.model.ts#L45">core/src/database.model.ts:45</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.model.ts#L45">core/src/database.model.ts:45</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -136,7 +136,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.model.ts#L10">core/src/database.model.ts:10</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.model.ts#L10">core/src/database.model.ts:10</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -162,7 +162,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.model.ts#L19">core/src/database.model.ts:19</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.model.ts#L19">core/src/database.model.ts:19</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -193,7 +193,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.model.ts#L40">core/src/database.model.ts:40</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.model.ts#L40">core/src/database.model.ts:40</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -221,7 +221,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.model.ts#L24">core/src/database.model.ts:24</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.model.ts#L24">core/src/database.model.ts:24</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -282,7 +282,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.model.ts#L50">core/src/database.model.ts:50</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.model.ts#L50">core/src/database.model.ts:50</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -304,7 +304,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.model.ts#L35">core/src/database.model.ts:35</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.model.ts#L35">core/src/database.model.ts:35</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> diff --git a/docs/core/modules/_core_src_database_.html b/docs/core/modules/_core_src_database_.html index 7aa1d57..f9dc5a6 100644 --- a/docs/core/modules/_core_src_database_.html +++ b/docs/core/modules/_core_src_database_.html @@ -108,7 +108,7 @@ <div class="tsd-signature tsd-kind-icon">read<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">__promisify__</span><span class="tsd-signature-symbol"> = promisify(readFile)</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.ts#L34">core/src/database.ts:34</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.ts#L34">core/src/database.ts:34</a></li> </ul> </aside> </section> @@ -118,7 +118,7 @@ <div class="tsd-signature tsd-kind-icon">write<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">__promisify__</span><span class="tsd-signature-symbol"> = promisify(writeFile)</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.ts#L33">core/src/database.ts:33</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.ts#L33">core/src/database.ts:33</a></li> </ul> </aside> </section> @@ -135,7 +135,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.ts#L27">core/src/database.ts:27</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.ts#L27">core/src/database.ts:27</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -168,7 +168,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.ts#L19">core/src/database.ts:19</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.ts#L19">core/src/database.ts:19</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -196,7 +196,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.ts#L14">core/src/database.ts:14</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.ts#L14">core/src/database.ts:14</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -223,7 +223,7 @@ <div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>CTX<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.ts#L36">core/src/database.ts:36</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.ts#L36">core/src/database.ts:36</a></li> </ul> </aside> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> @@ -232,7 +232,7 @@ <div class="tsd-signature tsd-kind-icon">cache<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = `${__dirname}/db.json`</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.ts#L38">core/src/database.ts:38</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.ts#L38">core/src/database.ts:38</a></li> </ul> </aside> </section> @@ -242,7 +242,7 @@ <div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">log</span><span class="tsd-signature-symbol"> = console.log</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.ts#L37">core/src/database.ts:37</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.ts#L37">core/src/database.ts:37</a></li> </ul> </aside> </section> @@ -252,7 +252,7 @@ <div class="tsd-signature tsd-kind-icon">max<wbr>DbSizeMB<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 6</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.ts#L39">core/src/database.ts:39</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.ts#L39">core/src/database.ts:39</a></li> </ul> </aside> </section> diff --git a/docs/core/modules/_core_src_database_test_.html b/docs/core/modules/_core_src_database_test_.html index 1f4ab26..65a6351 100644 --- a/docs/core/modules/_core_src_database_test_.html +++ b/docs/core/modules/_core_src_database_test_.html @@ -93,7 +93,7 @@ <div class="tsd-signature tsd-kind-icon">max<wbr>DbSizeMB<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">0.1</span><span class="tsd-signature-symbol"> = 0.1</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.test.ts#L9">core/src/database.test.ts:9</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.test.ts#L9">core/src/database.test.ts:9</a></li> </ul> </aside> </section> @@ -110,7 +110,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/core/src/database.test.ts#L4">core/src/database.test.ts:4</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/core/src/database.test.ts#L4">core/src/database.test.ts:4</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> diff --git a/docs/core/modules/_lib_error_model_.html b/docs/core/modules/_lib_error_model_.html index 6e9c37a..a46cfad 100644 --- a/docs/core/modules/_lib_error_model_.html +++ b/docs/core/modules/_lib_error_model_.html @@ -105,7 +105,7 @@ <div class="tsd-signature tsd-kind-icon">e<span class="tsd-signature-symbol">:</span> <a href="../enums/_lib_error_model_.naiveerrorcode.html" class="tsd-signature-type">NaiveErrorCode</a><span class="tsd-signature-symbol"> = NaiveErrorCode</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/lib/error.model.ts#L6">lib/error.model.ts:6</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/lib/error.model.ts#L6">lib/error.model.ts:6</a></li> </ul> </aside> </section> @@ -122,7 +122,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/lib/error.model.ts#L8">lib/error.model.ts:8</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/lib/error.model.ts#L8">lib/error.model.ts:8</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> diff --git a/docs/core/modules/_lib_util_.html b/docs/core/modules/_lib_util_.html index 1a098df..adfad3f 100644 --- a/docs/core/modules/_lib_util_.html +++ b/docs/core/modules/_lib_util_.html @@ -92,7 +92,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/lib/util.ts#L9">lib/util.ts:9</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/lib/util.ts#L9">lib/util.ts:9</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -120,7 +120,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/lib/util.ts#L4">lib/util.ts:4</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/lib/util.ts#L4">lib/util.ts:4</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> diff --git a/docs/server/index.html b/docs/server/index.html index b1cd21c..5ea0cd6 100644 --- a/docs/server/index.html +++ b/docs/server/index.html @@ -64,11 +64,8 @@ <div class="row"> <div class="col-8 col-content"> <div class="tsd-panel tsd-typography"> - <h1 id="naive">naive</h1> - <p><img src="https://api.travis-ci.org/nvandoorn/naive.svg?branch=master" alt="build status" title="Build Status"></p> - <p><a href="https://nvandoorn.github.io/naive/">Read the docs</a></p> - <p>A small NoSQL database with an API similar to Firebase backed by a static JSON file.</p> - <p>Useful for prototyping or situations where size is small and data integrity is not that important</p> + <h1 id="naive-server">naive-server</h1> + <p>Serve a <code>naive-core</code> instance.</p> </div> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> diff --git a/docs/server/interfaces/_client_src_config_model_.config.html b/docs/server/interfaces/_client_src_config_model_.config.html index e03eda6..d18a0d9 100644 --- a/docs/server/interfaces/_client_src_config_model_.config.html +++ b/docs/server/interfaces/_client_src_config_model_.config.html @@ -99,7 +99,7 @@ <div class="tsd-signature tsd-kind-icon">http<wbr>Url<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/nvandoorn/naive/blob/cc3c82a/client/src/config.model.ts#L3">client/src/config.model.ts:3</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/client/src/config.model.ts#L3">client/src/config.model.ts:3</a></li> </ul> </aside> </section> @@ -109,7 +109,7 @@ <div class="tsd-signature tsd-kind-icon">ws<wbr>Url<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/nvandoorn/naive/blob/cc3c82a/client/src/config.model.ts#L2">client/src/config.model.ts:2</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/client/src/config.model.ts#L2">client/src/config.model.ts:2</a></li> </ul> </aside> </section> diff --git a/docs/server/interfaces/_client_src_database_connection_.callbackref.html b/docs/server/interfaces/_client_src_database_connection_.callbackref.html index 026f90a..6e87d7f 100644 --- a/docs/server/interfaces/_client_src_database_connection_.callbackref.html +++ b/docs/server/interfaces/_client_src_database_connection_.callbackref.html @@ -99,7 +99,7 @@ <div class="tsd-signature tsd-kind-icon">callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/client/src/database-connection.ts#L24">client/src/database-connection.ts:24</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/client/src/database-connection.ts#L24">client/src/database-connection.ts:24</a></li> </ul> </aside> <div class="tsd-type-declaration"> @@ -130,7 +130,7 @@ <div class="tsd-signature tsd-kind-icon">id<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/nvandoorn/naive/blob/cc3c82a/client/src/database-connection.ts#L23">client/src/database-connection.ts:23</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/client/src/database-connection.ts#L23">client/src/database-connection.ts:23</a></li> </ul> </aside> </section> diff --git a/docs/server/interfaces/_client_src_database_connection_model_.databaseconnection.html b/docs/server/interfaces/_client_src_database_connection_model_.databaseconnection.html index 0beeb92..e443d1a 100644 --- a/docs/server/interfaces/_client_src_database_connection_model_.databaseconnection.html +++ b/docs/server/interfaces/_client_src_database_connection_model_.databaseconnection.html @@ -107,7 +107,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/client/src/database-connection.model.ts#L3">client/src/database-connection.model.ts:3</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/client/src/database-connection.model.ts#L3">client/src/database-connection.model.ts:3</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> @@ -124,7 +124,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/client/src/database-connection.model.ts#L2">client/src/database-connection.model.ts:2</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/client/src/database-connection.model.ts#L2">client/src/database-connection.model.ts:2</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> @@ -141,7 +141,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/client/src/database-connection.model.ts#L6">client/src/database-connection.model.ts:6</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/client/src/database-connection.model.ts#L6">client/src/database-connection.model.ts:6</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> @@ -164,7 +164,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/client/src/database-connection.model.ts#L7">client/src/database-connection.model.ts:7</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/client/src/database-connection.model.ts#L7">client/src/database-connection.model.ts:7</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> @@ -187,7 +187,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/client/src/database-connection.model.ts#L4">client/src/database-connection.model.ts:4</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/client/src/database-connection.model.ts#L4">client/src/database-connection.model.ts:4</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> @@ -231,7 +231,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/client/src/database-connection.model.ts#L5">client/src/database-connection.model.ts:5</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/client/src/database-connection.model.ts#L5">client/src/database-connection.model.ts:5</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> diff --git a/docs/server/interfaces/_lib_database_change_model_.databasechange.html b/docs/server/interfaces/_lib_database_change_model_.databasechange.html index e79ffe0..9696392 100644 --- a/docs/server/interfaces/_lib_database_change_model_.databasechange.html +++ b/docs/server/interfaces/_lib_database_change_model_.databasechange.html @@ -99,7 +99,7 @@ <div class="tsd-signature tsd-kind-icon">change<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Object</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/lib/database-change.model.ts#L3">lib/database-change.model.ts:3</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/lib/database-change.model.ts#L3">lib/database-change.model.ts:3</a></li> </ul> </aside> </section> @@ -109,7 +109,7 @@ <div class="tsd-signature tsd-kind-icon">path<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/nvandoorn/naive/blob/cc3c82a/lib/database-change.model.ts#L2">lib/database-change.model.ts:2</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/lib/database-change.model.ts#L2">lib/database-change.model.ts:2</a></li> </ul> </aside> </section> diff --git a/docs/server/interfaces/_lib_subscription_req_model_.subscriptionrequest.html b/docs/server/interfaces/_lib_subscription_req_model_.subscriptionrequest.html index dbffcaf..8fd2356 100644 --- a/docs/server/interfaces/_lib_subscription_req_model_.subscriptionrequest.html +++ b/docs/server/interfaces/_lib_subscription_req_model_.subscriptionrequest.html @@ -98,7 +98,7 @@ <div class="tsd-signature tsd-kind-icon">path<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/nvandoorn/naive/blob/cc3c82a/lib/subscription-req.model.ts#L2">lib/subscription-req.model.ts:2</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/lib/subscription-req.model.ts#L2">lib/subscription-req.model.ts:2</a></li> </ul> </aside> </section> diff --git a/docs/server/interfaces/_lib_write_req_model_.writerequest.html b/docs/server/interfaces/_lib_write_req_model_.writerequest.html index 4f3d4d4..70221fa 100644 --- a/docs/server/interfaces/_lib_write_req_model_.writerequest.html +++ b/docs/server/interfaces/_lib_write_req_model_.writerequest.html @@ -99,7 +99,7 @@ <div class="tsd-signature tsd-kind-icon">path<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/nvandoorn/naive/blob/cc3c82a/lib/write-req.model.ts#L2">lib/write-req.model.ts:2</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/lib/write-req.model.ts#L2">lib/write-req.model.ts:2</a></li> </ul> </aside> </section> @@ -109,7 +109,7 @@ <div class="tsd-signature tsd-kind-icon">to<wbr>Write<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Object</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/lib/write-req.model.ts#L3">lib/write-req.model.ts:3</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/lib/write-req.model.ts#L3">lib/write-req.model.ts:3</a></li> </ul> </aside> </section> diff --git a/docs/server/interfaces/_server_src_context_model_.context.html b/docs/server/interfaces/_server_src_context_model_.context.html index a335f97..b5adab4 100644 --- a/docs/server/interfaces/_server_src_context_model_.context.html +++ b/docs/server/interfaces/_server_src_context_model_.context.html @@ -100,7 +100,7 @@ <div class="tsd-signature tsd-kind-icon">http<wbr>Port<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/nvandoorn/naive/blob/cc3c82a/server/src/context.model.ts#L2">server/src/context.model.ts:2</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/server/src/context.model.ts#L2">server/src/context.model.ts:2</a></li> </ul> </aside> </section> @@ -110,7 +110,7 @@ <div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/server/src/context.model.ts#L4">server/src/context.model.ts:4</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/server/src/context.model.ts#L4">server/src/context.model.ts:4</a></li> </ul> </aside> <div class="tsd-type-declaration"> @@ -141,7 +141,7 @@ <div class="tsd-signature tsd-kind-icon">ws<wbr>Port<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/nvandoorn/naive/blob/cc3c82a/server/src/context.model.ts#L3">server/src/context.model.ts:3</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/server/src/context.model.ts#L3">server/src/context.model.ts:3</a></li> </ul> </aside> </section> diff --git a/docs/server/modules/_client_src_database_connection_.html b/docs/server/modules/_client_src_database_connection_.html index 31959c7..26a86be 100644 --- a/docs/server/modules/_client_src_database_connection_.html +++ b/docs/server/modules/_client_src_database_connection_.html @@ -99,7 +99,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/client/src/database-connection.ts#L32">client/src/database-connection.ts:32</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/client/src/database-connection.ts#L32">client/src/database-connection.ts:32</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -129,7 +129,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/client/src/database-connection.ts#L10">client/src/database-connection.ts:10</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/client/src/database-connection.ts#L10">client/src/database-connection.ts:10</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> diff --git a/docs/server/modules/_lib_path_.html b/docs/server/modules/_lib_path_.html index 7725ec8..29dcae3 100644 --- a/docs/server/modules/_lib_path_.html +++ b/docs/server/modules/_lib_path_.html @@ -92,7 +92,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in lib/path.ts:7</li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/lib/path.ts#L7">lib/path.ts:7</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> @@ -115,7 +115,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in lib/path.ts:1</li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/lib/path.ts#L1">lib/path.ts:1</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> diff --git a/docs/server/modules/_lib_util_.html b/docs/server/modules/_lib_util_.html index 0ae71b9..76e7f7b 100644 --- a/docs/server/modules/_lib_util_.html +++ b/docs/server/modules/_lib_util_.html @@ -92,7 +92,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/lib/util.ts#L9">lib/util.ts:9</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/lib/util.ts#L9">lib/util.ts:9</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -120,7 +120,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/lib/util.ts#L4">lib/util.ts:4</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/lib/util.ts#L4">lib/util.ts:4</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> diff --git a/docs/server/modules/_server_src_operations_.html b/docs/server/modules/_server_src_operations_.html index 974a8a7..d6c6059 100644 --- a/docs/server/modules/_server_src_operations_.html +++ b/docs/server/modules/_server_src_operations_.html @@ -91,7 +91,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/server/src/operations.ts#L13">server/src/operations.ts:13</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/server/src/operations.ts#L13">server/src/operations.ts:13</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> diff --git a/docs/server/modules/_server_src_server_.html b/docs/server/modules/_server_src_server_.html index 93ad484..1ef5edc 100644 --- a/docs/server/modules/_server_src_server_.html +++ b/docs/server/modules/_server_src_server_.html @@ -93,7 +93,7 @@ <div class="tsd-signature tsd-kind-icon">Cleanup<wbr>Routine<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/server/src/server.ts#L8">server/src/server.ts:8</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/server/src/server.ts#L8">server/src/server.ts:8</a></li> </ul> </aside> <div class="tsd-type-declaration"> @@ -125,7 +125,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/server/src/server.ts#L10">server/src/server.ts:10</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/server/src/server.ts#L10">server/src/server.ts:10</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> diff --git a/docs/server/modules/_server_src_server_test_.html b/docs/server/modules/_server_src_server_test_.html index 8a148bd..7c7aba4 100644 --- a/docs/server/modules/_server_src_server_test_.html +++ b/docs/server/modules/_server_src_server_test_.html @@ -90,7 +90,7 @@ <div class="tsd-signature tsd-kind-icon">http<wbr>Port<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = port</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/server/src/server.test.ts#L12">server/src/server.test.ts:12</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/server/src/server.test.ts#L12">server/src/server.test.ts:12</a></li> </ul> </aside> </section> @@ -100,7 +100,7 @@ <div class="tsd-signature tsd-kind-icon">local<wbr>Host<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"http://localhost:"</span><span class="tsd-signature-symbol"> = "http://localhost:"</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/server/src/server.test.ts#L14">server/src/server.test.ts:14</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/server/src/server.test.ts#L14">server/src/server.test.ts:14</a></li> </ul> </aside> </section> @@ -110,7 +110,7 @@ <div class="tsd-signature tsd-kind-icon">port<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = +(process.env.PORT || 5005)</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/server/src/server.test.ts#L11">server/src/server.test.ts:11</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/server/src/server.test.ts#L11">server/src/server.test.ts:11</a></li> </ul> </aside> </section> @@ -120,7 +120,7 @@ <div class="tsd-signature tsd-kind-icon">ws<wbr>Port<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = port + 1</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/cc3c82a/server/src/server.test.ts#L13">server/src/server.test.ts:13</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/caf54d2/server/src/server.test.ts#L13">server/src/server.test.ts:13</a></li> </ul> </aside> </section> @@ -1,8 +1,12 @@ # naive - + -[Read the docs](https://nvandoorn.github.io/naive/) +Read the docs: + +- [naive-client](https://nvandoorn.github.io/naive/client) +- [naive-server](https://nvandoorn.github.io/naive/server) +- [naive-core](https://nvandoorn.github.io/naive/core) A small NoSQL database with an API similar to Firebase backed by a static JSON file. diff --git a/server/readme.md b/server/readme.md index 92753d4..2a0d260 100644 --- a/server/readme.md +++ b/server/readme.md @@ -1,9 +1,3 @@ -# naive +# naive-server - - -[Read the docs](https://nvandoorn.github.io/naive/) - -A small NoSQL database with an API similar to Firebase backed by a static JSON file. - -Useful for prototyping or situations where size is small and data integrity is not that important +Serve a `naive-core` instance. |