Add documentation to the helpers module.
This commit is contained in:
Spencer Ofwiti
@@ -90,16 +90,32 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/app/_helpers/array-sum.ts:1</li>
|
||||
<li>Defined in src/app/_helpers/array-sum.ts:13</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Returns the sum of all values in an array.</p>
|
||||
</div>
|
||||
<dl class="tsd-comment-tags">
|
||||
<dt>example</dt>
|
||||
<dd><p>Prints 6 for the array [1, 2, 3]:</p>
|
||||
<pre><code class="language-typescript"><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #795E26">arraySum</span><span style="color: #000000">([</span><span style="color: #098658">1</span><span style="color: #000000">, </span><span style="color: #098658">2</span><span style="color: #000000">, </span><span style="color: #098658">3</span><span style="color: #000000">]));</span>
|
||||
</code></pre>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>arr: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>An array of numbers.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
||||
<p>The sum of all values in the array.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
@@ -90,16 +90,32 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/app/_helpers/clipboard-copy.ts:1</li>
|
||||
<li>Defined in src/app/_helpers/clipboard-copy.ts:13</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Copies set text to clipboard.</p>
|
||||
</div>
|
||||
<dl class="tsd-comment-tags">
|
||||
<dt>example</dt>
|
||||
<dd><p>copies 'Hello World!' to the clipboard and prints "true":</p>
|
||||
<pre><code class="language-typescript"><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #795E26">copyToClipboard</span><span style="color: #000000">(</span><span style="color: #A31515">'Hello World!'</span><span style="color: #000000">));</span>
|
||||
</code></pre>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>text: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>The text to be copied to the clipboard.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
||||
<p>true - If the copy operation is successful.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
@@ -90,19 +90,34 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/app/_helpers/export-csv.ts:1</li>
|
||||
<li>Defined in src/app/_helpers/export-csv.ts:9</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Exports data to a CSV format and provides a download file.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>arrayData: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>An array of data to be converted to CSV format.</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>filename: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>The name of the file to be downloaded.</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>delimiter: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ','</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>The delimiter to be used when converting to CSV format.
|
||||
Defaults to commas.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
|
||||
@@ -90,9 +90,14 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/app/_helpers/http-getter.ts:1</li>
|
||||
<li>Defined in src/app/_helpers/http-getter.ts:2</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Provides an avenue of fetching resources via HTTP calls.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -92,9 +92,18 @@
|
||||
<div class="tsd-signature tsd-kind-icon">Mock<wbr>Backend<wbr>Provider<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>multi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>provide<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">InjectionToken</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">HttpInterceptor</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>useClass<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><a href="../classes/app__helpers_mock_backend.mockbackendinterceptor.html" class="tsd-signature-type" data-tsd-kind="Class">MockBackendInterceptor</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/app/_helpers/mock-backend.ts:378</li>
|
||||
<li>Defined in src/app/_helpers/mock-backend.ts:412</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Exports the MockBackendInterceptor as an Angular provider.</p>
|
||||
</div>
|
||||
<dl class="tsd-comment-tags">
|
||||
<dt>exports</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
|
||||
@@ -90,16 +90,25 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/app/_helpers/read-csv.ts:6</li>
|
||||
<li>Defined in src/app/_helpers/read-csv.ts:13</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Reads a csv file and converts it to an array.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>input: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>The file to be read.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span></h4>
|
||||
<p>An array of the read data.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
@@ -91,13 +91,21 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/app/_helpers/schema-validation.ts:3</li>
|
||||
<li>Defined in src/app/_helpers/schema-validation.ts:9</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Validates a person object against the defined Person schema.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>person: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>A person object to be validated.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
@@ -114,13 +122,21 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/app/_helpers/schema-validation.ts:11</li>
|
||||
<li>Defined in src/app/_helpers/schema-validation.ts:22</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Validates a vcard object against the defined Vcard schema.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>vcard: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>A vcard object to be validated.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
|
||||
Reference in New Issue
Block a user