Skip to content

Commit

Permalink
Production deploy -- ff4f3d0
Browse files Browse the repository at this point in the history
  • Loading branch information
@bherr2
bherr2 committed Apr 12, 2022
1 parent 9b3f4d3 commit 8cef991
Show file tree
Hide file tree
Showing 69 changed files with 2,950 additions and 647 deletions.
2 changes: 1 addition & 1 deletion body-ui/main.js
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion body-ui/wc.js
View file

Large diffs are not rendered by default.

347 changes: 347 additions & 0 deletions docs/ccf-api/classes/CCFDatabaseInstance.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,347 @@
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>Library ccf-api documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">

<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/style.css">
<link rel="stylesheet" href="../styles/dark.css" media="(prefers-color-scheme: dark)">
</head>
<body>

<div class="navbar navbar-default navbar-fixed-top visible-xs">
<a href="../" class="navbar-brand">Library ccf-api documentation</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>

<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
</div>

<div class="container-fluid main">
<div class="row main">
<div class="hidden-xs menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content class">
<div class="content-data">











<ol class="breadcrumb">
<li>Classes</li>
<li >CCFDatabaseInstance</li>
</ol>

<ul class="nav nav-tabs" role="tablist">
<li class="active">
<a href="#info" role="tab" id="info-tab" data-toggle="tab" data-link="info">Info</a>
</li>
<li >
<a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a>
</li>
</ul>

<div class="tab-content">
<div class="tab-pane fade active in" id="c-info">
<p class="comment">
<h3>File</h3>
</p>
<p class="comment">
<code>projects/ccf-api/src/lib/utils/ccf-database-worker.ts</code>
</p>






<section>
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
<tr>
<td class="col-md-4">
<h6><b>Properties</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier">Public</span>
<a href="#database" >database</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#dispose" >dispose</a>
</li>
<li>
<span class="modifier">Readonly</span>
<a href="#status" >status</a>
</li>
</ul>
</td>
</tr>






</tbody>
</table>
</section>

<section>
<h3 id="constructor">Constructor</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<code>constructor(database: CCFDatabase, dispose: () => void)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="8" class="link-to-prism">projects/ccf-api/src/lib/utils/ccf-database-worker.ts:8</a></div>
</td>
</tr>

<tr>
<td class="col-md-4">
<div>
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>database</td>

<td>
<code>CCFDatabase</code>
</td>

<td>
No
</td>

</tr>
<tr>
<td>dispose</td>

<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function" target="_blank" >function</a></code>
</td>

<td>
No
</td>

</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section>

<section>

<h3 id="inputs">
Properties
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="database"></a>
<span class="name">
<span class="modifier">Public</span>
<span ><b>database</b></span>
<a href="#database"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>CCFDatabase</code>

</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="10" class="link-to-prism">projects/ccf-api/src/lib/utils/ccf-database-worker.ts:10</a></div>
</td>
</tr>


</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="dispose"></a>
<span class="name">
<span class="modifier">Public</span>
<span ><b>dispose</b></span>
<a href="#dispose"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function" target="_blank" >function</a></code>

</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="10" class="link-to-prism">projects/ccf-api/src/lib/utils/ccf-database-worker.ts:10</a></div>
</td>
</tr>


</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="status"></a>
<span class="name">
<span class="modifier">Readonly</span>
<span ><b>status</b></span>
<a href="#status"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>new CCFDatabaseStatusTracker(this.database)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="8" class="link-to-prism">projects/ccf-api/src/lib/utils/ccf-database-worker.ts:8</a></div>
</td>
</tr>


</tbody>
</table>
</section>







</div>


<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { CCFDatabase, CCFDatabaseOptions, CCFDatabaseStatusTracker } from &#x27;ccf-database&#x27;;
import { releaseProxy, wrap } from &#x27;comlink&#x27;;
import nodeEndpoint from &#x27;comlink/dist/umd/node-adapter&#x27;;
import { Worker } from &#x27;worker_threads&#x27;;


export class CCFDatabaseInstance {
readonly status &#x3D; new CCFDatabaseStatusTracker(this.database);

constructor(public database: CCFDatabase, public dispose: () &#x3D;&gt; Promise&lt;void&gt;) { }
}

export async function createCCFDatabaseWorker(options: CCFDatabaseOptions): Promise&lt;CCFDatabaseInstance&gt; {
const worker &#x3D; new Worker(&#x27;./projects/ccf-api/ccf-database.worker.js&#x27;, { workerData: { options } });
const database &#x3D; wrap&lt;CCFDatabase&gt;(nodeEndpoint(worker));
return new CCFDatabaseInstance(database as unknown as CCFDatabase, async () &#x3D;&gt; {
database[releaseProxy]();
await worker.terminate();
});
}
</code></pre>
</div>
</div>








</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> result-matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>

<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'class';
var COMPODOC_CURRENT_PAGE_URL = 'CCFDatabaseInstance.html';
var MAX_SEARCH_RESULTS = 15;
</script>

<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>

<script type="module" src="../js/menu-wc.js" defer></script>
<script nomodule src="../js/menu-wc_es5.js" defer></script>

<script src="../js/libs/bootstrap-native.js"></script>

<script src="../js/libs/es6-shim.min.js"></script>
<script src="../js/libs/EventDispatcher.js"></script>
<script src="../js/libs/promise.min.js"></script>
<script src="../js/libs/zepto.min.js"></script>

<script src="../js/compodoc.js"></script>

<script src="../js/tabs.js"></script>
<script src="../js/menu.js"></script>
<script src="../js/libs/clipboard.min.js"></script>
<script src="../js/libs/prism.js"></script>
<script src="../js/sourceCode.js"></script>
<script src="../js/search/search.js"></script>
<script src="../js/search/lunr.min.js"></script>
<script src="../js/search/search-lunr.js"></script>
<script src="../js/search/search_index.js"></script>
<script src="../js/lazy-load-graphs.js"></script>


</body>
</html>
30 changes: 27 additions & 3 deletions docs/ccf-api/coverage.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,30 @@
<span class="coverage-count">(0/1)</span>
</td>
</tr>
<tr class="low">
<td>
<!-- miscellaneous -->
<a href="./miscellaneous/functions.html#getDatabaseStatus">projects/ccf-api/src/lib/routes/v1/database-status.ts</a>
</td>
<td>function</td>
<td>getDatabaseStatus</td>
<td align="right" data-sort="0">
<span class="coverage-percent">0 %</span>
<span class="coverage-count">(0/1)</span>
</td>
</tr>
<tr class="low">
<td>
<!-- miscellaneous -->
<a href="./miscellaneous/functions.html#parseString">projects/ccf-api/src/lib/routes/v1/database-status.ts</a>
</td>
<td>function</td>
<td>parseString</td>
<td align="right" data-sort="0">
<span class="coverage-percent">0 %</span>
<span class="coverage-count">(0/1)</span>
</td>
</tr>
<tr class="low">
<td>
<!-- miscellaneous -->
Expand Down Expand Up @@ -848,13 +872,13 @@
<tr class="low">
<td>
<!-- miscellaneous -->
<a href="./interfaces/CCFDatabaseInstance.html">projects/ccf-api/src/lib/utils/ccf-database-worker.ts</a>
<a href="./classes/CCFDatabaseInstance.html">projects/ccf-api/src/lib/utils/ccf-database-worker.ts</a>
</td>
<td>interface</td>
<td>class</td>
<td>CCFDatabaseInstance</td>
<td align="right" data-sort="0">
<span class="coverage-percent">0 %</span>
<span class="coverage-count">(0/3)</span>
<span class="coverage-count">(0/5)</span>
</td>
</tr>
<tr class="low">
Expand Down
Loading

0 comments on commit 8cef991

Please sign in to comment.