Skip to content

Commit 9cf6492

Browse files
devnamdev2003devnamdev2003
committed
update doc
1 parent e062b4e commit 9cf6492

12 files changed

Lines changed: 391 additions & 114 deletions

File tree

‎documentation/coverage.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -685,7 +685,7 @@
685685
<td>ConfigService</td>
686686
<td align="right" data-sort="100">
687687
<span class="coverage-percent">100 %</span>
688-
<span class="coverage-count">(11/11)</span>
688+
<span class="coverage-count">(12/12)</span>
689689
</td>
690690
</tr>
691691
<tr class="very-good">
@@ -697,7 +697,7 @@
697697
<td>GeminiApiService</td>
698698
<td align="right" data-sort="100">
699699
<span class="coverage-percent">100 %</span>
700-
<span class="coverage-count">(6/6)</span>
700+
<span class="coverage-count">(7/7)</span>
701701
</td>
702702
</tr>
703703
<tr class="very-good">
@@ -865,7 +865,7 @@
865865
<td>User</td>
866866
<td align="right" data-sort="100">
867867
<span class="coverage-percent">100 %</span>
868-
<span class="coverage-count">(13/13)</span>
868+
<span class="coverage-count">(14/14)</span>
869869
</td>
870870
</tr>
871871
<tr class="very-good">
@@ -877,7 +877,7 @@
877877
<td>SaavnService</td>
878878
<td align="right" data-sort="100">
879879
<span class="coverage-percent">100 %</span>
880-
<span class="coverage-count">(8/8)</span>
880+
<span class="coverage-count">(9/9)</span>
881881
</td>
882882
</tr>
883883
<tr class="very-good">

‎documentation/injectables/ConfigService.html‎

Lines changed: 98 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,9 @@ <h6><b>Methods</b></h6>
202202
<li>
203203
<a href="#getAppName" >getAppName</a>
204204
</li>
205+
<li>
206+
<a href="#getGeminiApiKey" >getGeminiApiKey</a>
207+
</li>
205208
<li>
206209
<a href="#getLocalTime" >getLocalTime</a>
207210
</li>
@@ -226,19 +229,50 @@ <h3 id="constructor">Constructor</h3>
226229
<tbody>
227230
<tr>
228231
<td class="col-md-4">
229-
<code>constructor()</code>
232+
<code>constructor(userService: <a href="../injectables/UserService.html" target="_self">UserService</a>)</code>
230233
</td>
231234
</tr>
232235
<tr>
233236
<td class="col-md-4">
234-
<div class="io-line">Defined in <a href="" data-line="43" class="link-to-prism">src/app/service/config/config.service.ts:43</a></div>
237+
<div class="io-line">Defined in <a href="" data-line="44" class="link-to-prism">src/app/service/config/config.service.ts:44</a></div>
235238
</td>
236239
</tr>
237240

238241
<tr>
239242
<td class="col-md-4">
240243
<div class="io-description"><p>Creates an instance of ConfigService.</p>
241244
</div>
245+
<div>
246+
<b>Parameters :</b>
247+
<table class="params">
248+
<thead>
249+
<tr>
250+
<td>Name</td>
251+
<td>Type</td>
252+
<td>Optional</td>
253+
<td>Description</td>
254+
</tr>
255+
</thead>
256+
<tbody>
257+
<tr>
258+
<td>userService</td>
259+
260+
<td>
261+
<code><a href="../injectables/UserService.html" target="_self" >UserService</a></code>
262+
</td>
263+
264+
<td>
265+
No
266+
</td>
267+
268+
<td>
269+
<p>Service for managing user preferences</p>
270+
271+
</td>
272+
</tr>
273+
</tbody>
274+
</table>
275+
</div>
242276
</td>
243277
</tr>
244278
</tbody>
@@ -270,8 +304,8 @@ <h3 id="methods">
270304

271305
<tr>
272306
<td class="col-md-4">
273-
<div class="io-line">Defined in <a href="" data-line="61"
274-
class="link-to-prism">src/app/service/config/config.service.ts:61</a></div>
307+
<div class="io-line">Defined in <a href="" data-line="63"
308+
class="link-to-prism">src/app/service/config/config.service.ts:63</a></div>
275309
</td>
276310
</tr>
277311

@@ -321,8 +355,8 @@ <h3 id="methods">
321355

322356
<tr>
323357
<td class="col-md-4">
324-
<div class="io-line">Defined in <a href="" data-line="84"
325-
class="link-to-prism">src/app/service/config/config.service.ts:84</a></div>
358+
<div class="io-line">Defined in <a href="" data-line="86"
359+
class="link-to-prism">src/app/service/config/config.service.ts:86</a></div>
326360
</td>
327361
</tr>
328362

@@ -344,6 +378,45 @@ <h3 id="methods">
344378
</tr>
345379
</tbody>
346380
</table>
381+
<table class="table table-sm table-bordered">
382+
<tbody>
383+
<tr>
384+
<td class="col-md-4">
385+
<a name="getGeminiApiKey"></a>
386+
<span class="name">
387+
<span ><b>getGeminiApiKey</b></span>
388+
<a href="#getGeminiApiKey"><span class="icon ion-ios-link"></span></a>
389+
</span>
390+
</td>
391+
</tr>
392+
<tr>
393+
<td class="col-md-4">
394+
<code>getGeminiApiKey()</code>
395+
</td>
396+
</tr>
397+
398+
399+
<tr>
400+
<td class="col-md-4">
401+
<div class="io-line">Defined in <a href="" data-line="125"
402+
class="link-to-prism">src/app/service/config/config.service.ts:125</a></div>
403+
</td>
404+
</tr>
405+
406+
407+
<tr>
408+
<td class="col-md-4">
409+
<div class="io-description"><p>Returns the Gemini Api Key</p>
410+
</div>
411+
412+
<div class="io-description">
413+
<b>Returns : </b> <code>string | null</code>
414+
415+
</div>
416+
</td>
417+
</tr>
418+
</tbody>
419+
</table>
347420
<table class="table table-sm table-bordered">
348421
<tbody>
349422
<tr>
@@ -364,8 +437,8 @@ <h3 id="methods">
364437

365438
<tr>
366439
<td class="col-md-4">
367-
<div class="io-line">Defined in <a href="" data-line="100"
368-
class="link-to-prism">src/app/service/config/config.service.ts:100</a></div>
440+
<div class="io-line">Defined in <a href="" data-line="102"
441+
class="link-to-prism">src/app/service/config/config.service.ts:102</a></div>
369442
</td>
370443
</tr>
371444

@@ -403,8 +476,8 @@ <h3 id="methods">
403476

404477
<tr>
405478
<td class="col-md-4">
406-
<div class="io-line">Defined in <a href="" data-line="93"
407-
class="link-to-prism">src/app/service/config/config.service.ts:93</a></div>
479+
<div class="io-line">Defined in <a href="" data-line="95"
480+
class="link-to-prism">src/app/service/config/config.service.ts:95</a></div>
408481
</td>
409482
</tr>
410483

@@ -458,7 +531,7 @@ <h3 id="inputs">
458531
</tr>
459532
<tr>
460533
<td class="col-md-4">
461-
<div class="io-line">Defined in <a href="" data-line="24" class="link-to-prism">src/app/service/config/config.service.ts:24</a></div>
534+
<div class="io-line">Defined in <a href="" data-line="25" class="link-to-prism">src/app/service/config/config.service.ts:25</a></div>
462535
</td>
463536
</tr>
464537

@@ -497,7 +570,7 @@ <h3 id="inputs">
497570
</tr>
498571
<tr>
499572
<td class="col-md-4">
500-
<div class="io-line">Defined in <a href="" data-line="19" class="link-to-prism">src/app/service/config/config.service.ts:19</a></div>
573+
<div class="io-line">Defined in <a href="" data-line="20" class="link-to-prism">src/app/service/config/config.service.ts:20</a></div>
501574
</td>
502575
</tr>
503576

@@ -541,7 +614,7 @@ <h3 id="inputs">
541614
</tr>
542615
<tr>
543616
<td class="col-md-4">
544-
<div class="io-line">Defined in <a href="" data-line="36" class="link-to-prism">src/app/service/config/config.service.ts:36</a></div>
617+
<div class="io-line">Defined in <a href="" data-line="37" class="link-to-prism">src/app/service/config/config.service.ts:37</a></div>
545618
</td>
546619
</tr>
547620

@@ -581,7 +654,7 @@ <h3 id="inputs">
581654
</tr>
582655
<tr>
583656
<td class="col-md-4">
584-
<div class="io-line">Defined in <a href="" data-line="43" class="link-to-prism">src/app/service/config/config.service.ts:43</a></div>
657+
<div class="io-line">Defined in <a href="" data-line="44" class="link-to-prism">src/app/service/config/config.service.ts:44</a></div>
585658
</td>
586659
</tr>
587660

@@ -621,7 +694,7 @@ <h3 id="inputs">
621694
</tr>
622695
<tr>
623696
<td class="col-md-4">
624-
<div class="io-line">Defined in <a href="" data-line="29" class="link-to-prism">src/app/service/config/config.service.ts:29</a></div>
697+
<div class="io-line">Defined in <a href="" data-line="30" class="link-to-prism">src/app/service/config/config.service.ts:30</a></div>
625698
</td>
626699
</tr>
627700

@@ -642,6 +715,7 @@ <h3 id="inputs">
642715
<div class="tab-pane fade tab-source-code" id="source">
643716
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { Injectable } from &#x27;@angular/core&#x27;;
644717
import { environment } from &#x27;../../../environments/environments&#x27;;
718+
import { UserService } from &#x27;../localStorage/user.service&#x27;;
645719

646720
/**
647721
* Service responsible for providing configuration values across the application,
@@ -686,8 +760,9 @@ <h3 id="inputs">
686760

687761
/**
688762
* Creates an instance of ConfigService.
763+
* @param userService Service for managing user preferences
689764
*/
690-
constructor() { }
765+
constructor(private userService: UserService) { }
691766

692767
/**
693768
* Returns the appropriate API base URL depending on the environment.
@@ -758,6 +833,13 @@ <h3 id="inputs">
758833
console.log(localISOString); // e.g. &quot;2025-10-11T13:35:58.942&quot;
759834
return localISOString;
760835
}
836+
837+
/**
838+
* Returns the Gemini Api Key
839+
*/
840+
getGeminiApiKey(): string | null {
841+
return this.userService.getValue&lt;string&gt;(&#x27;ai_key&#x27;);
842+
}
761843
}
762844
</code></pre>
763845
</div>

0 commit comments

Comments
 (0)