diff options
Diffstat (limited to 'docs/interfaces')
| -rw-r--r-- | docs/interfaces/_change_handlers_model_.changehandlers.html | 220 | ||||
| -rw-r--r-- | docs/interfaces/_context_model_.context.html | 27 | ||||
| -rw-r--r-- | docs/interfaces/_database_model_.databaseinterface.html | 80 |
3 files changed, 318 insertions, 9 deletions
diff --git a/docs/interfaces/_change_handlers_model_.changehandlers.html b/docs/interfaces/_change_handlers_model_.changehandlers.html new file mode 100644 index 0000000..6f4613c --- /dev/null +++ b/docs/interfaces/_change_handlers_model_.changehandlers.html @@ -0,0 +1,220 @@ +<!doctype html> +<html class="default no-js"> +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <title>ChangeHandlers | 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/_change_handlers_model_.html">"change-handlers.model"</a> + </li> + <li> + <a href="_change_handlers_model_.changehandlers.html">ChangeHandlers</a> + </li> + </ul> + <h1>Interface ChangeHandlers</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="target">ChangeHandlers</span> + </li> + </ul> + </section> + <section class="tsd-panel tsd-kind-interface tsd-parent-kind-external-module"> + <h3 class="tsd-before-signature">Indexable</h3> + <div class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">[</span>handlerKey: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">object</span></div> + <ul class="tsd-parameters"> + <li class="tsd-parameter"> + <h5>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span></h5> + <ul class="tsd-parameters"> + <li class="tsd-parameter-siganture"> + <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported"> + <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5>e: <span class="tsd-signature-type">any</span></h5> + </li> + </ul> + <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> + </li> + </ul> + </li> + </ul> + </li> + <li class="tsd-parameter"> + <h5>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> + </li> + </ul> + </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="current tsd-kind-external-module"> + <a href="../modules/_change_handlers_model_.html">"change-<wbr>handlers.model"</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=" 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-interface tsd-parent-kind-external-module"> + <a href="_change_handlers_model_.changehandlers.html" class="tsd-kind-icon">Change<wbr>Handlers</a> + </li> + </ul> + <ul class="after-current"> + </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/interfaces/_context_model_.context.html b/docs/interfaces/_context_model_.context.html index d72aa8a..0179a6f 100644 --- a/docs/interfaces/_context_model_.context.html +++ b/docs/interfaces/_context_model_.context.html @@ -100,9 +100,14 @@ <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/d590774/src/context.model.ts#L3">context.model.ts:3</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/638ff46/src/context.model.ts#L13">context.model.ts:13</a></li> </ul> </aside> + <div class="tsd-comment tsd-typography"> + <div class="lead"> + <p>Location of the database cache file (JSON file)</p> + </div> + </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="logger" class="tsd-anchor"></a> @@ -110,9 +115,17 @@ <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/d590774/src/context.model.ts#L2">context.model.ts:2</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/638ff46/src/context.model.ts#L9">context.model.ts:9</a></li> </ul> </aside> + <div class="tsd-comment tsd-typography"> + <div class="lead"> + <p>Method used to log.</p> + </div> + <p>console.log is usually supplied + but it may be handy to pipe it elsewhere + later</p> + </div> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> @@ -141,9 +154,14 @@ <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/d590774/src/context.model.ts#L4">context.model.ts:4</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/638ff46/src/context.model.ts#L17">context.model.ts:17</a></li> </ul> </aside> + <div class="tsd-comment tsd-typography"> + <div class="lead"> + <p>Maximum database size in megabytes</p> + </div> + </div> </section> </section> </div> @@ -153,6 +171,9 @@ <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> + <li class=" tsd-kind-external-module"> + <a href="../modules/_change_handlers_model_.html">"change-<wbr>handlers.model"</a> + </li> <li class="current tsd-kind-external-module"> <a href="../modules/_context_model_.html">"context.model"</a> </li> diff --git a/docs/interfaces/_database_model_.databaseinterface.html b/docs/interfaces/_database_model_.databaseinterface.html index 031c8ab..fe0cc31 100644 --- a/docs/interfaces/_database_model_.databaseinterface.html +++ b/docs/interfaces/_database_model_.databaseinterface.html @@ -94,6 +94,7 @@ <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_database_model_.databaseinterface.html#init" class="tsd-kind-icon">init</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_database_model_.databaseinterface.html#read" class="tsd-kind-icon">read</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_database_model_.databaseinterface.html#remove" class="tsd-kind-icon">remove</a></li> + <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_database_model_.databaseinterface.html#subscribe" class="tsd-kind-icon">subscribe</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_database_model_.databaseinterface.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_database_model_.databaseinterface.html#write" class="tsd-kind-icon">write</a></li> </ul> @@ -113,7 +114,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/d590774/src/database.model.ts#L40">database.model.ts:40</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/638ff46/src/database.model.ts#L45">database.model.ts:45</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -135,7 +136,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/d590774/src/database.model.ts#L10">database.model.ts:10</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/638ff46/src/database.model.ts#L10">database.model.ts:10</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -161,7 +162,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/d590774/src/database.model.ts#L19">database.model.ts:19</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/638ff46/src/database.model.ts#L19">database.model.ts:19</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -192,7 +193,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/d590774/src/database.model.ts#L35">database.model.ts:35</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/638ff46/src/database.model.ts#L40">database.model.ts:40</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -211,6 +212,67 @@ </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> + <a name="subscribe" class="tsd-anchor"></a> + <h3>subscribe</h3> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> + <li class="tsd-signature tsd-kind-icon">subscribe<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</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/638ff46/src/database.model.ts#L24">database.model.ts:24</a></li> + </ul> + </aside> + <div class="tsd-comment tsd-typography"> + <div class="lead"> + <p>Subscribe to all data changes at path</p> + </div> + </div> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5>path: <span class="tsd-signature-type">string</span></h5> + </li> + <li> + <h5>callback: <span class="tsd-signature-type">function</span></h5> + <ul class="tsd-parameters"> + <li class="tsd-parameter-siganture"> + <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> + <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5>e: <span class="tsd-signature-type">any</span></h5> + </li> + </ul> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> + </li> + </ul> + </li> + </ul> + </li> + </ul> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">function</span></h4> + <ul class="tsd-parameters"> + <li class="tsd-parameter-siganture"> + <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> + <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> + </li> + </ul> + </li> + </ul> + </li> + </ul> + </section> + <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="tostring" class="tsd-anchor"></a> <h3>to<wbr>String</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> @@ -220,7 +282,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/d590774/src/database.model.ts#L45">database.model.ts:45</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/638ff46/src/database.model.ts#L50">database.model.ts:50</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -242,7 +304,7 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/d590774/src/database.model.ts#L30">database.model.ts:30</a></li> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/638ff46/src/database.model.ts#L35">database.model.ts:35</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -276,6 +338,9 @@ <a href="../globals.html"><em>Globals</em></a> </li> <li class=" tsd-kind-external-module"> + <a href="../modules/_change_handlers_model_.html">"change-<wbr>handlers.model"</a> + </li> + <li class=" tsd-kind-external-module"> <a href="../modules/_context_model_.html">"context.model"</a> </li> <li class=" tsd-kind-external-module"> @@ -315,6 +380,9 @@ <a href="_database_model_.databaseinterface.html#remove" class="tsd-kind-icon">remove</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface"> + <a href="_database_model_.databaseinterface.html#subscribe" class="tsd-kind-icon">subscribe</a> + </li> + <li class=" tsd-kind-method tsd-parent-kind-interface"> <a href="_database_model_.databaseinterface.html#tostring" class="tsd-kind-icon">to<wbr>String</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface"> |