Add documentation to models.

This commit is contained in:
Spencer Ofwiti
2021-05-12 09:40:21 +03:00
parent 508c1b5c94
commit ca985d7af7
62 changed files with 3096 additions and 737 deletions

View File

@@ -64,6 +64,13 @@
<code>src/app/_models/account.ts</code>
</p>
<p class="comment">
<h3>Description</h3>
</p>
<p class="comment">
<p>Meta object interface </p>
</p>
<section>
@@ -243,6 +250,7 @@
};
}
/** Meta signature interface */
interface Signature {
algo: string;
data: string;
@@ -250,17 +258,20 @@ interface Signature {
engine: string;
}
/** Meta object interface */
interface Meta {
data: AccountDetails;
id: string;
signature: Signature;
}
/** Meta response interface */
interface MetaResponse {
id: string;
m: Meta;
}
/** Default account data object */
const defaultAccount: AccountDetails &#x3D; {
date_registered: Date.now(),
gender: &#x27;other&#x27;,
@@ -308,7 +319,8 @@ const defaultAccount: AccountDetails &#x3D; {
},
};
export { AccountDetails, Signature, Meta, MetaResponse, defaultAccount };
/** @exports */
export { AccountDetails, Meta, MetaResponse, Signature, defaultAccount };
</code></pre>
</div>
</div>