grassrootseconomics/cic-staff-client
5
0
Fork 0
Code Issues 26 Pull Requests Projects Releases Wiki Activity
master
cic-staff-client/docs/compodoc/classes/Settings.html

421 lines
14 KiB
HTML
Raw Permalink Normal View History

Add docs.
2021-05-10 20:56:20 +02:00
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>CICADA</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">
Documentation update.
2021-09-03 01:48:41 +02:00
<link rel="stylesheet" href="../styles/style.css">
<link rel="stylesheet" href="../styles/dark.css" media="(prefers-color-scheme: dark)">
Add docs.
2021-05-10 20:56:20 +02:00
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top visible-xs">
<a href="../" class="navbar-brand">CICADA</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>
Documentation update.
2021-09-03 01:48:41 +02:00
<li >Settings</li>
Add docs.
2021-05-10 20:56:20 +02:00
</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>src/app/_models/settings.ts</code>
</p>
Documentation update.
2021-09-03 01:48:41 +02:00
Add documentation to models.
2021-05-12 08:40:21 +02:00
<p class="comment">
<h3>Description</h3>
</p>
<p class="comment">
Documentation update.
2021-09-03 01:48:41 +02:00
<p>Settings class</p>
Add documentation to models.
2021-05-12 08:40:21 +02:00
</p>
Add docs.
2021-05-10 20:56:20 +02:00
<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>
Documentation update.
2021-09-03 01:48:41 +02:00
<a href="#registry" >registry</a>
Add docs.
2021-05-10 20:56:20 +02:00
</li>
<li>
Documentation update.
2021-09-03 01:48:41 +02:00
<a href="#scanFilter" >scanFilter</a>
Add docs.
2021-05-10 20:56:20 +02:00
</li>
<li>
Documentation update.
2021-09-03 01:48:41 +02:00
<a href="#txHelper" >txHelper</a>
Add docs.
2021-05-10 20:56:20 +02:00
</li>
<li>
Documentation update.
2021-09-03 01:48:41 +02:00
<a href="#w3" >w3</a>
Add docs.
2021-05-10 20:56:20 +02:00
</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(scanFilter: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
<div class="io-line">Defined in <a href="" data-line="13" class="link-to-prism">src/app/_models/settings.ts:13</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
<div class="io-description"><p>Initialize the settings.</p>
</div>
Add docs.
2021-05-10 20:56:20 +02:00
<div>
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
<td>Description</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
</thead>
<tbody>
<tr>
<td>scanFilter</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
<td>
<code><ul>
<li>A resource for searching through blocks on the blockchain network.</li>
</ul>
</code>
</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section>
Documentation update.
2021-09-03 01:48:41 +02:00
<h3 id="inputs">
Properties
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="registry"></a>
<span class="name">
<span ><b>registry</b></span>
<a href="#registry"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
<tr>
<td class="col-md-4">
Documentation update.
2021-09-03 01:48:41 +02:00
<i>Type : </i> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Documentation update.
2021-09-03 01:48:41 +02:00
<div class="io-line">Defined in <a href="" data-line="4" class="link-to-prism">src/app/_models/settings.ts:4</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
Documentation update.
2021-09-03 01:48:41 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>CIC Registry instance</p>
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
</div>
Documentation update.
2021-09-03 01:48:41 +02:00
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
Documentation update.
2021-09-03 01:48:41 +02:00
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="scanFilter"></a>
<span class="name">
<span ><b>scanFilter</b></span>
<a href="#scanFilter"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
<tr>
<td class="col-md-4">
Documentation update.
2021-09-03 01:48:41 +02:00
<i>Type : </i> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Documentation update.
2021-09-03 01:48:41 +02:00
<div class="io-line">Defined in <a href="" data-line="6" class="link-to-prism">src/app/_models/settings.ts:6</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
Documentation update.
2021-09-03 01:48:41 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>A resource for searching through blocks on the blockchain network.</p>
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
</div>
Documentation update.
2021-09-03 01:48:41 +02:00
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
Documentation update.
2021-09-03 01:48:41 +02:00
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="txHelper"></a>
<span class="name">
<span ><b>txHelper</b></span>
<a href="#txHelper"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
<tr>
<td class="col-md-4">
Documentation update.
2021-09-03 01:48:41 +02:00
<i>Type : </i> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Documentation update.
2021-09-03 01:48:41 +02:00
<div class="io-line">Defined in <a href="" data-line="8" class="link-to-prism">src/app/_models/settings.ts:8</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
Documentation update.
2021-09-03 01:48:41 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>Transaction Helper instance</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="w3"></a>
<span class="name">
<span ><b>w3</b></span>
<a href="#w3"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
<tr>
<td class="col-md-4">
Documentation update.
2021-09-03 01:48:41 +02:00
<i>Type : </i> <code><a href="../interfaces/W3.html" target="_self" >W3</a></code>
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
<tr>
<td class="col-md-4">
Documentation update.
2021-09-03 01:48:41 +02:00
<i>Default value : </i><code>{
engine: undefined,
provider: undefined,
}</code>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Documentation update.
2021-09-03 01:48:41 +02:00
<div class="io-line">Defined in <a href="" data-line="10" class="link-to-prism">src/app/_models/settings.ts:10</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
Documentation update.
2021-09-03 01:48:41 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>Web3 Object</p>
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
</div>
Documentation update.
2021-09-03 01:48:41 +02:00
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
Documentation update.
2021-09-03 01:48:41 +02:00
</tbody>
</table>
Add docs.
2021-05-10 20:56:20 +02:00
</section>
</div>
<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">class Settings {
Refactor order of item to follow alphabetical order.
2021-05-13 09:13:51 +02:00
/** CIC Registry instance */
registry: any;
/** A resource for searching through blocks on the blockchain network. */
scanFilter: any;
/** Transaction Helper instance */
txHelper: any;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Web3 Object */
Add docs.
2021-05-10 20:56:20 +02:00
w3: W3 &#x3D; {
engine: undefined,
provider: undefined,
};
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/**
* Initialize the settings.
*
* @param scanFilter - A resource for searching through blocks on the blockchain network.
*/
Add docs.
2021-05-10 20:56:20 +02:00
constructor(scanFilter: any) {
this.scanFilter &#x3D; scanFilter;
}
}
Add documentation to models.
2021-05-12 08:40:21 +02:00
/** Web3 object interface */
interface W3 {
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** An active web3 instance connected to the blockchain network. */
Add docs.
2021-05-10 20:56:20 +02:00
engine: any;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** The connection socket to the blockchain network. */
Add docs.
2021-05-10 20:56:20 +02:00
provider: any;
}
Add documentation to models.
2021-05-12 08:40:21 +02:00
/** @exports */
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
export { Settings, W3 };
Add docs.
2021-05-10 20:56:20 +02:00
</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 = 'Settings.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
Documentation update.
2021-09-03 01:48:41 +02:00
<script type="module" src="../js/menu-wc.js" defer></script>
<script nomodule src="../js/menu-wc_es5.js" defer></script>
Add docs.
2021-05-10 20:56:20 +02:00
<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>
Reference in New Issue Copy Permalink