Add documentation to eth modules.

This commit is contained in:
Spencer Ofwiti
2021-05-11 12:05:04 +03:00
parent 8db1343bc5
commit 2bc6dcf033
28 changed files with 1174 additions and 412 deletions

View File

@@ -193,8 +193,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="30"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:30</a></div>
<div class="io-line">Defined in <a href="" data-line="33"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:33</a></div>
</td>
</tr>
@@ -232,8 +232,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="14"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:14</a></div>
<div class="io-line">Defined in <a href="" data-line="17"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:17</a></div>
</td>
</tr>
@@ -271,8 +271,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="19"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:19</a></div>
<div class="io-line">Defined in <a href="" data-line="22"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:22</a></div>
</td>
</tr>
@@ -310,8 +310,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="20"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:20</a></div>
<div class="io-line">Defined in <a href="" data-line="23"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:23</a></div>
</td>
</tr>
@@ -380,8 +380,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="22"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:22</a></div>
<div class="io-line">Defined in <a href="" data-line="25"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:25</a></div>
</td>
</tr>
@@ -450,8 +450,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="16"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:16</a></div>
<div class="io-line">Defined in <a href="" data-line="19"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:19</a></div>
</td>
</tr>
@@ -489,8 +489,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="24"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:24</a></div>
<div class="io-line">Defined in <a href="" data-line="27"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:27</a></div>
</td>
</tr>
@@ -559,8 +559,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="21"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:21</a></div>
<div class="io-line">Defined in <a href="" data-line="24"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:24</a></div>
</td>
</tr>
@@ -598,8 +598,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="15"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:15</a></div>
<div class="io-line">Defined in <a href="" data-line="18"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:18</a></div>
</td>
</tr>
@@ -637,8 +637,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="23"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:23</a></div>
<div class="io-line">Defined in <a href="" data-line="26"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:26</a></div>
</td>
</tr>
@@ -707,8 +707,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="25"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:25</a></div>
<div class="io-line">Defined in <a href="" data-line="28"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:28</a></div>
</td>
</tr>
@@ -777,8 +777,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="11"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:11</a></div>
<div class="io-line">Defined in <a href="" data-line="14"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:14</a></div>
</td>
</tr>
@@ -816,8 +816,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="26"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:26</a></div>
<div class="io-line">Defined in <a href="" data-line="29"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:29</a></div>
</td>
</tr>
@@ -886,8 +886,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="13"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:13</a></div>
<div class="io-line">Defined in <a href="" data-line="16"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:16</a></div>
</td>
</tr>
@@ -925,8 +925,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="12"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:12</a></div>
<div class="io-line">Defined in <a href="" data-line="15"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:15</a></div>
</td>
</tr>
@@ -964,8 +964,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="8"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:8</a></div>
<div class="io-line">Defined in <a href="" data-line="11"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:11</a></div>
</td>
</tr>
@@ -1046,8 +1046,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="10"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:10</a></div>
<div class="io-line">Defined in <a href="" data-line="13"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:13</a></div>
</td>
</tr>
@@ -1116,8 +1116,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="9"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:9</a></div>
<div class="io-line">Defined in <a href="" data-line="12"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:12</a></div>
</td>
</tr>
@@ -1186,8 +1186,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="18"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:18</a></div>
<div class="io-line">Defined in <a href="" data-line="21"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:21</a></div>
</td>
</tr>
@@ -1256,8 +1256,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="17"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:17</a></div>
<div class="io-line">Defined in <a href="" data-line="20"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:20</a></div>
</td>
</tr>
@@ -1326,8 +1326,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="7"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:7</a></div>
<div class="io-line">Defined in <a href="" data-line="10"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:10</a></div>
</td>
</tr>
@@ -1365,8 +1365,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="27"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:27</a></div>
<div class="io-line">Defined in <a href="" data-line="30"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:30</a></div>
</td>
</tr>
@@ -1435,8 +1435,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="29"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:29</a></div>
<div class="io-line">Defined in <a href="" data-line="32"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:32</a></div>
</td>
</tr>
@@ -1505,8 +1505,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="28"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:28</a></div>
<div class="io-line">Defined in <a href="" data-line="31"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:31</a></div>
</td>
</tr>
@@ -1575,8 +1575,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="31"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:31</a></div>
<div class="io-line">Defined in <a href="" data-line="34"
class="link-to-prism">src/app/_pgp/pgp-key-store.ts:34</a></div>
</td>
</tr>
@@ -1634,6 +1634,9 @@
import * as openpgp from &#x27;openpgp&#x27;;
const keyring &#x3D; new openpgp.Keyring();
/**
* @extends
*/
interface MutableKeyStore extends KeyStore {
loadKeyring(): void;
importKeyPair(publicKey: any, privateKey: any): Promise&lt;void&gt;;
@@ -1662,6 +1665,9 @@ interface MutableKeyStore extends KeyStore {
sign(plainText: string): Promise&lt;any&gt;;
}
/**
* @implements
*/
class MutablePgpKeyStore implements MutableKeyStore{
async loadKeyring(): Promise&lt;void&gt; {