Skip to content
This repository has been archived by the owner on Jan 30, 2022. It is now read-only.

Commit

Permalink
✨💡 Commits, PunchCard, Utils
Browse files Browse the repository at this point in the history
  • Loading branch information
@kaaax0815
kaaax0815 committed May 5, 2021
1 parent 254bce3 commit 51fd85e
Show file tree
Hide file tree
Showing 20 changed files with 669 additions and 243 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

52 changes: 30 additions & 22 deletions docs/classes/api.traffic.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,8 @@ <h3>Constructors</h3>
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="api.traffic.html#clones" class="tsd-kind-icon">clones</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="api.traffic.html#popularpaths" class="tsd-kind-icon">popularpaths</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="api.traffic.html#popularreferrers" class="tsd-kind-icon">popularreferrers</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="api.traffic.html#popularpaths" class="tsd-kind-icon">popular<wbr>Paths</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="api.traffic.html#popularreferrers" class="tsd-kind-icon">popular<wbr>Referrers</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="api.traffic.html#views" class="tsd-kind-icon">views</a></li>
</ul>
</section>
Expand Down Expand Up @@ -127,15 +127,15 @@ <h3>clones</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in api.ts:12</li>
<li>Defined in <a href="https://github.com/kaaax0815/github-insights/blob/87cdcee/src/api.ts#L12">api.ts:12</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>user: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The User of Repo</p>
<p>The User of &quot;repo&quot;</p>
</div>
</li>
<li>
Expand All @@ -157,29 +157,29 @@ <h5>password: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/api.clonestype.html" class="tsd-signature-type" data-tsd-kind="Interface">ClonesType</a><span class="tsd-signature-symbol">&gt;</span></h4>
<p>Clones as JSON Object</p>
<p>the total number of clones and breakdown per day for the last 14 days as JSON object</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="popularpaths" class="tsd-anchor"></a>
<h3>popularpaths</h3>
<h3>popular<wbr>Paths</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">popularpaths<span class="tsd-signature-symbol">(</span>user<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, repo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, username<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/api.pathstype.html" class="tsd-signature-type" data-tsd-kind="Interface">PathsType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">popular<wbr>Paths<span class="tsd-signature-symbol">(</span>user<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, repo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, username<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/api.pathstype.html" class="tsd-signature-type" data-tsd-kind="Interface">PathsType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in api.ts:27</li>
<li>Defined in <a href="https://github.com/kaaax0815/github-insights/blob/87cdcee/src/api.ts#L27">api.ts:27</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>user: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The User of Repo</p>
<p>The User of &quot;repo&quot;</p>
</div>
</li>
<li>
Expand All @@ -201,29 +201,29 @@ <h5>password: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/api.pathstype.html" class="tsd-signature-type" data-tsd-kind="Interface">PathsType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>Popular Paths as JSON Object</p>
<p>top 10 popular contents over the last 14 days as JSON object</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="popularreferrers" class="tsd-anchor"></a>
<h3>popularreferrers</h3>
<h3>popular<wbr>Referrers</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">popularreferrers<span class="tsd-signature-symbol">(</span>user<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, repo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, username<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/api.referrertype.html" class="tsd-signature-type" data-tsd-kind="Interface">ReferrerType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">popular<wbr>Referrers<span class="tsd-signature-symbol">(</span>user<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, repo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, username<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/api.referrertype.html" class="tsd-signature-type" data-tsd-kind="Interface">ReferrerType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in api.ts:47</li>
<li>Defined in <a href="https://github.com/kaaax0815/github-insights/blob/87cdcee/src/api.ts#L47">api.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>user: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The User of Repo</p>
<p>The User of &quot;repo&quot;</p>
</div>
</li>
<li>
Expand All @@ -245,7 +245,7 @@ <h5>password: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/api.referrertype.html" class="tsd-signature-type" data-tsd-kind="Interface">ReferrerType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>Popular Referrers as JSON Object</p>
<p>the top 10 referrers over the last 14 days as JSON object</p>
</li>
</ul>
</section>
Expand All @@ -259,15 +259,15 @@ <h3>views</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in api.ts:67</li>
<li>Defined in <a href="https://github.com/kaaax0815/github-insights/blob/87cdcee/src/api.ts#L67">api.ts:67</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>user: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The User of Repo</p>
<p>The User of &quot;repo&quot;</p>
</div>
</li>
<li>
Expand All @@ -289,7 +289,7 @@ <h5>password: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/api.viewstype.html" class="tsd-signature-type" data-tsd-kind="Interface">ViewsType</a><span class="tsd-signature-symbol">&gt;</span></h4>
<p>Views as JSON Object</p>
<p>total number of views and breakdown per day for the last 14 days as JSON object</p>
</li>
</ul>
</section>
Expand All @@ -305,7 +305,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<a href="../modules/api.html">api</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/index.html">index</a>
<a href="../modules/utils.html">utils</a>
</li>
</ul>
</nav>
Expand All @@ -323,10 +323,10 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<a href="api.traffic.html#clones" class="tsd-kind-icon">clones</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="api.traffic.html#popularpaths" class="tsd-kind-icon">popularpaths</a>
<a href="api.traffic.html#popularpaths" class="tsd-kind-icon">popular<wbr>Paths</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="api.traffic.html#popularreferrers" class="tsd-kind-icon">popularreferrers</a>
<a href="api.traffic.html#popularreferrers" class="tsd-kind-icon">popular<wbr>Referrers</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="api.traffic.html#views" class="tsd-kind-icon">views</a>
Expand All @@ -341,6 +341,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/api.clonestype.html" class="tsd-kind-icon">Clones<wbr>Type</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/api.commitactivitytype.html" class="tsd-kind-icon">Commit<wbr>Activity<wbr>Type</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/api.license.html" class="tsd-kind-icon">License</a>
</li>
Expand All @@ -362,6 +365,12 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/api.viewstype.html" class="tsd-kind-icon">Views<wbr>Type</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/api.html#commitactivity" class="tsd-kind-icon">Commit<wbr>Activity</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/api.html#punchcard" class="tsd-kind-icon">Punch<wbr>Card</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/api.html#repos" class="tsd-kind-icon">Repos</a>
</li>
Expand All @@ -380,7 +389,6 @@ <h2>Legend</h2>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
</ul>
<ul class="tsd-legend">
Expand Down
7 changes: 5 additions & 2 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,10 @@ <h2>💻 Usage</h2>
<p>With YARN:</p>
<pre><code class="language-txt">yarn add github-insights
</code></pre>
<a href="#📄-documentation" id="📄-documentation" style="color: inherit; text-decoration: none;">
<h2>📄 Documentation</h2>
</a>
<p>Documentation is available <a href="https://kaaax0815.github.io/github-insights/">here</a><br>The &quot;API&quot; Module is most Important, &quot;INDEX&quot; just exports it</p>
<a href="#📖-example" id="📖-example" style="color: inherit; text-decoration: none;">
<h2>📖 Example</h2>
</a>
Expand Down Expand Up @@ -99,7 +103,7 @@ <h2>📄 License</h2>
<a href="modules/api.html">api</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/index.html">index</a>
<a href="modules/utils.html">utils</a>
</li>
</ul>
</nav>
Expand All @@ -115,7 +119,6 @@ <h2>📄 License</h2>
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
</ul>
<ul class="tsd-legend">
Expand Down
24 changes: 16 additions & 8 deletions docs/interfaces/api.clonesentity.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ <h3>count</h3>
<div class="tsd-signature tsd-kind-icon">count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in api.ts:95</li>
<li>Defined in <a href="https://github.com/kaaax0815/github-insights/blob/87cdcee/src/api.ts#L117">api.ts:117</a></li>
</ul>
</aside>
</section>
Expand All @@ -109,7 +109,7 @@ <h3>timestamp</h3>
<div class="tsd-signature tsd-kind-icon">timestamp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in api.ts:94</li>
<li>Defined in <a href="https://github.com/kaaax0815/github-insights/blob/87cdcee/src/api.ts#L116">api.ts:116</a></li>
</ul>
</aside>
</section>
Expand All @@ -119,7 +119,7 @@ <h3>uniques</h3>
<div class="tsd-signature tsd-kind-icon">uniques<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in api.ts:96</li>
<li>Defined in <a href="https://github.com/kaaax0815/github-insights/blob/87cdcee/src/api.ts#L118">api.ts:118</a></li>
</ul>
</aside>
</section>
Expand All @@ -135,7 +135,7 @@ <h3>uniques</h3>
<a href="../modules/api.html">api</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/index.html">index</a>
<a href="../modules/utils.html">utils</a>
</li>
</ul>
</nav>
Expand Down Expand Up @@ -165,6 +165,9 @@ <h3>uniques</h3>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="api.clonestype.html" class="tsd-kind-icon">Clones<wbr>Type</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="api.commitactivitytype.html" class="tsd-kind-icon">Commit<wbr>Activity<wbr>Type</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="api.license.html" class="tsd-kind-icon">License</a>
</li>
Expand All @@ -186,6 +189,12 @@ <h3>uniques</h3>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="api.viewstype.html" class="tsd-kind-icon">Views<wbr>Type</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/api.html#commitactivity" class="tsd-kind-icon">Commit<wbr>Activity</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/api.html#punchcard" class="tsd-kind-icon">Punch<wbr>Card</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/api.html#repos" class="tsd-kind-icon">Repos</a>
</li>
Expand All @@ -198,14 +207,13 @@ <h3>uniques</h3>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
</ul>
Expand Down
Loading

0 comments on commit 51fd85e

Please sign in to comment.