Updated the API reference

cedx · Oct 13, 2022 · 966eabf · 966eabf
1 parent 18f4e65
commit 966eabf
Show file tree

Hide file tree

Showing 20 changed files with 193 additions and 65 deletions.
diff --git a/docs/assets/main.js b/docs/assets/main.js
diff --git a/docs/assets/style.css b/docs/assets/style.css
@@ -942,7 +942,7 @@ a.tsd-index-link {
     margin: 2rem 0;
 }
 .tsd-panel-group.tsd-index-group details {
-    margin: 4rem 0;
+    margin: 2rem 0;
 }
 
 #tsd-search {
@@ -1124,6 +1124,7 @@ ul.tsd-type-parameter-list h5 {
     display: flex;
     justify-content: space-between;
     height: 2.5rem;
+    margin: 0 auto;
 }
 .tsd-page-toolbar .table-cell {
     position: relative;

diff --git a/docs/assets/widgets.png b/docs/assets/widgets.png
diff --git a/docs/assets/widgets@2x.png b/docs/assets/widgets@2x.png
diff --git a/docs/classes/BranchCoverage.html b/docs/classes/BranchCoverage.html
@@ -19,7 +19,9 @@ <h1>Class BranchCoverage</h1></div>
 <section class="tsd-panel tsd-hierarchy">
 <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
-<li><span class="target">BranchCoverage</span></li></ul></section>
+<li><span class="target">BranchCoverage</span></li></ul></section><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/cedx/lcov.js/blob/main/src/branch.js#L79">branch.js:79</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -56,7 +58,9 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../interfaces/BranchCoverageOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BranchCoverageOptions</a><span class="tsd-signature-symbol"> = {}</span></h5>
 <div class="tsd-comment tsd-typography"><p>An object providing values to initialize this instance.</p>
 </div></li></ul></div>
-<h4 class="tsd-returns-title">Returns <a href="BranchCoverage.html" class="tsd-signature-type" data-tsd-kind="Class">BranchCoverage</a></h4></li></ul></section></section>
+<h4 class="tsd-returns-title">Returns <a href="BranchCoverage.html" class="tsd-signature-type" data-tsd-kind="Class">BranchCoverage</a></h4><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/cedx/lcov.js/blob/main/src/branch.js#L103">branch.js:103</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="data" class="tsd-anchor"></a>
@@ -91,7 +95,9 @@ <h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-
 
 <h3>Returns</h3><p>The string representation of this object.</p>
 </div>
-<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section>
+<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/cedx/lcov.js/blob/main/src/branch.js#L126">branch.js:126</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="fromJson" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Json</span><a href="#fromJson" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -108,7 +114,9 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>json: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5>
 <div class="tsd-comment tsd-typography"><p>A JSON object representing a branch coverage.</p>
 </div></li></ul></div>
-<h4 class="tsd-returns-title">Returns <a href="BranchCoverage.html" class="tsd-signature-type" data-tsd-kind="Class">BranchCoverage</a></h4></li></ul></section></section></div>
+<h4 class="tsd-returns-title">Returns <a href="BranchCoverage.html" class="tsd-signature-type" data-tsd-kind="Class">BranchCoverage</a></h4><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/cedx/lcov.js/blob/main/src/branch.js#L114">branch.js:114</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

diff --git a/docs/classes/BranchData.html b/docs/classes/BranchData.html
@@ -19,7 +19,9 @@ <h1>Class BranchData</h1></div>
 <section class="tsd-panel tsd-hierarchy">
 <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
-<li><span class="target">BranchData</span></li></ul></section>
+<li><span class="target">BranchData</span></li></ul></section><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/cedx/lcov.js/blob/main/src/branch.js#L6">branch.js:6</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -57,7 +59,9 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../interfaces/BranchDataOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BranchDataOptions</a><span class="tsd-signature-symbol"> = {}</span></h5>
 <div class="tsd-comment tsd-typography"><p>An object providing values to initialize this instance.</p>
 </div></li></ul></div>
-<h4 class="tsd-returns-title">Returns <a href="BranchData.html" class="tsd-signature-type" data-tsd-kind="Class">BranchData</a></h4></li></ul></section></section>
+<h4 class="tsd-returns-title">Returns <a href="BranchData.html" class="tsd-signature-type" data-tsd-kind="Class">BranchData</a></h4><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/cedx/lcov.js/blob/main/src/branch.js#L36">branch.js:36</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="blockNumber" class="tsd-anchor"></a>
@@ -99,7 +103,9 @@ <h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-
 
 <h3>Returns</h3><p>The string representation of this object.</p>
 </div>
-<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section>
+<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/cedx/lcov.js/blob/main/src/branch.js#L61">branch.js:61</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="fromJson" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Json</span><a href="#fromJson" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -116,7 +122,9 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>json: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5>
 <div class="tsd-comment tsd-typography"><p>A JSON object representing a branch data.</p>
 </div></li></ul></div>
-<h4 class="tsd-returns-title">Returns <a href="BranchData.html" class="tsd-signature-type" data-tsd-kind="Class">BranchData</a></h4></li></ul></section></section></div>
+<h4 class="tsd-returns-title">Returns <a href="BranchData.html" class="tsd-signature-type" data-tsd-kind="Class">BranchData</a></h4><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/cedx/lcov.js/blob/main/src/branch.js#L48">branch.js:48</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

diff --git a/docs/classes/FunctionCoverage.html b/docs/classes/FunctionCoverage.html
@@ -19,7 +19,9 @@ <h1>Class FunctionCoverage</h1></div>
 <section class="tsd-panel tsd-hierarchy">
 <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
-<li><span class="target">FunctionCoverage</span></li></ul></section>
+<li><span class="target">FunctionCoverage</span></li></ul></section><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/cedx/lcov.js/blob/main/src/function.js#L72">function.js:72</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -56,7 +58,9 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../interfaces/FunctionCoverageOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">FunctionCoverageOptions</a><span class="tsd-signature-symbol"> = {}</span></h5>
 <div class="tsd-comment tsd-typography"><p>An object providing values to initialize this instance.</p>
 </div></li></ul></div>
-<h4 class="tsd-returns-title">Returns <a href="FunctionCoverage.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCoverage</a></h4></li></ul></section></section>
+<h4 class="tsd-returns-title">Returns <a href="FunctionCoverage.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCoverage</a></h4><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/cedx/lcov.js/blob/main/src/function.js#L96">function.js:96</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="data" class="tsd-anchor"></a>
@@ -91,7 +95,9 @@ <h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-
 
 <h3>Returns</h3><p>The string representation of this object.</p>
 </div>
-<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section>
+<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/cedx/lcov.js/blob/main/src/function.js#L119">function.js:119</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="fromJson" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Json</span><a href="#fromJson" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -108,7 +114,9 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>json: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5>
 <div class="tsd-comment tsd-typography"><p>A JSON object representing a function coverage.</p>
 </div></li></ul></div>
-<h4 class="tsd-returns-title">Returns <a href="FunctionCoverage.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCoverage</a></h4></li></ul></section></section></div>
+<h4 class="tsd-returns-title">Returns <a href="FunctionCoverage.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionCoverage</a></h4><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/cedx/lcov.js/blob/main/src/function.js#L107">function.js:107</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

diff --git a/docs/classes/FunctionData.html b/docs/classes/FunctionData.html
@@ -19,7 +19,9 @@ <h1>Class FunctionData</h1></div>
 <section class="tsd-panel tsd-hierarchy">
 <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
-<li><span class="target">FunctionData</span></li></ul></section>
+<li><span class="target">FunctionData</span></li></ul></section><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/cedx/lcov.js/blob/main/src/function.js#L6">function.js:6</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -56,7 +58,9 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../interfaces/FunctionDataOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">FunctionDataOptions</a><span class="tsd-signature-symbol"> = {}</span></h5>
 <div class="tsd-comment tsd-typography"><p>An object providing values to initialize this instance.</p>
 </div></li></ul></div>
-<h4 class="tsd-returns-title">Returns <a href="FunctionData.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionData</a></h4></li></ul></section></section>
+<h4 class="tsd-returns-title">Returns <a href="FunctionData.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionData</a></h4><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/cedx/lcov.js/blob/main/src/function.js#L30">function.js:30</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="executionCount" class="tsd-anchor"></a>
@@ -98,7 +102,9 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> asDefinition: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
 <div class="tsd-comment tsd-typography"><p>Whether to return the function definition instead of its data.</p>
 </div></li></ul></div>
-<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section>
+<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/cedx/lcov.js/blob/main/src/function.js#L54">function.js:54</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="fromJson" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Json</span><a href="#fromJson" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -115,7 +121,9 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>json: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5>
 <div class="tsd-comment tsd-typography"><p>A JSON object representing a function data.</p>
 </div></li></ul></div>
-<h4 class="tsd-returns-title">Returns <a href="FunctionData.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionData</a></h4></li></ul></section></section></div>
+<h4 class="tsd-returns-title">Returns <a href="FunctionData.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionData</a></h4><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/cedx/lcov.js/blob/main/src/function.js#L41">function.js:41</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">