diff options
| author | Nick Van Doorn <vandoorn.nick@gmail.com> | 2019-01-19 21:16:03 -0800 |
|---|---|---|
| committer | Nick Van Doorn <vandoorn.nick@gmail.com> | 2019-01-19 21:16:03 -0800 |
| commit | e39b314a3fdbc78833cdfa16e0395c64f00b1b45 (patch) | |
| tree | 853528f9bd268f0cd55e36e6b3b1df43b1b9ce2d | |
| parent | 7bbacce30d6717228d39f787103f5b72f4eb7bfa (diff) | |
Update docs for release 1.2.01.2.0
| -rw-r--r-- | docs/.nojekyll | 0 | ||||
| -rw-r--r-- | docs/assets/js/search.js | 2 | ||||
| -rw-r--r-- | docs/classes/_database_.database.html | 53 | ||||
| -rw-r--r-- | docs/classes/_error_model_.naiveerror.html | 327 | ||||
| -rw-r--r-- | docs/enums/_error_model_.naiveerrorcode.html | 233 | ||||
| -rw-r--r-- | docs/globals.html | 4 | ||||
| -rw-r--r-- | docs/index.html | 4 | ||||
| -rw-r--r-- | docs/interfaces/_context_model_.context.html | 21 | ||||
| -rw-r--r-- | docs/interfaces/_database_model_.databaseinterface.html | 13 | ||||
| -rw-r--r-- | docs/modules/_context_model_.html | 3 | ||||
| -rw-r--r-- | docs/modules/_database_.html | 25 | ||||
| -rw-r--r-- | docs/modules/_database_model_.html | 3 | ||||
| -rw-r--r-- | docs/modules/_database_test_.html | 67 | ||||
| -rw-r--r-- | docs/modules/_error_model_.html | 254 | ||||
| -rw-r--r-- | docs/modules/_util_.html | 5 |
15 files changed, 989 insertions, 25 deletions
diff --git a/docs/.nojekyll b/docs/.nojekyll deleted file mode 100644 index e69de29..0000000 --- a/docs/.nojekyll +++ /dev/null diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js index f2f51b3..7d1c97c 100644 --- a/docs/assets/js/search.js +++ b/docs/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"1":"External module","32":"Variable","64":"Function","128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method","65536":"Type literal","2097152":"Object literal"},"rows":[{"id":0,"kind":1,"name":"\"context.model\"","url":"modules/_context_model_.html","classes":"tsd-kind-external-module"},{"id":1,"kind":256,"name":"Context","url":"interfaces/_context_model_.context.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"context.model\""},{"id":2,"kind":1024,"name":"logger","url":"interfaces/_context_model_.context.html#logger","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"context.model\".Context"},{"id":3,"kind":65536,"name":"__type","url":"interfaces/_context_model_.context.html#logger.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"\"context.model\".Context.logger"},{"id":4,"kind":1024,"name":"cachePath","url":"interfaces/_context_model_.context.html#cachepath","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"context.model\".Context"},{"id":5,"kind":1,"name":"\"database.model\"","url":"modules/_database_model_.html","classes":"tsd-kind-external-module"},{"id":6,"kind":256,"name":"DatabaseInterface","url":"interfaces/_database_model_.databaseinterface.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"database.model\""},{"id":7,"kind":2048,"name":"init","url":"interfaces/_database_model_.databaseinterface.html#init","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"\"database.model\".DatabaseInterface"},{"id":8,"kind":2048,"name":"read","url":"interfaces/_database_model_.databaseinterface.html#read","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"\"database.model\".DatabaseInterface"},{"id":9,"kind":2048,"name":"write","url":"interfaces/_database_model_.databaseinterface.html#write","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"\"database.model\".DatabaseInterface"},{"id":10,"kind":2048,"name":"flush","url":"interfaces/_database_model_.databaseinterface.html#flush","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"\"database.model\".DatabaseInterface"},{"id":11,"kind":2048,"name":"toString","url":"interfaces/_database_model_.databaseinterface.html#tostring","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"\"database.model\".DatabaseInterface"},{"id":12,"kind":1,"name":"\"util\"","url":"modules/_util_.html","classes":"tsd-kind-external-module"},{"id":13,"kind":64,"name":"last","url":"modules/_util_.html#last","classes":"tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter","parent":"\"util\""},{"id":14,"kind":1,"name":"\"database\"","url":"modules/_database_.html","classes":"tsd-kind-external-module"},{"id":15,"kind":128,"name":"Database","url":"classes/_database_.database.html","classes":"tsd-kind-class tsd-parent-kind-external-module","parent":"\"database\""},{"id":16,"kind":1024,"name":"buff","url":"classes/_database_.database.html#buff","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"\"database\".Database"},{"id":17,"kind":512,"name":"constructor","url":"classes/_database_.database.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"\"database\".Database"},{"id":18,"kind":1024,"name":"ctx","url":"classes/_database_.database.html#ctx","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"\"database\".Database"},{"id":19,"kind":2048,"name":"init","url":"classes/_database_.database.html#init","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"database\".Database"},{"id":20,"kind":2048,"name":"read","url":"classes/_database_.database.html#read","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"database\".Database"},{"id":21,"kind":2048,"name":"write","url":"classes/_database_.database.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"database\".Database"},{"id":22,"kind":2048,"name":"flush","url":"classes/_database_.database.html#flush","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"database\".Database"},{"id":23,"kind":2048,"name":"toString","url":"classes/_database_.database.html#tostring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"database\".Database"},{"id":24,"kind":2048,"name":"resolve","url":"classes/_database_.database.html#resolve","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"\"database\".Database"},{"id":25,"kind":2048,"name":"serialize","url":"classes/_database_.database.html#serialize","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"\"database\".Database"},{"id":26,"kind":64,"name":"splitPath","url":"modules/_database_.html#splitpath","classes":"tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"database\""},{"id":27,"kind":32,"name":"write","url":"modules/_database_.html#write","classes":"tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"database\""},{"id":28,"kind":32,"name":"read","url":"modules/_database_.html#read","classes":"tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"database\""},{"id":29,"kind":2097152,"name":"DEFAULT_CTX","url":"modules/_database_.html#default_ctx","classes":"tsd-kind-object-literal tsd-parent-kind-external-module","parent":"\"database\""},{"id":30,"kind":32,"name":"logger","url":"modules/_database_.html#default_ctx.logger","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"database\".DEFAULT_CTX"},{"id":31,"kind":32,"name":"cachePath","url":"modules/_database_.html#default_ctx.cachepath","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"database\".DEFAULT_CTX"},{"id":32,"kind":1,"name":"\"database.test\"","url":"modules/_database_test_.html","classes":"tsd-kind-external-module"}]};
\ No newline at end of file + typedoc.search.data = {"kinds":{"1":"External module","4":"Enumeration","16":"Enumeration member","32":"Variable","64":"Function","128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method","65536":"Type literal","2097152":"Object literal"},"rows":[{"id":0,"kind":1,"name":"\"context.model\"","url":"modules/_context_model_.html","classes":"tsd-kind-external-module"},{"id":1,"kind":256,"name":"Context","url":"interfaces/_context_model_.context.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"context.model\""},{"id":2,"kind":1024,"name":"logger","url":"interfaces/_context_model_.context.html#logger","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"context.model\".Context"},{"id":3,"kind":65536,"name":"__type","url":"interfaces/_context_model_.context.html#logger.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"\"context.model\".Context.logger"},{"id":4,"kind":1024,"name":"cachePath","url":"interfaces/_context_model_.context.html#cachepath","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"context.model\".Context"},{"id":5,"kind":1024,"name":"maxDbSizeMB","url":"interfaces/_context_model_.context.html#maxdbsizemb","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"context.model\".Context"},{"id":6,"kind":1,"name":"\"database.model\"","url":"modules/_database_model_.html","classes":"tsd-kind-external-module"},{"id":7,"kind":256,"name":"DatabaseInterface","url":"interfaces/_database_model_.databaseinterface.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"database.model\""},{"id":8,"kind":2048,"name":"init","url":"interfaces/_database_model_.databaseinterface.html#init","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"\"database.model\".DatabaseInterface"},{"id":9,"kind":2048,"name":"read","url":"interfaces/_database_model_.databaseinterface.html#read","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"\"database.model\".DatabaseInterface"},{"id":10,"kind":2048,"name":"write","url":"interfaces/_database_model_.databaseinterface.html#write","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"\"database.model\".DatabaseInterface"},{"id":11,"kind":2048,"name":"flush","url":"interfaces/_database_model_.databaseinterface.html#flush","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"\"database.model\".DatabaseInterface"},{"id":12,"kind":2048,"name":"toString","url":"interfaces/_database_model_.databaseinterface.html#tostring","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"\"database.model\".DatabaseInterface"},{"id":13,"kind":1,"name":"\"error.model\"","url":"modules/_error_model_.html","classes":"tsd-kind-external-module"},{"id":14,"kind":4,"name":"NaiveErrorCode","url":"enums/_error_model_.naiveerrorcode.html","classes":"tsd-kind-enum tsd-parent-kind-external-module","parent":"\"error.model\""},{"id":15,"kind":16,"name":"UNCAUGHT","url":"enums/_error_model_.naiveerrorcode.html#uncaught","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"\"error.model\".NaiveErrorCode"},{"id":16,"kind":16,"name":"OUT_OF_SPACE","url":"enums/_error_model_.naiveerrorcode.html#out_of_space","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"\"error.model\".NaiveErrorCode"},{"id":17,"kind":128,"name":"NaiveError","url":"classes/_error_model_.naiveerror.html","classes":"tsd-kind-class tsd-parent-kind-external-module","parent":"\"error.model\""},{"id":18,"kind":512,"name":"constructor","url":"classes/_error_model_.naiveerror.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"\"error.model\".NaiveError"},{"id":19,"kind":1024,"name":"code","url":"classes/_error_model_.naiveerror.html#code","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"error.model\".NaiveError"},{"id":20,"kind":1024,"name":"name","url":"classes/_error_model_.naiveerror.html#name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"\"error.model\".NaiveError"},{"id":21,"kind":1024,"name":"message","url":"classes/_error_model_.naiveerror.html#message","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"\"error.model\".NaiveError"},{"id":22,"kind":1024,"name":"stack","url":"classes/_error_model_.naiveerror.html#stack","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited","parent":"\"error.model\".NaiveError"},{"id":23,"kind":1024,"name":"Error","url":"classes/_error_model_.naiveerror.html#error","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"\"error.model\".NaiveError"},{"id":24,"kind":32,"name":"e","url":"modules/_error_model_.html#e","classes":"tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"error.model\""},{"id":25,"kind":64,"name":"lookupMsg","url":"modules/_error_model_.html#lookupmsg","classes":"tsd-kind-function tsd-parent-kind-external-module","parent":"\"error.model\""},{"id":26,"kind":1,"name":"\"util\"","url":"modules/_util_.html","classes":"tsd-kind-external-module"},{"id":27,"kind":64,"name":"last","url":"modules/_util_.html#last","classes":"tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter","parent":"\"util\""},{"id":28,"kind":1,"name":"\"database\"","url":"modules/_database_.html","classes":"tsd-kind-external-module"},{"id":29,"kind":128,"name":"Database","url":"classes/_database_.database.html","classes":"tsd-kind-class tsd-parent-kind-external-module","parent":"\"database\""},{"id":30,"kind":1024,"name":"buff","url":"classes/_database_.database.html#buff","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"\"database\".Database"},{"id":31,"kind":512,"name":"constructor","url":"classes/_database_.database.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"\"database\".Database"},{"id":32,"kind":1024,"name":"ctx","url":"classes/_database_.database.html#ctx","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"\"database\".Database"},{"id":33,"kind":2048,"name":"init","url":"classes/_database_.database.html#init","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"database\".Database"},{"id":34,"kind":2048,"name":"read","url":"classes/_database_.database.html#read","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"database\".Database"},{"id":35,"kind":2048,"name":"write","url":"classes/_database_.database.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"database\".Database"},{"id":36,"kind":2048,"name":"flush","url":"classes/_database_.database.html#flush","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"database\".Database"},{"id":37,"kind":2048,"name":"toString","url":"classes/_database_.database.html#tostring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"database\".Database"},{"id":38,"kind":2048,"name":"resolve","url":"classes/_database_.database.html#resolve","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"\"database\".Database"},{"id":39,"kind":2048,"name":"serialize","url":"classes/_database_.database.html#serialize","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"\"database\".Database"},{"id":40,"kind":2048,"name":"hasSpace","url":"classes/_database_.database.html#hasspace","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"\"database\".Database"},{"id":41,"kind":64,"name":"splitPath","url":"modules/_database_.html#splitpath","classes":"tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"database\""},{"id":42,"kind":32,"name":"write","url":"modules/_database_.html#write","classes":"tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"database\""},{"id":43,"kind":32,"name":"read","url":"modules/_database_.html#read","classes":"tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"database\""},{"id":44,"kind":2097152,"name":"DEFAULT_CTX","url":"modules/_database_.html#default_ctx","classes":"tsd-kind-object-literal tsd-parent-kind-external-module","parent":"\"database\""},{"id":45,"kind":32,"name":"logger","url":"modules/_database_.html#default_ctx.logger","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"database\".DEFAULT_CTX"},{"id":46,"kind":32,"name":"cachePath","url":"modules/_database_.html#default_ctx.cachepath","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"database\".DEFAULT_CTX"},{"id":47,"kind":32,"name":"maxDbSizeMB","url":"modules/_database_.html#default_ctx.maxdbsizemb","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"database\".DEFAULT_CTX"},{"id":48,"kind":1,"name":"\"database.test\"","url":"modules/_database_test_.html","classes":"tsd-kind-external-module"},{"id":49,"kind":64,"name":"generateString","url":"modules/_database_test_.html#generatestring","classes":"tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"database.test\""},{"id":50,"kind":32,"name":"maxDbSizeMB","url":"modules/_database_test_.html#maxdbsizemb","classes":"tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"database.test\""}]};
\ No newline at end of file diff --git a/docs/classes/_database_.database.html b/docs/classes/_database_.database.html index 4073194..0a386cf 100644 --- a/docs/classes/_database_.database.html +++ b/docs/classes/_database_.database.html @@ -116,6 +116,7 @@ <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_database_.database.html#flush" class="tsd-kind-icon">flush</a></li> + <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_database_.database.html#hasspace" class="tsd-kind-icon">has<wbr>Space</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_database_.database.html#init" class="tsd-kind-icon">init</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_database_.database.html#read" class="tsd-kind-icon">read</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_database_.database.html#resolve" class="tsd-kind-icon">resolve</a></li> @@ -139,7 +140,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/0ddd6bf/src/database.ts#L30">database.ts:30</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/database.ts#L32">database.ts:32</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> @@ -161,7 +162,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/0ddd6bf/src/database.ts#L30">database.ts:30</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/database.ts#L32">database.ts:32</a></li> </ul> </aside> </section> @@ -171,7 +172,7 @@ <div class="tsd-signature tsd-kind-icon">ctx<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_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/0ddd6bf/src/database.ts#L31">database.ts:31</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/database.ts#L33">database.ts:33</a></li> </ul> </aside> </section> @@ -189,13 +190,30 @@ <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_database_model_.databaseinterface.html">DatabaseInterface</a>.<a href="../interfaces/_database_model_.databaseinterface.html#flush">flush</a></p> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/0ddd6bf/src/database.ts#L58">database.ts:58</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/database.ts#L60">database.ts:60</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> </li> </ul> </section> + <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"> + <a name="hasspace" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagPrivate">Private</span> has<wbr>Space</h3> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> + <li class="tsd-signature tsd-kind-icon">has<wbr>Space<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <aside class="tsd-sources"> + <ul> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/database.ts#L126">database.ts:126</a></li> + </ul> + </aside> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> + </li> + </ul> + </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="init" class="tsd-anchor"></a> <h3>init</h3> @@ -207,7 +225,7 @@ <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_database_model_.databaseinterface.html">DatabaseInterface</a>.<a href="../interfaces/_database_model_.databaseinterface.html#init">init</a></p> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/0ddd6bf/src/database.ts#L33">database.ts:33</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/database.ts#L35">database.ts:35</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> @@ -225,7 +243,7 @@ <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_database_model_.databaseinterface.html">DatabaseInterface</a>.<a href="../interfaces/_database_model_.databaseinterface.html#read">read</a></p> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/0ddd6bf/src/database.ts#L46">database.ts:46</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/database.ts#L48">database.ts:48</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> @@ -248,7 +266,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/0ddd6bf/src/database.ts#L79">database.ts:79</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/database.ts#L81">database.ts:81</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -289,9 +307,18 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/0ddd6bf/src/database.ts#L112">database.ts:112</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/database.ts#L121">database.ts:121</a></li> </ul> </aside> + <div class="tsd-comment tsd-typography"> + <div class="lead"> + <p>Serialize the current buffer + into a plain file.</p> + </div> + <p>Change the path by injecting custom + Context</p> + <p>Throws OUT_OF_SPACE</p> + </div> <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> </li> </ul> @@ -307,7 +334,7 @@ <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_database_model_.databaseinterface.html">DatabaseInterface</a>.<a href="../interfaces/_database_model_.databaseinterface.html#tostring">toString</a></p> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/0ddd6bf/src/database.ts#L63">database.ts:63</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/database.ts#L65">database.ts:65</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> @@ -325,7 +352,7 @@ <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_database_model_.databaseinterface.html">DatabaseInterface</a>.<a href="../interfaces/_database_model_.databaseinterface.html#write">write</a></p> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/0ddd6bf/src/database.ts#L51">database.ts:51</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/database.ts#L53">database.ts:53</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> @@ -362,6 +389,9 @@ <a href="../modules/_database_test_.html">"database.test"</a> </li> <li class=" tsd-kind-external-module"> + <a href="../modules/_error_model_.html">"error.model"</a> + </li> + <li class=" tsd-kind-external-module"> <a href="../modules/_util_.html">"util"</a> </li> </ul> @@ -385,6 +415,9 @@ <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_database_.database.html#flush" class="tsd-kind-icon">flush</a> </li> + <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private"> + <a href="_database_.database.html#hasspace" class="tsd-kind-icon">has<wbr>Space</a> + </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_database_.database.html#init" class="tsd-kind-icon">init</a> </li> diff --git a/docs/classes/_error_model_.naiveerror.html b/docs/classes/_error_model_.naiveerror.html new file mode 100644 index 0000000..bb19f23 --- /dev/null +++ b/docs/classes/_error_model_.naiveerror.html @@ -0,0 +1,327 @@ +<!doctype html> +<html class="default no-js"> +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <title>NaiveError | naive</title> + <meta name="description" content=""> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <link rel="stylesheet" href="../assets/css/main.css"> +</head> +<body> +<header> + <div class="tsd-page-toolbar"> + <div class="container"> + <div class="table-wrap"> + <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> + <div class="field"> + <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> + <input id="tsd-search-field" type="text" /> + </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">naive</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> + <input type="checkbox" id="tsd-filter-only-exported" /> + <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../globals.html">Globals</a> + </li> + <li> + <a href="../modules/_error_model_.html">"error.model"</a> + </li> + <li> + <a href="_error_model_.naiveerror.html">NaiveError</a> + </li> + </ul> + <h1>Class NaiveError</h1> + </div> + </div> +</header> +<div class="container container-main"> + <div class="row"> + <div class="col-8 col-content"> + <section class="tsd-panel tsd-hierarchy"> + <h3>Hierarchy</h3> + <ul class="tsd-hierarchy"> + <li> + <span class="tsd-signature-type">Error</span> + <ul class="tsd-hierarchy"> + <li> + <span class="target">NaiveError</span> + </li> + </ul> + </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>Constructors</h3> + <ul class="tsd-index-list"> + <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_error_model_.naiveerror.html#constructor" class="tsd-kind-icon">constructor</a></li> + </ul> + </section> + <section class="tsd-index-section "> + <h3>Properties</h3> + <ul class="tsd-index-list"> + <li class="tsd-kind-property tsd-parent-kind-class"><a href="_error_model_.naiveerror.html#code" class="tsd-kind-icon">code</a></li> + <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_error_model_.naiveerror.html#message" class="tsd-kind-icon">message</a></li> + <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_error_model_.naiveerror.html#name" class="tsd-kind-icon">name</a></li> + <li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"><a href="_error_model_.naiveerror.html#stack" class="tsd-kind-icon">stack</a></li> + <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_error_model_.naiveerror.html#error" class="tsd-kind-icon">Error</a></li> + </ul> + </section> + </div> + </section> + </section> + <section class="tsd-panel-group tsd-member-group "> + <h2>Constructors</h2> + <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> + <a name="constructor" class="tsd-anchor"></a> + <h3>constructor</h3> + <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> + <li class="tsd-signature tsd-kind-icon">new <wbr>Naive<wbr>Error<span class="tsd-signature-symbol">(</span>code<span class="tsd-signature-symbol">: </span><a href="../enums/_error_model_.naiveerrorcode.html" class="tsd-signature-type">NaiveErrorCode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_error_model_.naiveerror.html" class="tsd-signature-type">NaiveError</a></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <aside class="tsd-sources"> + <ul> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/error.model.ts#L18">error.model.ts:18</a></li> + </ul> + </aside> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5>code: <a href="../enums/_error_model_.naiveerrorcode.html" class="tsd-signature-type">NaiveErrorCode</a></h5> + </li> + </ul> + <h4 class="tsd-returns-title">Returns <a href="_error_model_.naiveerror.html" class="tsd-signature-type">NaiveError</a></h4> + </li> + </ul> + </section> + </section> + <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="code" class="tsd-anchor"></a> + <h3>code</h3> + <div class="tsd-signature tsd-kind-icon">code<span class="tsd-signature-symbol">:</span> <a href="../enums/_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/5f53ecc/src/error.model.ts#L19">error.model.ts:19</a></li> + </ul> + </aside> + </section> + <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> + <a name="message" class="tsd-anchor"></a> + <h3>message</h3> + <div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> + <aside class="tsd-sources"> + <p>Inherited from Error.message</p> + <ul> + <li>Defined in /Users/nick/Documents/naive/node_modules/typescript/lib/lib.es5.d.ts:964</li> + </ul> + </aside> + </section> + <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> + <a name="name" class="tsd-anchor"></a> + <h3>name</h3> + <div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> + <aside class="tsd-sources"> + <p>Inherited from Error.name</p> + <ul> + <li>Defined in /Users/nick/Documents/naive/node_modules/typescript/lib/lib.es5.d.ts:963</li> + </ul> + </aside> + </section> + <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"> + <a name="stack" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3> + <div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div> + <aside class="tsd-sources"> + <p>Inherited from Error.stack</p> + <p>Overrides Error.stack</p> + <ul> + <li>Defined in /Users/nick/Documents/naive/node_modules/typescript/lib/lib.es5.d.ts:965</li> + </ul> + </aside> + </section> + <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"> + <a name="error" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagStatic">Static</span> Error</h3> + <div class="tsd-signature tsd-kind-icon">Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ErrorConstructor</span></div> + <aside class="tsd-sources"> + <ul> + <li>Defined in /Users/nick/Documents/naive/node_modules/typescript/lib/lib.es5.d.ts:974</li> + </ul> + </aside> + </section> + </section> + </div> + <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> + <nav class="tsd-navigation primary"> + <ul> + <li class="globals "> + <a href="../globals.html"><em>Globals</em></a> + </li> + <li class=" tsd-kind-external-module"> + <a href="../modules/_context_model_.html">"context.model"</a> + </li> + <li class=" tsd-kind-external-module"> + <a href="../modules/_database_.html">"database"</a> + </li> + <li class=" tsd-kind-external-module"> + <a href="../modules/_database_model_.html">"database.model"</a> + </li> + <li class=" tsd-kind-external-module"> + <a href="../modules/_database_test_.html">"database.test"</a> + </li> + <li class="current tsd-kind-external-module"> + <a href="../modules/_error_model_.html">"error.model"</a> + </li> + <li class=" tsd-kind-external-module"> + <a href="../modules/_util_.html">"util"</a> + </li> + </ul> + </nav> + <nav class="tsd-navigation secondary menu-sticky"> + <ul class="before-current"> + <li class=" tsd-kind-enum tsd-parent-kind-external-module"> + <a href="../enums/_error_model_.naiveerrorcode.html" class="tsd-kind-icon">Naive<wbr>Error<wbr>Code</a> + </li> + </ul> + <ul class="current"> + <li class="current tsd-kind-class tsd-parent-kind-external-module"> + <a href="_error_model_.naiveerror.html" class="tsd-kind-icon">Naive<wbr>Error</a> + <ul> + <li class=" tsd-kind-constructor tsd-parent-kind-class"> + <a href="_error_model_.naiveerror.html#constructor" class="tsd-kind-icon">constructor</a> + </li> + <li class=" tsd-kind-property tsd-parent-kind-class"> + <a href="_error_model_.naiveerror.html#code" class="tsd-kind-icon">code</a> + </li> + <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> + <a href="_error_model_.naiveerror.html#message" class="tsd-kind-icon">message</a> + </li> + <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> + <a href="_error_model_.naiveerror.html#name" class="tsd-kind-icon">name</a> + </li> + <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"> + <a href="_error_model_.naiveerror.html#stack" class="tsd-kind-icon">stack</a> + </li> + <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static"> + <a href="_error_model_.naiveerror.html#error" class="tsd-kind-icon">Error</a> + </li> + </ul> + </li> + </ul> + <ul class="after-current"> + <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> + <a href="../modules/_error_model_.html#e" class="tsd-kind-icon">e</a> + </li> + <li class=" tsd-kind-function tsd-parent-kind-external-module"> + <a href="../modules/_error_model_.html#lookupmsg" class="tsd-kind-icon">lookup<wbr>Msg</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-module"><span class="tsd-kind-icon">Module</span></li> + <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> + <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> + <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> + <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> + <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</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-enum"><span class="tsd-kind-icon">Enumeration</span></li> + <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> + <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> + <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> + </ul> + <ul class="tsd-legend"> + <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> + <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> + <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> + <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> + <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> + </ul> + <ul class="tsd-legend"> + <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> + <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</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> + <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> + <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> + <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</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-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> + <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> + <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</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> + <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> + </ul> + <ul class="tsd-legend"> + <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> + <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> + <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> + </ul> + <ul class="tsd-legend"> + <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> + <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> + </ul> + </div> + </div> +</footer> +<div class="container tsd-generator"> + <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p> +</div> +<div class="overlay"></div> +<script src="../assets/js/main.js"></script> +<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> +</body> +</html>
\ No newline at end of file diff --git a/docs/enums/_error_model_.naiveerrorcode.html b/docs/enums/_error_model_.naiveerrorcode.html new file mode 100644 index 0000000..abfe067 --- /dev/null +++ b/docs/enums/_error_model_.naiveerrorcode.html @@ -0,0 +1,233 @@ +<!doctype html> +<html class="default no-js"> +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <title>NaiveErrorCode | naive</title> + <meta name="description" content=""> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <link rel="stylesheet" href="../assets/css/main.css"> +</head> +<body> +<header> + <div class="tsd-page-toolbar"> + <div class="container"> + <div class="table-wrap"> + <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> + <div class="field"> + <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> + <input id="tsd-search-field" type="text" /> + </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">naive</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> + <input type="checkbox" id="tsd-filter-only-exported" /> + <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../globals.html">Globals</a> + </li> + <li> + <a href="../modules/_error_model_.html">"error.model"</a> + </li> + <li> + <a href="_error_model_.naiveerrorcode.html">NaiveErrorCode</a> + </li> + </ul> + <h1>Enumeration NaiveErrorCode</h1> + </div> + </div> +</header> +<div class="container container-main"> + <div class="row"> + <div class="col-8 col-content"> + <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>Enumeration members</h3> + <ul class="tsd-index-list"> + <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_error_model_.naiveerrorcode.html#out_of_space" class="tsd-kind-icon">OUT_<wbr>OF_<wbr>SPACE</a></li> + <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_error_model_.naiveerrorcode.html#uncaught" class="tsd-kind-icon">UNCAUGHT</a></li> + </ul> + </section> + </div> + </section> + </section> + <section class="tsd-panel-group tsd-member-group "> + <h2>Enumeration members</h2> + <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> + <a name="out_of_space" class="tsd-anchor"></a> + <h3>OUT_<wbr>OF_<wbr>SPACE</h3> + <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/5f53ecc/src/error.model.ts#L3">error.model.ts:3</a></li> + </ul> + </aside> + </section> + <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> + <a name="uncaught" class="tsd-anchor"></a> + <h3>UNCAUGHT</h3> + <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/5f53ecc/src/error.model.ts#L2">error.model.ts:2</a></li> + </ul> + </aside> + </section> + </section> + </div> + <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> + <nav class="tsd-navigation primary"> + <ul> + <li class="globals "> + <a href="../globals.html"><em>Globals</em></a> + </li> + <li class=" tsd-kind-external-module"> + <a href="../modules/_context_model_.html">"context.model"</a> + </li> + <li class=" tsd-kind-external-module"> + <a href="../modules/_database_.html">"database"</a> + </li> + <li class=" tsd-kind-external-module"> + <a href="../modules/_database_model_.html">"database.model"</a> + </li> + <li class=" tsd-kind-external-module"> + <a href="../modules/_database_test_.html">"database.test"</a> + </li> + <li class="current tsd-kind-external-module"> + <a href="../modules/_error_model_.html">"error.model"</a> + </li> + <li class=" tsd-kind-external-module"> + <a href="../modules/_util_.html">"util"</a> + </li> + </ul> + </nav> + <nav class="tsd-navigation secondary menu-sticky"> + <ul class="before-current"> + </ul> + <ul class="current"> + <li class="current tsd-kind-enum tsd-parent-kind-external-module"> + <a href="_error_model_.naiveerrorcode.html" class="tsd-kind-icon">Naive<wbr>Error<wbr>Code</a> + <ul> + <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> + <a href="_error_model_.naiveerrorcode.html#out_of_space" class="tsd-kind-icon">OUT_<wbr>OF_<wbr>SPACE</a> + </li> + <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> + <a href="_error_model_.naiveerrorcode.html#uncaught" class="tsd-kind-icon">UNCAUGHT</a> + </li> + </ul> + </li> + </ul> + <ul class="after-current"> + <li class=" tsd-kind-class tsd-parent-kind-external-module"> + <a href="../classes/_error_model_.naiveerror.html" class="tsd-kind-icon">Naive<wbr>Error</a> + </li> + <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> + <a href="../modules/_error_model_.html#e" class="tsd-kind-icon">e</a> + </li> + <li class=" tsd-kind-function tsd-parent-kind-external-module"> + <a href="../modules/_error_model_.html#lookupmsg" class="tsd-kind-icon">lookup<wbr>Msg</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-module"><span class="tsd-kind-icon">Module</span></li> + <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> + <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> + <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> + <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> + <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</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-enum"><span class="tsd-kind-icon">Enumeration</span></li> + <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> + <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> + <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> + </ul> + <ul class="tsd-legend"> + <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> + <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> + <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> + <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> + <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> + </ul> + <ul class="tsd-legend"> + <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> + <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</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> + <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> + <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> + <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</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-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> + <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> + <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</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> + <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> + </ul> + <ul class="tsd-legend"> + <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> + <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> + <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> + </ul> + <ul class="tsd-legend"> + <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> + <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> + </ul> + </div> + </div> +</footer> +<div class="container tsd-generator"> + <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p> +</div> +<div class="overlay"></div> +<script src="../assets/js/main.js"></script> +<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> +</body> +</html>
\ No newline at end of file diff --git a/docs/globals.html b/docs/globals.html index 6505f69..3feb345 100644 --- a/docs/globals.html +++ b/docs/globals.html @@ -74,6 +74,7 @@ <li class="tsd-kind-external-module"><a href="modules/_database_.html" class="tsd-kind-icon">"database"</a></li> <li class="tsd-kind-external-module"><a href="modules/_database_model_.html" class="tsd-kind-icon">"database.model"</a></li> <li class="tsd-kind-external-module"><a href="modules/_database_test_.html" class="tsd-kind-icon">"database.test"</a></li> + <li class="tsd-kind-external-module"><a href="modules/_error_model_.html" class="tsd-kind-icon">"error.model"</a></li> <li class="tsd-kind-external-module"><a href="modules/_util_.html" class="tsd-kind-icon">"util"</a></li> </ul> </section> @@ -100,6 +101,9 @@ <a href="modules/_database_test_.html">"database.test"</a> </li> <li class=" tsd-kind-external-module"> + <a href="modules/_error_model_.html">"error.model"</a> + </li> + <li class=" tsd-kind-external-module"> <a href="modules/_util_.html">"util"</a> </li> </ul> diff --git a/docs/index.html b/docs/index.html index bf1c9bc..2b24c2b 100644 --- a/docs/index.html +++ b/docs/index.html @@ -66,6 +66,7 @@ <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> </div> @@ -89,6 +90,9 @@ <a href="modules/_database_test_.html">"database.test"</a> </li> <li class=" tsd-kind-external-module"> + <a href="modules/_error_model_.html">"error.model"</a> + </li> + <li class=" tsd-kind-external-module"> <a href="modules/_util_.html">"util"</a> </li> </ul> diff --git a/docs/interfaces/_context_model_.context.html b/docs/interfaces/_context_model_.context.html index b94fb12..ed37fcd 100644 --- a/docs/interfaces/_context_model_.context.html +++ b/docs/interfaces/_context_model_.context.html @@ -86,6 +86,7 @@ <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_context_model_.context.html#cachepath" class="tsd-kind-icon">cache<wbr>Path</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_context_model_.context.html#logger" class="tsd-kind-icon">logger</a></li> + <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_context_model_.context.html#maxdbsizemb" class="tsd-kind-icon">max<wbr>DbSizeMB</a></li> </ul> </section> </div> @@ -99,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/0ddd6bf/src/context.model.ts#L3">context.model.ts:3</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/context.model.ts#L3">context.model.ts:3</a></li> </ul> </aside> </section> @@ -109,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/0ddd6bf/src/context.model.ts#L2">context.model.ts:2</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/context.model.ts#L2">context.model.ts:2</a></li> </ul> </aside> <div class="tsd-type-declaration"> @@ -134,6 +135,16 @@ </ul> </div> </section> + <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> + <a name="maxdbsizemb" class="tsd-anchor"></a> + <h3>max<wbr>DbSizeMB</h3> + <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/5f53ecc/src/context.model.ts#L4">context.model.ts:4</a></li> + </ul> + </aside> + </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> @@ -155,6 +166,9 @@ <a href="../modules/_database_test_.html">"database.test"</a> </li> <li class=" tsd-kind-external-module"> + <a href="../modules/_error_model_.html">"error.model"</a> + </li> + <li class=" tsd-kind-external-module"> <a href="../modules/_util_.html">"util"</a> </li> </ul> @@ -172,6 +186,9 @@ <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_context_model_.context.html#logger" class="tsd-kind-icon">logger</a> </li> + <li class=" tsd-kind-property tsd-parent-kind-interface"> + <a href="_context_model_.context.html#maxdbsizemb" class="tsd-kind-icon">max<wbr>DbSizeMB</a> + </li> </ul> </li> </ul> diff --git a/docs/interfaces/_database_model_.databaseinterface.html b/docs/interfaces/_database_model_.databaseinterface.html index c880089..f367cc3 100644 --- a/docs/interfaces/_database_model_.databaseinterface.html +++ b/docs/interfaces/_database_model_.databaseinterface.html @@ -112,7 +112,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/0ddd6bf/src/database.model.ts#L35">database.model.ts:35</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/database.model.ts#L35">database.model.ts:35</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -134,7 +134,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/0ddd6bf/src/database.model.ts#L10">database.model.ts:10</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/database.model.ts#L10">database.model.ts:10</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -160,7 +160,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/0ddd6bf/src/database.model.ts#L19">database.model.ts:19</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/database.model.ts#L19">database.model.ts:19</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -191,7 +191,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/0ddd6bf/src/database.model.ts#L40">database.model.ts:40</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/database.model.ts#L40">database.model.ts:40</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -213,7 +213,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/0ddd6bf/src/database.model.ts#L30">database.model.ts:30</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/database.model.ts#L30">database.model.ts:30</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -259,6 +259,9 @@ <a href="../modules/_database_test_.html">"database.test"</a> </li> <li class=" tsd-kind-external-module"> + <a href="../modules/_error_model_.html">"error.model"</a> + </li> + <li class=" tsd-kind-external-module"> <a href="../modules/_util_.html">"util"</a> </li> </ul> diff --git a/docs/modules/_context_model_.html b/docs/modules/_context_model_.html index 3aec73a..6fe45c5 100644 --- a/docs/modules/_context_model_.html +++ b/docs/modules/_context_model_.html @@ -99,6 +99,9 @@ <a href="_database_test_.html">"database.test"</a> </li> <li class=" tsd-kind-external-module"> + <a href="_error_model_.html">"error.model"</a> + </li> + <li class=" tsd-kind-external-module"> <a href="_util_.html">"util"</a> </li> </ul> diff --git a/docs/modules/_database_.html b/docs/modules/_database_.html index 43017d4..d9afe45 100644 --- a/docs/modules/_database_.html +++ b/docs/modules/_database_.html @@ -106,7 +106,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/0ddd6bf/src/database.ts#L12">database.ts:12</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/database.ts#L13">database.ts:13</a></li> </ul> </aside> </section> @@ -116,7 +116,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/0ddd6bf/src/database.ts#L11">database.ts:11</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/database.ts#L12">database.ts:12</a></li> </ul> </aside> </section> @@ -133,7 +133,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/0ddd6bf/src/database.ts#L9">database.ts:9</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/database.ts#L10">database.ts:10</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> @@ -155,7 +155,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/0ddd6bf/src/database.ts#L14">database.ts:14</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/database.ts#L15">database.ts:15</a></li> </ul> </aside> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> @@ -164,7 +164,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/0ddd6bf/src/database.ts#L16">database.ts:16</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/database.ts#L17">database.ts:17</a></li> </ul> </aside> </section> @@ -174,7 +174,17 @@ <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/0ddd6bf/src/database.ts#L15">database.ts:15</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/database.ts#L16">database.ts:16</a></li> + </ul> + </aside> + </section> + <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> + <a name="default_ctx.maxdbsizemb" class="tsd-anchor"></a> + <h3>max<wbr>DbSizeMB</h3> + <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/5f53ecc/src/database.ts#L18">database.ts:18</a></li> </ul> </aside> </section> @@ -200,6 +210,9 @@ <a href="_database_test_.html">"database.test"</a> </li> <li class=" tsd-kind-external-module"> + <a href="_error_model_.html">"error.model"</a> + </li> + <li class=" tsd-kind-external-module"> <a href="_util_.html">"util"</a> </li> </ul> diff --git a/docs/modules/_database_model_.html b/docs/modules/_database_model_.html index 1fabce5..c99da41 100644 --- a/docs/modules/_database_model_.html +++ b/docs/modules/_database_model_.html @@ -99,6 +99,9 @@ <a href="_database_test_.html">"database.test"</a> </li> <li class=" tsd-kind-external-module"> + <a href="_error_model_.html">"error.model"</a> + </li> + <li class=" tsd-kind-external-module"> <a href="_util_.html">"util"</a> </li> </ul> diff --git a/docs/modules/_database_test_.html b/docs/modules/_database_test_.html index 0e9f609..9fa7c99 100644 --- a/docs/modules/_database_test_.html +++ b/docs/modules/_database_test_.html @@ -66,6 +66,64 @@ <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> + <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 tsd-is-not-exported"> + <h3>Variables</h3> + <ul class="tsd-index-list"> + <li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="_database_test_.html#maxdbsizemb" class="tsd-kind-icon">max<wbr>DbSizeMB</a></li> + </ul> + </section> + <section class="tsd-index-section tsd-is-not-exported"> + <h3>Functions</h3> + <ul class="tsd-index-list"> + <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_database_test_.html#generatestring" class="tsd-kind-icon">generate<wbr>String</a></li> + </ul> + </section> + </div> + </section> + </section> + <section class="tsd-panel-group tsd-member-group tsd-is-not-exported"> + <h2>Variables</h2> + <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> + <a name="maxdbsizemb" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagConst">Const</span> max<wbr>DbSizeMB</h3> + <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/5f53ecc/src/database.test.ts#L7">database.test.ts:7</a></li> + </ul> + </aside> + </section> + </section> + <section class="tsd-panel-group tsd-member-group tsd-is-not-exported"> + <h2>Functions</h2> + <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> + <a name="generatestring" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagConst">Const</span> generate<wbr>String</h3> + <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> + <li class="tsd-signature tsd-kind-icon">generate<wbr>String<span class="tsd-signature-symbol">(</span>sizeBytes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <aside class="tsd-sources"> + <ul> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/database.test.ts#L4">database.test.ts:4</a></li> + </ul> + </aside> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5>sizeBytes: <span class="tsd-signature-type">number</span></h5> + </li> + </ul> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h4> + </li> + </ul> + </section> + </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> @@ -86,12 +144,21 @@ <a href="_database_test_.html">"database.test"</a> </li> <li class=" tsd-kind-external-module"> + <a href="_error_model_.html">"error.model"</a> + </li> + <li class=" tsd-kind-external-module"> <a href="_util_.html">"util"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> + <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> + <a href="_database_test_.html#maxdbsizemb" class="tsd-kind-icon">max<wbr>DbSizeMB</a> + </li> + <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> + <a href="_database_test_.html#generatestring" class="tsd-kind-icon">generate<wbr>String</a> + </li> </ul> </nav> </div> diff --git a/docs/modules/_error_model_.html b/docs/modules/_error_model_.html new file mode 100644 index 0000000..dd468c7 --- /dev/null +++ b/docs/modules/_error_model_.html @@ -0,0 +1,254 @@ +<!doctype html> +<html class="default no-js"> +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <title>"error.model" | naive</title> + <meta name="description" content=""> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <link rel="stylesheet" href="../assets/css/main.css"> +</head> +<body> +<header> + <div class="tsd-page-toolbar"> + <div class="container"> + <div class="table-wrap"> + <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> + <div class="field"> + <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> + <input id="tsd-search-field" type="text" /> + </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">naive</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> + <input type="checkbox" id="tsd-filter-only-exported" /> + <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../globals.html">Globals</a> + </li> + <li> + <a href="_error_model_.html">"error.model"</a> + </li> + </ul> + <h1>External module "error.model"</h1> + </div> + </div> +</header> +<div class="container container-main"> + <div class="row"> + <div class="col-8 col-content"> + <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>Enumerations</h3> + <ul class="tsd-index-list"> + <li class="tsd-kind-enum tsd-parent-kind-external-module"><a href="../enums/_error_model_.naiveerrorcode.html" class="tsd-kind-icon">Naive<wbr>Error<wbr>Code</a></li> + </ul> + </section> + <section class="tsd-index-section "> + <h3>Classes</h3> + <ul class="tsd-index-list"> + <li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/_error_model_.naiveerror.html" class="tsd-kind-icon">Naive<wbr>Error</a></li> + </ul> + </section> + <section class="tsd-index-section tsd-is-not-exported"> + <h3>Variables</h3> + <ul class="tsd-index-list"> + <li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="_error_model_.html#e" class="tsd-kind-icon">e</a></li> + </ul> + </section> + <section class="tsd-index-section "> + <h3>Functions</h3> + <ul class="tsd-index-list"> + <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_error_model_.html#lookupmsg" class="tsd-kind-icon">lookup<wbr>Msg</a></li> + </ul> + </section> + </div> + </section> + </section> + <section class="tsd-panel-group tsd-member-group tsd-is-not-exported"> + <h2>Variables</h2> + <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> + <a name="e" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagConst">Const</span> e</h3> + <div class="tsd-signature tsd-kind-icon">e<span class="tsd-signature-symbol">:</span> <a href="../enums/_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/5f53ecc/src/error.model.ts#L6">error.model.ts:6</a></li> + </ul> + </aside> + </section> + </section> + <section class="tsd-panel-group tsd-member-group "> + <h2>Functions</h2> + <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> + <a name="lookupmsg" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagConst">Const</span> lookup<wbr>Msg</h3> + <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> + <li class="tsd-signature tsd-kind-icon">lookup<wbr>Msg<span class="tsd-signature-symbol">(</span>c<span class="tsd-signature-symbol">: </span><a href="../enums/_error_model_.naiveerrorcode.html" class="tsd-signature-type">NaiveErrorCode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"Out of storage space (too big for in memory buffer)"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Uncaught error. Please add message/code in src/error.model.ts"</span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <aside class="tsd-sources"> + <ul> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/error.model.ts#L8">error.model.ts:8</a></li> + </ul> + </aside> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5>c: <a href="../enums/_error_model_.naiveerrorcode.html" class="tsd-signature-type">NaiveErrorCode</a></h5> + </li> + </ul> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">"Out of storage space (too big for in memory buffer)"</span> + <span class="tsd-signature-symbol"> | </span> + <span class="tsd-signature-type">"Uncaught error. Please add message/code in src/error.model.ts"</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="globals "> + <a href="../globals.html"><em>Globals</em></a> + </li> + <li class=" tsd-kind-external-module"> + <a href="_context_model_.html">"context.model"</a> + </li> + <li class=" tsd-kind-external-module"> + <a href="_database_.html">"database"</a> + </li> + <li class=" tsd-kind-external-module"> + <a href="_database_model_.html">"database.model"</a> + </li> + <li class=" tsd-kind-external-module"> + <a href="_database_test_.html">"database.test"</a> + </li> + <li class="current tsd-kind-external-module"> + <a href="_error_model_.html">"error.model"</a> + </li> + <li class=" tsd-kind-external-module"> + <a href="_util_.html">"util"</a> + </li> + </ul> + </nav> + <nav class="tsd-navigation secondary menu-sticky"> + <ul class="before-current"> + <li class=" tsd-kind-enum tsd-parent-kind-external-module"> + <a href="../enums/_error_model_.naiveerrorcode.html" class="tsd-kind-icon">Naive<wbr>Error<wbr>Code</a> + </li> + <li class=" tsd-kind-class tsd-parent-kind-external-module"> + <a href="../classes/_error_model_.naiveerror.html" class="tsd-kind-icon">Naive<wbr>Error</a> + </li> + <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> + <a href="_error_model_.html#e" class="tsd-kind-icon">e</a> + </li> + <li class=" tsd-kind-function tsd-parent-kind-external-module"> + <a href="_error_model_.html#lookupmsg" class="tsd-kind-icon">lookup<wbr>Msg</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-module"><span class="tsd-kind-icon">Module</span></li> + <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> + <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> + <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> + <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> + <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</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-enum"><span class="tsd-kind-icon">Enumeration</span></li> + <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> + <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> + <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> + </ul> + <ul class="tsd-legend"> + <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> + <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> + <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> + <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> + <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> + </ul> + <ul class="tsd-legend"> + <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> + <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</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> + <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> + <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> + <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</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-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> + <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> + <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</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> + <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> + </ul> + <ul class="tsd-legend"> + <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> + <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> + <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> + </ul> + <ul class="tsd-legend"> + <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> + <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> + </ul> + </div> + </div> +</footer> +<div class="container tsd-generator"> + <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p> +</div> +<div class="overlay"></div> +<script src="../assets/js/main.js"></script> +<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> +</body> +</html>
\ No newline at end of file diff --git a/docs/modules/_util_.html b/docs/modules/_util_.html index 83b0891..11aa62b 100644 --- a/docs/modules/_util_.html +++ b/docs/modules/_util_.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/0ddd6bf/src/util.ts#L1">util.ts:1</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/5f53ecc/src/util.ts#L1">util.ts:1</a></li> </ul> </aside> <h4 class="tsd-type-parameters-title">Type parameters</h4> @@ -130,6 +130,9 @@ <li class=" tsd-kind-external-module"> <a href="_database_test_.html">"database.test"</a> </li> + <li class=" tsd-kind-external-module"> + <a href="_error_model_.html">"error.model"</a> + </li> <li class="current tsd-kind-external-module"> <a href="_util_.html">"util"</a> </li> |