grassrootseconomics/cic-staff-client
8
0
Fork 0
Code Issues 26 Pull Requests Projects Releases Wiki Activity

Finalize documentation on models.

Browse Source
This commit is contained in:
Spencer Ofwiti
2021-05-12 10:52:28 +03:00
parent ca985d7af7
commit 948a735baf
49 changed files with 1308 additions and 473 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
docs/compodoc/classes/Settings.html
View File

@@ -122,12 +122,14 @@
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="9" class="link-to-prism">src/app/_models/settings.ts:9</a></div>
<div class="io-line">Defined in <a href="" data-line="13" class="link-to-prism">src/app/_models/settings.ts:13</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Initialize the settings.</p>
</div>
<div>
<b>Parameters :</b>
<table class="params">
@@ -136,6 +138,7 @@
<td>Name</td>
<td>Type</td>
<td>Optional</td>
<td>Description</td>
</tr>
</thead>
<tbody>
@@ -150,6 +153,12 @@
No
</td>
<td>
<code><ul>
<li>A resource for searching through blocks on the blockchain network.</li>
</ul>
</code>
</td>
</tr>
</tbody>
</table>
@@ -185,10 +194,16 @@
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="8" class="link-to-prism">src/app/_models/settings.ts:8</a></div>
<div class="io-line">Defined in <a href="" data-line="11" class="link-to-prism">src/app/_models/settings.ts:11</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>CIC Registry instance </p>
</div>
</td>
</tr>
</tbody>
</table>
@@ -212,10 +227,16 @@
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="7" class="link-to-prism">src/app/_models/settings.ts:7</a></div>
<div class="io-line">Defined in <a href="" data-line="9" class="link-to-prism">src/app/_models/settings.ts:9</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>A resource for searching through blocks on the blockchain network. </p>
</div>
</td>
</tr>
</tbody>
</table>
@@ -239,10 +260,16 @@
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="9" class="link-to-prism">src/app/_models/settings.ts:9</a></div>
<div class="io-line">Defined in <a href="" data-line="13" class="link-to-prism">src/app/_models/settings.ts:13</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Transaction Helper instance </p>
</div>
</td>
</tr>
</tbody>
</table>
@@ -274,10 +301,16 @@
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="3" class="link-to-prism">src/app/_models/settings.ts:3</a></div>
<div class="io-line">Defined in <a href="" data-line="4" class="link-to-prism">src/app/_models/settings.ts:4</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Web3 Object </p>
</div>
</td>
</tr>
</tbody>
</table>
@@ -294,14 +327,23 @@
<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">class Settings {
/** Web3 Object */
w3: W3 &#x3D; {
engine: undefined,
provider: undefined,
};
/** A resource for searching through blocks on the blockchain network. */
scanFilter: any;
/** CIC Registry instance */
registry: any;
/** Transaction Helper instance */
txHelper: any;
/**
* Initialize the settings.
*
* @param scanFilter - A resource for searching through blocks on the blockchain network.
*/
constructor(scanFilter: any) {
this.scanFilter &#x3D; scanFilter;
}
@@ -309,7 +351,9 @@
/** Web3 object interface */
interface W3 {
/** An active web3 instance connected to the blockchain network. */
engine: any;
/** The connection socket to the blockchain network. */
provider: any;
}