summaryrefslogtreecommitdiff
path: root/docs/interfaces
diff options
context:
space:
mode:
authorNick Van Doorn <vandoorn.nick@gmail.com>2019-01-19 20:15:41 -0800
committerNick Van Doorn <vandoorn.nick@gmail.com>2019-01-19 20:15:41 -0800
commitf76dd400cca48fe80b56a2d4272a6ead70e7298d (patch)
tree27fd775fbe28fc1fead275a6f09e3e495e0dafbf /docs/interfaces
parent0ddd6bffb0bb838035d130053368b40b950abc33 (diff)
Generate docs on build
Diffstat (limited to 'docs/interfaces')
-rw-r--r--docs/interfaces/_context_model_.context.html250
-rw-r--r--docs/interfaces/_database_model_.databaseinterface.html363
2 files changed, 613 insertions, 0 deletions
diff --git a/docs/interfaces/_context_model_.context.html b/docs/interfaces/_context_model_.context.html
new file mode 100644
index 0000000..b94fb12
--- /dev/null
+++ b/docs/interfaces/_context_model_.context.html
@@ -0,0 +1,250 @@
+<!doctype html>
+<html class="default no-js">
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <title>Context | 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/_context_model_.html">&quot;context.model&quot;</a>
+ </li>
+ <li>
+ <a href="_context_model_.context.html">Context</a>
+ </li>
+ </ul>
+ <h1>Interface Context</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">Context</span>
+ </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>Properties</h3>
+ <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>
+ </ul>
+ </section>
+ </div>
+ </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-interface">
+ <a name="cachepath" class="tsd-anchor"></a>
+ <h3>cache<wbr>Path</h3>
+ <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>
+ </ul>
+ </aside>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+ <a name="logger" class="tsd-anchor"></a>
+ <h3>logger</h3>
+ <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>
+ </ul>
+ </aside>
+ <div class="tsd-type-declaration">
+ <h4>Type declaration</h4>
+ <ul class="tsd-parameters">
+ <li class="tsd-parameter-siganture">
+ <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property 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">void</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">void</span></h4>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </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="current 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/_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="_context_model_.context.html" class="tsd-kind-icon">Context</a>
+ <ul>
+ <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>
+ </ul>
+ </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/_database_model_.databaseinterface.html b/docs/interfaces/_database_model_.databaseinterface.html
new file mode 100644
index 0000000..c880089
--- /dev/null
+++ b/docs/interfaces/_database_model_.databaseinterface.html
@@ -0,0 +1,363 @@
+<!doctype html>
+<html class="default no-js">
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <title>DatabaseInterface | 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/_database_model_.html">&quot;database.model&quot;</a>
+ </li>
+ <li>
+ <a href="_database_model_.databaseinterface.html">DatabaseInterface</a>
+ </li>
+ </ul>
+ <h1>Interface DatabaseInterface</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">DatabaseInterface</span>
+ </li>
+ </ul>
+ </section>
+ <section class="tsd-panel">
+ <h3>Implemented by</h3>
+ <ul class="tsd-hierarchy">
+ <li><a href="../classes/_database_.database.html" class="tsd-signature-type">Database</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>Methods</h3>
+ <ul class="tsd-index-list">
+ <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_database_model_.databaseinterface.html#flush" class="tsd-kind-icon">flush</a></li>
+ <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#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>
+ </section>
+ </div>
+ </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-interface">
+ <a name="flush" class="tsd-anchor"></a>
+ <h3>flush</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
+ <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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/0ddd6bf/src/database.model.ts#L35">database.model.ts:35</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Empty the database</p>
+ </div>
+ </div>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
+ </li>
+ </ul>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
+ <a name="init" class="tsd-anchor"></a>
+ <h3>init</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
+ <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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/0ddd6bf/src/database.model.ts#L10">database.model.ts:10</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Init the database with state
+ stored in the cache file.</p>
+ </div>
+ <p>Calling init is not mandatory,
+ but is required for any form
+ of non-volatile storage</p>
+ </div>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
+ </li>
+ </ul>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
+ <a name="read" class="tsd-anchor"></a>
+ <h3>read</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
+ <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">&lt;</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">&gt;</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/0ddd6bf/src/database.model.ts#L19">database.model.ts:19</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Read data from the &quot;node&quot; described by path
+ where path uses &quot;/&quot; to separate nodes</p>
+ </div>
+ <p>null is returned if there is no data
+ at path</p>
+ </div>
+ <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">&lt;</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">&gt;</span></h4>
+ </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">
+ <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">Object</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/0ddd6bf/src/database.model.ts#L40">database.model.ts:40</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>String representation (JSON) of the database</p>
+ </div>
+ </div>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Object</span></h4>
+ </li>
+ </ul>
+ </section>
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
+ <a name="write" class="tsd-anchor"></a>
+ <h3>write</h3>
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
+ <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">Object</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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/0ddd6bf/src/database.model.ts#L30">database.model.ts:30</a></li>
+ </ul>
+ </aside>
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>Write data to the node described by path
+ where path once again uses &quot;/&quot; separate nodes</p>
+ </div>
+ <p>toWrite can be any plain JavaScript object
+ (e.g anything that can be serialized with JSON.stringify)</p>
+ <p>An exception is thrown if the write fails</p>
+ </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>toWrite: <span class="tsd-signature-type">Object</span></h5>
+ </li>
+ </ul>
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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="../modules/_context_model_.html">"context.model"</a>
+ </li>
+ <li class=" tsd-kind-external-module">
+ <a href="../modules/_database_.html">"database"</a>
+ </li>
+ <li class="current 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/_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="_database_model_.databaseinterface.html" class="tsd-kind-icon">Database<wbr>Interface</a>
+ <ul>
+ <li class=" tsd-kind-method tsd-parent-kind-interface">
+ <a href="_database_model_.databaseinterface.html#flush" class="tsd-kind-icon">flush</a>
+ </li>
+ <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#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>
+ </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