diff options
| author | Nick Van Doorn <vandoorn.nick@gmail.com> | 2019-01-19 20:15:41 -0800 |
|---|---|---|
| committer | Nick Van Doorn <vandoorn.nick@gmail.com> | 2019-01-19 20:15:41 -0800 |
| commit | f76dd400cca48fe80b56a2d4272a6ead70e7298d (patch) | |
| tree | 27fd775fbe28fc1fead275a6f09e3e495e0dafbf /docs/modules/_database_.html | |
| parent | 0ddd6bffb0bb838035d130053368b40b950abc33 (diff) | |
Generate docs on build
Diffstat (limited to 'docs/modules/_database_.html')
| -rw-r--r-- | docs/modules/_database_.html | 295 |
1 files changed, 295 insertions, 0 deletions
diff --git a/docs/modules/_database_.html b/docs/modules/_database_.html new file mode 100644 index 0000000..43017d4 --- /dev/null +++ b/docs/modules/_database_.html @@ -0,0 +1,295 @@ +<!doctype html> +<html class="default no-js"> +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <title>"database" | 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="_database_.html">"database"</a> + </li> + </ul> + <h1>External module "database"</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>Classes</h3> + <ul class="tsd-index-list"> + <li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/_database_.database.html" class="tsd-kind-icon">Database</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="_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="_database_.html#write" class="tsd-kind-icon">write</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_.html#splitpath" class="tsd-kind-icon">split<wbr>Path</a></li> + </ul> + </section> + <section class="tsd-index-section "> + <h3>Object literals</h3> + <ul class="tsd-index-list"> + <li class="tsd-kind-object-literal tsd-parent-kind-external-module"><a href="_database_.html#default_ctx" class="tsd-kind-icon">DEFAULT_<wbr>CTX</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="read" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagConst">Const</span> read</h3> + <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> + </ul> + </aside> + </section> + <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> + <a name="write" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagConst">Const</span> write</h3> + <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> + </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="splitpath" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagConst">Const</span> split<wbr>Path</h3> + <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> + <li class="tsd-signature tsd-kind-icon">split<wbr>Path<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">string</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/0ddd6bf/src/database.ts#L9">database.ts:9</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">string</span><span class="tsd-signature-symbol">[]</span></h4> + </li> + </ul> + </section> + </section> + <section class="tsd-panel-group tsd-member-group "> + <h2>Object literals</h2> + <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-external-module"> + <a name="default_ctx" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>CTX</h3> + <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> + </ul> + </aside> + <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> + <a name="default_ctx.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><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> + </ul> + </aside> + </section> + <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> + <a name="default_ctx.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">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> + </ul> + </aside> + </section> + </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="current 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=" 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-class tsd-parent-kind-external-module"> + <a href="../classes/_database_.database.html" class="tsd-kind-icon">Database</a> + </li> + <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> + <a href="_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="_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="_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="_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 |