Documentation update.

This commit is contained in:
Spencer Ofwiti
2021-09-02 23:48:41 +00:00
parent 0567b9b729
commit 33a446cfa4
133 changed files with 13908 additions and 9806 deletions

View File

@@ -8,7 +8,8 @@
<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/style.css">
<link rel="stylesheet" href="../styles/dark.css" media="(prefers-color-scheme: dark)">
</head>
<body>
@@ -38,7 +39,7 @@
<ol class="breadcrumb">
<li>Injectables</li>
<li>LocationService</li>
<li >LocationService</li>
</ol>
<ul class="nav nav-tabs" role="tablist">
@@ -62,6 +63,7 @@
<section>
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
@@ -75,24 +77,24 @@
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#areaNames">areaNames</a>
<a href="#areaNames" >areaNames</a>
</li>
<li>
<span class="modifier">Private</span>
<a href="#areaNamesList">areaNamesList</a>
<a href="#areaNamesList" >areaNamesList</a>
</li>
<li>
<a href="#areaNamesSubject">areaNamesSubject</a>
<a href="#areaNamesSubject" >areaNamesSubject</a>
</li>
<li>
<a href="#areaTypes">areaTypes</a>
<a href="#areaTypes" >areaTypes</a>
</li>
<li>
<span class="modifier">Private</span>
<a href="#areaTypesList">areaTypesList</a>
<a href="#areaTypesList" >areaTypesList</a>
</li>
<li>
<a href="#areaTypesSubject">areaTypesSubject</a>
<a href="#areaTypesSubject" >areaTypesSubject</a>
</li>
</ul>
</td>
@@ -107,16 +109,16 @@
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#getAreaNameByLocation">getAreaNameByLocation</a>
<a href="#getAreaNameByLocation" >getAreaNameByLocation</a>
</li>
<li>
<a href="#getAreaNames">getAreaNames</a>
<a href="#getAreaNames" >getAreaNames</a>
</li>
<li>
<a href="#getAreaTypeByArea">getAreaTypeByArea</a>
<a href="#getAreaTypeByArea" >getAreaTypeByArea</a>
</li>
<li>
<a href="#getAreaTypes">getAreaTypes</a>
<a href="#getAreaTypes" >getAreaTypes</a>
</li>
</ul>
</td>
@@ -190,9 +192,7 @@
<td class="col-md-4">
<a name="getAreaNameByLocation"></a>
<span class="name">
<b>
getAreaNameByLocation
</b>
<span ><b>getAreaNameByLocation</b></span>
<a href="#getAreaNameByLocation"><span class="icon ion-ios-link"></span></a>
</span>
</td>
@@ -272,9 +272,7 @@
<td class="col-md-4">
<a name="getAreaNames"></a>
<span class="name">
<b>
getAreaNames
</b>
<span ><b>getAreaNames</b></span>
<a href="#getAreaNames"><span class="icon ion-ios-link"></span></a>
</span>
</td>
@@ -311,9 +309,7 @@
<td class="col-md-4">
<a name="getAreaTypeByArea"></a>
<span class="name">
<b>
getAreaTypeByArea
</b>
<span ><b>getAreaTypeByArea</b></span>
<a href="#getAreaTypeByArea"><span class="icon ion-ios-link"></span></a>
</span>
</td>
@@ -327,8 +323,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="47"
class="link-to-prism">src/app/_services/location.service.ts:47</a></div>
<div class="io-line">Defined in <a href="" data-line="48"
class="link-to-prism">src/app/_services/location.service.ts:48</a></div>
</td>
</tr>
@@ -393,9 +389,7 @@
<td class="col-md-4">
<a name="getAreaTypes"></a>
<span class="name">
<b>
getAreaTypes
</b>
<span ><b>getAreaTypes</b></span>
<a href="#getAreaTypes"><span class="icon ion-ios-link"></span></a>
</span>
</td>
@@ -409,8 +403,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="40"
class="link-to-prism">src/app/_services/location.service.ts:40</a></div>
<div class="io-line">Defined in <a href="" data-line="41"
class="link-to-prism">src/app/_services/location.service.ts:41</a></div>
</td>
</tr>
@@ -429,203 +423,197 @@
</section>
<section>
<h3 id="inputs">
Properties
</h3>
<table class="table table-sm table-bordered">
<tbody>
<h3 id="inputs">
Properties
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="areaNames"></a>
<span class="name">
<span ><b>areaNames</b></span>
<a href="#areaNames"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<a name="areaNames"></a>
<span class="name">
<b>
areaNames</b>
<a href="#areaNames"><span class="icon ion-ios-link"></span></a>
</span>
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object" target="_blank" >object</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>{}</code>
</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/object" target="_blank" >object</a></code>
<div class="io-line">Defined in <a href="" data-line="11" class="link-to-prism">src/app/_services/location.service.ts:11</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>{}</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="11" class="link-to-prism">src/app/_services/location.service.ts:11</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="areaNamesList"></a>
<span class="name">
<span class="modifier">Private</span>
<span ><b>areaNamesList</b></span>
<a href="#areaNamesList"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<a name="areaNamesList"></a>
<span class="name">
<b>
<span class="modifier">Private</span>
areaNamesList</b>
<a href="#areaNamesList"><span class="icon ion-ios-link"></span></a>
</span>
<i>Type : </i> <code>BehaviorSubject&lt;object&gt;</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>new BehaviorSubject&lt;object&gt;(this.areaNames)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>BehaviorSubject&lt;object&gt;</code>
<div class="io-line">Defined in <a href="" data-line="12" class="link-to-prism">src/app/_services/location.service.ts:12</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>new BehaviorSubject&lt;object&gt;(this.areaNames)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="12" class="link-to-prism">src/app/_services/location.service.ts:12</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="areaNamesSubject"></a>
<span class="name">
<span ><b>areaNamesSubject</b></span>
<a href="#areaNamesSubject"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<a name="areaNamesSubject"></a>
<span class="name">
<b>
areaNamesSubject</b>
<a href="#areaNamesSubject"><span class="icon ion-ios-link"></span></a>
</span>
<i>Type : </i> <code>Observable&lt;object&gt;</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>this.areaNamesList.asObservable()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>Observable&lt;object&gt;</code>
<div class="io-line">Defined in <a href="" data-line="13" class="link-to-prism">src/app/_services/location.service.ts:13</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>this.areaNamesList.asObservable()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="13" class="link-to-prism">src/app/_services/location.service.ts:13</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="areaTypes"></a>
<span class="name">
<span ><b>areaTypes</b></span>
<a href="#areaTypes"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<a name="areaTypes"></a>
<span class="name">
<b>
areaTypes</b>
<a href="#areaTypes"><span class="icon ion-ios-link"></span></a>
</span>
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object" target="_blank" >object</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>{}</code>
</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/object" target="_blank" >object</a></code>
<div class="io-line">Defined in <a href="" data-line="15" class="link-to-prism">src/app/_services/location.service.ts:15</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>{}</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="15" class="link-to-prism">src/app/_services/location.service.ts:15</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="areaTypesList"></a>
<span class="name">
<span class="modifier">Private</span>
<span ><b>areaTypesList</b></span>
<a href="#areaTypesList"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<a name="areaTypesList"></a>
<span class="name">
<b>
<span class="modifier">Private</span>
areaTypesList</b>
<a href="#areaTypesList"><span class="icon ion-ios-link"></span></a>
</span>
<i>Type : </i> <code>BehaviorSubject&lt;object&gt;</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>new BehaviorSubject&lt;object&gt;(this.areaTypes)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>BehaviorSubject&lt;object&gt;</code>
<div class="io-line">Defined in <a href="" data-line="16" class="link-to-prism">src/app/_services/location.service.ts:16</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>new BehaviorSubject&lt;object&gt;(this.areaTypes)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="16" class="link-to-prism">src/app/_services/location.service.ts:16</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="areaTypesSubject"></a>
<span class="name">
<span ><b>areaTypesSubject</b></span>
<a href="#areaTypesSubject"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<a name="areaTypesSubject"></a>
<span class="name">
<b>
areaTypesSubject</b>
<a href="#areaTypesSubject"><span class="icon ion-ios-link"></span></a>
</span>
<i>Type : </i> <code>Observable&lt;object&gt;</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>this.areaTypesList.asObservable()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>Observable&lt;object&gt;</code>
<div class="io-line">Defined in <a href="" data-line="17" class="link-to-prism">src/app/_services/location.service.ts:17</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>this.areaTypesList.asObservable()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="17" class="link-to-prism">src/app/_services/location.service.ts:17</a></div>
</td>
</tr>
</tbody>
</table>
</tbody>
</table>
</section>
</div>
@@ -669,6 +657,7 @@ export class LocationService {
return queriedAreaName;
}
}
return &#x27;other&#x27;;
}
getAreaTypes(): void {
@@ -688,6 +677,7 @@ export class LocationService {
return queriedAreaType;
}
}
return &#x27;other&#x27;;
}
}
</code></pre>
@@ -729,9 +719,9 @@ export class LocationService {
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
<!-- Required to polyfill modern browsers as code is ES5 for IE... -->
<script src="../js/libs/custom-elements-es5-adapter.js" charset="utf-8" defer></script>
<script src="../js/menu-wc.js" defer></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>