diff options
Diffstat (limited to 'core/docs/classes/_core_src_database_.database.html')
| -rw-r--r-- | core/docs/classes/_core_src_database_.database.html | 711 |
1 files changed, 711 insertions, 0 deletions
diff --git a/core/docs/classes/_core_src_database_.database.html b/core/docs/classes/_core_src_database_.database.html new file mode 100644 index 0000000..0836284 --- /dev/null +++ b/core/docs/classes/_core_src_database_.database.html @@ -0,0 +1,711 @@ +<!doctype html> +<html class="default no-js"> +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <title>Database | @nvandoorn/naive-core</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">@nvandoorn/naive-core</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/_core_src_database_.html">"core/src/database"</a> + </li> + <li> + <a href="_core_src_database_.database.html">Database</a> + </li> + </ul> + <h1>Class Database</h1> + </div> + </div> +</header> +<div class="container container-main"> + <div class="row"> + <div class="col-8 col-content"> + <section class="tsd-panel tsd-comment"> + <div class="tsd-comment tsd-typography"> + <div class="lead"> + <p>Implementation of NoSQL DB that uses paths and objects.</p> + </div> + <p>See DatabaseInterface for docs on public API</p> + <p>Uses a plain object as a buffer and reads/writes to a + plain JSON file. A better implementation could be backed + by somethig a little nicer and not hold the buffer + in memory</p> + </div> + </section> + <section class="tsd-panel tsd-hierarchy"> + <h3>Hierarchy</h3> + <ul class="tsd-hierarchy"> + <li> + <span class="target">Database</span> + </li> + </ul> + </section> + <section class="tsd-panel"> + <h3>Implements</h3> + <ul class="tsd-hierarchy"> + <li><a href="../interfaces/_core_src_database_model_.databaseinterface.html" class="tsd-signature-type">DatabaseInterface</a></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="_core_src_database_.database.html#constructor" class="tsd-kind-icon">constructor</a></li> + </ul> + </section> + <section class="tsd-index-section tsd-is-private tsd-is-private-protected"> + <h3>Properties</h3> + <ul class="tsd-index-list"> + <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_core_src_database_.database.html#buff" class="tsd-kind-icon">buff</a></li> + <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_core_src_database_.database.html#changehandlers" class="tsd-kind-icon">change<wbr>Handlers</a></li> + <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_core_src_database_.database.html#ctx" class="tsd-kind-icon">ctx</a></li> + </ul> + </section> + <section class="tsd-index-section "> + <h3>Methods</h3> + <ul class="tsd-index-list"> + <li class="tsd-kind-method tsd-parent-kind-class"><a href="_core_src_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="_core_src_database_.database.html#hasspace" class="tsd-kind-icon">has<wbr>Space</a></li> + <li class="tsd-kind-method tsd-parent-kind-class"><a href="_core_src_database_.database.html#init" class="tsd-kind-icon">init</a></li> + <li class="tsd-kind-method tsd-parent-kind-class"><a href="_core_src_database_.database.html#read" class="tsd-kind-icon">read</a></li> + <li class="tsd-kind-method tsd-parent-kind-class"><a href="_core_src_database_.database.html#remove" class="tsd-kind-icon">remove</a></li> + <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_core_src_database_.database.html#resolve" class="tsd-kind-icon">resolve</a></li> + <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_core_src_database_.database.html#runchangehandlers" class="tsd-kind-icon">run<wbr>Change<wbr>Handlers</a></li> + <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_core_src_database_.database.html#serialize" class="tsd-kind-icon">serialize</a></li> + <li class="tsd-kind-method tsd-parent-kind-class"><a href="_core_src_database_.database.html#subscribe" class="tsd-kind-icon">subscribe</a></li> + <li class="tsd-kind-method tsd-parent-kind-class"><a href="_core_src_database_.database.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li> + <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_core_src_database_.database.html#unsubscribe" class="tsd-kind-icon">unsubscribe</a></li> + <li class="tsd-kind-method tsd-parent-kind-class"><a href="_core_src_database_.database.html#write" class="tsd-kind-icon">write</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>Database<span class="tsd-signature-symbol">(</span>ctx<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_core_src_context_model_.context.html" class="tsd-signature-type">Context</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_core_src_database_.database.html" class="tsd-signature-type">Database</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/be7f8d0/core/src/database.ts#L63">core/src/database.ts:63</a></li> + </ul> + </aside> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5><span class="tsd-flag ts-flagDefault value">Default value</span> ctx: <a href="../interfaces/_core_src_context_model_.context.html" class="tsd-signature-type">Context</a><span class="tsd-signature-symbol"> = DEFAULT_CTX</span></h5> + </li> + </ul> + <h4 class="tsd-returns-title">Returns <a href="_core_src_database_.database.html" class="tsd-signature-type">Database</a></h4> + </li> + </ul> + </section> + </section> + <section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected"> + <h2>Properties</h2> + <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> + <a name="buff" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagPrivate">Private</span> buff</h3> + <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/be7f8d0/core/src/database.ts#L57">core/src/database.ts:57</a></li> + </ul> + </aside> + <div class="tsd-comment tsd-typography"> + <div class="lead"> + <p>In memory buffer to read/write data</p> + </div> + </div> + </section> + <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> + <a name="changehandlers" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagPrivate">Private</span> change<wbr>Handlers</h3> + <div class="tsd-signature tsd-kind-icon">change<wbr>Handlers<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_core_src_change_handlers_model_.changehandlers.html" class="tsd-signature-type">ChangeHandlers</a></div> + <aside class="tsd-sources"> + <ul> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/be7f8d0/core/src/database.ts#L63">core/src/database.ts:63</a></li> + </ul> + </aside> + <div class="tsd-comment tsd-typography"> + <div class="lead"> + <p>An array of callback functions that are alerted + when the database changes (mostly want to use this + for some type of pubsub functionality on-top)</p> + </div> + </div> + </section> + <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> + <a name="ctx" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagPrivate">Private</span> ctx</h3> + <div class="tsd-signature tsd-kind-icon">ctx<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_core_src_context_model_.context.html" class="tsd-signature-type">Context</a></div> + <aside class="tsd-sources"> + <ul> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/be7f8d0/core/src/database.ts#L64">core/src/database.ts:64</a></li> + </ul> + </aside> + </section> + </section> + <section class="tsd-panel-group tsd-member-group "> + <h2>Methods</h2> + <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> + <a name="flush" class="tsd-anchor"></a> + <h3>flush</h3> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> + <li class="tsd-signature tsd-kind-icon">flush<span class="tsd-signature-symbol">(</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">void</span><span class="tsd-signature-symbol">></span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <aside class="tsd-sources"> + <p>Implementation of <a href="../interfaces/_core_src_database_model_.databaseinterface.html">DatabaseInterface</a>.<a href="../interfaces/_core_src_database_model_.databaseinterface.html#flush">flush</a></p> + <ul> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/be7f8d0/core/src/database.ts#L125">core/src/database.ts:125</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/be7f8d0/core/src/database.ts#L202">core/src/database.ts:202</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> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> + <li class="tsd-signature tsd-kind-icon">init<span class="tsd-signature-symbol">(</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">void</span><span class="tsd-signature-symbol">></span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <aside class="tsd-sources"> + <p>Implementation of <a href="../interfaces/_core_src_database_model_.databaseinterface.html">DatabaseInterface</a>.<a href="../interfaces/_core_src_database_model_.databaseinterface.html#init">init</a></p> + <ul> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/be7f8d0/core/src/database.ts#L66">core/src/database.ts:66</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"> + <a name="read" class="tsd-anchor"></a> + <h3>read</h3> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> + <li class="tsd-signature tsd-kind-icon">read<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">></span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <aside class="tsd-sources"> + <p>Implementation of <a href="../interfaces/_core_src_database_model_.databaseinterface.html">DatabaseInterface</a>.<a href="../interfaces/_core_src_database_model_.databaseinterface.html#read">read</a></p> + <ul> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/be7f8d0/core/src/database.ts#L79">core/src/database.ts:79</a></li> + </ul> + </aside> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5>path: <span class="tsd-signature-type">string</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">Object</span><span class="tsd-signature-symbol">></span></h4> + </li> + </ul> + </section> + <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> + <a name="remove" class="tsd-anchor"></a> + <h3>remove</h3> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> + <li class="tsd-signature tsd-kind-icon">remove<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <aside class="tsd-sources"> + <p>Implementation of <a href="../interfaces/_core_src_database_model_.databaseinterface.html">DatabaseInterface</a>.<a href="../interfaces/_core_src_database_model_.databaseinterface.html#remove">remove</a></p> + <ul> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/be7f8d0/core/src/database.ts#L121">core/src/database.ts:121</a></li> + </ul> + </aside> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5>path: <span class="tsd-signature-type">string</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">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="resolve" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagPrivate">Private</span> resolve</h3> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> + <li class="tsd-signature tsd-kind-icon">resolve<span class="tsd-signature-symbol">(</span>pathParts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, isRead<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, level<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></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/be7f8d0/core/src/database.ts#L146">core/src/database.ts:146</a></li> + </ul> + </aside> + <div class="tsd-comment tsd-typography"> + <div class="lead"> + <p>Resolve the object located at path.</p> + </div> + <p>If isRead == true, no new nodes will + be created, and the function will return + null if a null node is encountered on the path. + Else, we create each node on the path.</p> + <p>Level is used to determine how deep + to recurse on path. Callers interested in + writing may wish to stop higher up the tree.</p> + </div> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5>pathParts: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagDefault value">Default value</span> isRead: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagDefault value">Default value</span> level: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></h5> + </li> + </ul> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> + </li> + </ul> + </section> + <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"> + <a name="runchangehandlers" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagPrivate">Private</span> run<wbr>Change<wbr>Handlers</h3> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> + <li class="tsd-signature tsd-kind-icon">run<wbr>Change<wbr>Handlers<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, change<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">void</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/be7f8d0/core/src/database.ts#L99">core/src/database.ts:99</a></li> + </ul> + </aside> + <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>change: <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">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="serialize" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagPrivate">Private</span> serialize</h3> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> + <li class="tsd-signature tsd-kind-icon">serialize<span class="tsd-signature-symbol">(</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">void</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/be7f8d0/core/src/database.ts#L197">core/src/database.ts:197</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> + </section> + <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> + <a name="subscribe" class="tsd-anchor"></a> + <h3>subscribe</h3> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> + <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/be7f8d0/core/src/database.ts#L108">core/src/database.ts:108</a></li> + </ul> + </aside> + <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">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> + </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-class"> + <a name="tostring" class="tsd-anchor"></a> + <h3>to<wbr>String</h3> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> + <li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <aside class="tsd-sources"> + <p>Implementation of <a href="../interfaces/_core_src_database_model_.databaseinterface.html">DatabaseInterface</a>.<a href="../interfaces/_core_src_database_model_.databaseinterface.html#tostring">toString</a></p> + <ul> + <li>Defined in <a href="https://github.com/nvandoorn/naive/blob/be7f8d0/core/src/database.ts#L130">core/src/database.ts:130</a></li> + </ul> + </aside> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> + </li> + </ul> + </section> + <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"> + <a name="unsubscribe" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagPrivate">Private</span> unsubscribe</h3> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> + <li class="tsd-signature tsd-kind-icon">unsubscribe<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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/be7f8d0/core/src/database.ts#L117">core/src/database.ts:117</a></li> + </ul> + </aside> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5>key: <span class="tsd-signature-type">string</span></h5> + </li> + </ul> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> + </li> + </ul> + </section> + <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> + <a name="write" class="tsd-anchor"></a> + <h3>write</h3> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> + <li class="tsd-signature tsd-kind-icon">write<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, toWrite<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">void</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/be7f8d0/core/src/database.ts#L86">core/src/database.ts:86</a></li> + </ul> + </aside> + <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>toWrite: <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">void</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"> + <ul> + <li class="globals "> + <a href="../globals.html"><em>Globals</em></a> + </li> + <li class="label tsd-is-external"> + <span>Internals</span> + </li> + <li class=" tsd-kind-external-module"> + <a href="../modules/_core_src_change_handlers_model_.html">"core/src/change-<wbr>handlers.model"</a> + </li> + <li class=" tsd-kind-external-module"> + <a href="../modules/_core_src_context_model_.html">"core/src/context.model"</a> + </li> + <li class="current tsd-kind-external-module"> + <a href="../modules/_core_src_database_.html">"core/src/database"</a> + </li> + <li class=" tsd-kind-external-module"> + <a href="../modules/_core_src_database_model_.html">"core/src/database.model"</a> + </li> + <li class=" tsd-kind-external-module"> + <a href="../modules/_core_src_database_test_.html">"core/src/database.test"</a> + </li> + <li class="label tsd-is-external"> + <span>Externals</span> + </li> + <li class=" tsd-kind-external-module tsd-is-external"> + <a href="../modules/_lib_error_model_.html">"lib/error.model"</a> + </li> + <li class=" tsd-kind-external-module tsd-is-external"> + <a href="../modules/_lib_util_.html">"lib/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-class tsd-parent-kind-external-module"> + <a href="_core_src_database_.database.html" class="tsd-kind-icon">Database</a> + <ul> + <li class=" tsd-kind-constructor tsd-parent-kind-class"> + <a href="_core_src_database_.database.html#constructor" class="tsd-kind-icon">constructor</a> + </li> + <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> + <a href="_core_src_database_.database.html#buff" class="tsd-kind-icon">buff</a> + </li> + <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> + <a href="_core_src_database_.database.html#changehandlers" class="tsd-kind-icon">change<wbr>Handlers</a> + </li> + <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> + <a href="_core_src_database_.database.html#ctx" class="tsd-kind-icon">ctx</a> + </li> + <li class=" tsd-kind-method tsd-parent-kind-class"> + <a href="_core_src_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="_core_src_database_.database.html#hasspace" class="tsd-kind-icon">has<wbr>Space</a> + </li> + <li class=" tsd-kind-method tsd-parent-kind-class"> + <a href="_core_src_database_.database.html#init" class="tsd-kind-icon">init</a> + </li> + <li class=" tsd-kind-method tsd-parent-kind-class"> + <a href="_core_src_database_.database.html#read" class="tsd-kind-icon">read</a> + </li> + <li class=" tsd-kind-method tsd-parent-kind-class"> + <a href="_core_src_database_.database.html#remove" class="tsd-kind-icon">remove</a> + </li> + <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private"> + <a href="_core_src_database_.database.html#resolve" class="tsd-kind-icon">resolve</a> + </li> + <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private"> + <a href="_core_src_database_.database.html#runchangehandlers" class="tsd-kind-icon">run<wbr>Change<wbr>Handlers</a> + </li> + <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private"> + <a href="_core_src_database_.database.html#serialize" class="tsd-kind-icon">serialize</a> + </li> + <li class=" tsd-kind-method tsd-parent-kind-class"> + <a href="_core_src_database_.database.html#subscribe" class="tsd-kind-icon">subscribe</a> + </li> + <li class=" tsd-kind-method tsd-parent-kind-class"> + <a href="_core_src_database_.database.html#tostring" class="tsd-kind-icon">to<wbr>String</a> + </li> + <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private"> + <a href="_core_src_database_.database.html#unsubscribe" class="tsd-kind-icon">unsubscribe</a> + </li> + <li class=" tsd-kind-method tsd-parent-kind-class"> + <a href="_core_src_database_.database.html#write" class="tsd-kind-icon">write</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/_core_src_database_.html#read" class="tsd-kind-icon">read</a> + </li> + <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> + <a href="../modules/_core_src_database_.html#write" class="tsd-kind-icon">write</a> + </li> + <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> + <a href="../modules/_core_src_database_.html#ischildormatch" class="tsd-kind-icon">is<wbr>Child<wbr>OrMatch</a> + </li> + <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> + <a href="../modules/_core_src_database_.html#isrootnode" class="tsd-kind-icon">is<wbr>Root<wbr>Node</a> + </li> + <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> + <a href="../modules/_core_src_database_.html#splitpath" class="tsd-kind-icon">split<wbr>Path</a> + </li> + <li class=" tsd-kind-object-literal tsd-parent-kind-external-module"> + <a href="../modules/_core_src_database_.html#default_ctx" class="tsd-kind-icon">DEFAULT_<wbr>CTX</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 |