Skip to content

Commit

Permalink
#41 - API response validation (#42)
Browse files Browse the repository at this point in the history 
* feat: api validation

* chore: remove momentum statergy code

* chore: lint fix

* chore: sonar-lint fix

* chore: method name modified

* chore: file name modified

* chore: docs updated

* chore: jest timeout added cli options
  • Loading branch information
@asrafalih
asrafalih committed Jul 16, 2022
1 parent 39bd3d1 commit f26fae9
Show file tree
Hide file tree
Showing 31 changed files with 8,096 additions and 200 deletions.
24 changes: 12 additions & 12 deletions docs/classes/index.nseindia.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ <h3>get<wbr>All<wbr>Stock<wbr>Symbols</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L116">index.ts:116</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L116">index.ts:116</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</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-symbol">&gt;</span></h4>
Expand All @@ -153,7 +153,7 @@ <h3>get<wbr>Data</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L74">index.ts:74</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L74">index.ts:74</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -180,7 +180,7 @@ <h3>get<wbr>Data<wbr>ByEndpoint</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L106">index.ts:106</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L106">index.ts:106</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -206,7 +206,7 @@ <h3>get<wbr>Equity<wbr>Corporate<wbr>Info</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L141">index.ts:141</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L141">index.ts:141</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -229,7 +229,7 @@ <h3>get<wbr>Equity<wbr>Details</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L125">index.ts:125</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L125">index.ts:125</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -252,7 +252,7 @@ <h3>get<wbr>Equity<wbr>Historical<wbr>Data</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L164">index.ts:164</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L164">index.ts:164</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -278,7 +278,7 @@ <h3>get<wbr>Equity<wbr>Intraday<wbr>Data</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L150">index.ts:150</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L150">index.ts:150</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -304,7 +304,7 @@ <h3>get<wbr>Equity<wbr>Series</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L182">index.ts:182</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L182">index.ts:182</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -327,7 +327,7 @@ <h3>get<wbr>Equity<wbr>Stock<wbr>Indices</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L190">index.ts:190</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L190">index.ts:190</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -350,7 +350,7 @@ <h3>get<wbr>Equity<wbr>Trade<wbr>Info</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L133">index.ts:133</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L133">index.ts:133</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -373,7 +373,7 @@ <h3>get<wbr>Index<wbr>Historical<wbr>Data</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L211">index.ts:211</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L211">index.ts:211</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -399,7 +399,7 @@ <h3>get<wbr>Index<wbr>Intraday<wbr>Data</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L199">index.ts:199</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L199">index.ts:199</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
28 changes: 14 additions & 14 deletions docs/enums/index.apilist.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ <h3>ALL_<wbr>INDICES</h3>
<div class="tsd-signature tsd-kind-icon">ALL_<wbr>INDICES<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;/api/allIndices&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L22">index.ts:22</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L22">index.ts:22</a></li>
</ul>
</aside>
</section>
Expand All @@ -112,7 +112,7 @@ <h3>CIRCULARS</h3>
<div class="tsd-signature tsd-kind-icon">CIRCULARS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;/api/circulars&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L24">index.ts:24</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L24">index.ts:24</a></li>
</ul>
</aside>
</section>
Expand All @@ -122,7 +122,7 @@ <h3>EQUITY_<wbr>MASTER</h3>
<div class="tsd-signature tsd-kind-icon">EQUITY_<wbr>MASTER<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;/api/equity-master&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L26">index.ts:26</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L26">index.ts:26</a></li>
</ul>
</aside>
</section>
Expand All @@ -132,7 +132,7 @@ <h3>GLOSSARY</h3>
<div class="tsd-signature tsd-kind-icon">GLOSSARY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;/api/cmsContent?url&#x3D;/glossary&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L17">index.ts:17</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L17">index.ts:17</a></li>
</ul>
</aside>
</section>
Expand All @@ -142,7 +142,7 @@ <h3>HOLIDAY_<wbr>CLEARING</h3>
<div class="tsd-signature tsd-kind-icon">HOLIDAY_<wbr>CLEARING<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;/api/holiday-master?type&#x3D;clearing&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L19">index.ts:19</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L19">index.ts:19</a></li>
</ul>
</aside>
</section>
Expand All @@ -152,7 +152,7 @@ <h3>HOLIDAY_<wbr>TRADING</h3>
<div class="tsd-signature tsd-kind-icon">HOLIDAY_<wbr>TRADING<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;/api/holiday-master?type&#x3D;trading&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L18">index.ts:18</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L18">index.ts:18</a></li>
</ul>
</aside>
</section>
Expand All @@ -162,7 +162,7 @@ <h3>INDEX_<wbr>NAMES</h3>
<div class="tsd-signature tsd-kind-icon">INDEX_<wbr>NAMES<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;/api/index-names&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L23">index.ts:23</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L23">index.ts:23</a></li>
</ul>
</aside>
</section>
Expand All @@ -172,7 +172,7 @@ <h3>LATEST_<wbr>CIRCULARS</h3>
<div class="tsd-signature tsd-kind-icon">LATEST_<wbr>CIRCULARS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;/api/latest-circular&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L25">index.ts:25</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L25">index.ts:25</a></li>
</ul>
</aside>
</section>
Expand All @@ -182,7 +182,7 @@ <h3>MARKET_<wbr>DATA_<wbr>PRE_<wbr>OPEN</h3>
<div class="tsd-signature tsd-kind-icon">MARKET_<wbr>DATA_<wbr>PRE_<wbr>OPEN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;/api/market-data-pre-open?key&#x3D;ALL&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L27">index.ts:27</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L27">index.ts:27</a></li>
</ul>
</aside>
</section>
Expand All @@ -192,7 +192,7 @@ <h3>MARKET_<wbr>STATUS</h3>
<div class="tsd-signature tsd-kind-icon">MARKET_<wbr>STATUS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;/api/marketStatus&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L20">index.ts:20</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L20">index.ts:20</a></li>
</ul>
</aside>
</section>
Expand All @@ -202,7 +202,7 @@ <h3>MARKET_<wbr>TURNOVER</h3>
<div class="tsd-signature tsd-kind-icon">MARKET_<wbr>TURNOVER<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;/api/market-turnover&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L21">index.ts:21</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L21">index.ts:21</a></li>
</ul>
</aside>
</section>
Expand All @@ -212,7 +212,7 @@ <h3>MERGED_<wbr>DAILY_<wbr>REPORTS_<wbr>CAPITAL</h3>
<div class="tsd-signature tsd-kind-icon">MERGED_<wbr>DAILY_<wbr>REPORTS_<wbr>CAPITAL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;/api/merged-daily-reports?key&#x3D;favCapital&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L28">index.ts:28</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L28">index.ts:28</a></li>
</ul>
</aside>
</section>
Expand All @@ -222,7 +222,7 @@ <h3>MERGED_<wbr>DAILY_<wbr>REPORTS_<wbr>DEBT</h3>
<div class="tsd-signature tsd-kind-icon">MERGED_<wbr>DAILY_<wbr>REPORTS_<wbr>DEBT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;/api/merged-daily-reports?key&#x3D;favDebt&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L30">index.ts:30</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L30">index.ts:30</a></li>
</ul>
</aside>
</section>
Expand All @@ -232,7 +232,7 @@ <h3>MERGED_<wbr>DAILY_<wbr>REPORTS_<wbr>DERIVATIVES</h3>
<div class="tsd-signature tsd-kind-icon">MERGED_<wbr>DAILY_<wbr>REPORTS_<wbr>DERIVATIVES<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;/api/merged-daily-reports?key&#x3D;favDerivatives&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/index.ts#L29">index.ts:29</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/index.ts#L29">index.ts:29</a></li>
</ul>
</aside>
</section>
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/interface.daterange.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ <h3>end</h3>
<div class="tsd-signature tsd-kind-icon">end<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/interface.ts#L9">interface.ts:9</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/interface.ts#L9">interface.ts:9</a></li>
</ul>
</aside>
</section>
Expand All @@ -108,7 +108,7 @@ <h3>start</h3>
<div class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/610d7d2/src/interface.ts#L8">interface.ts:8</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/a5d45ec/src/interface.ts#L8">interface.ts:8</a></li>
</ul>
</aside>
</section>
Expand Down
Loading

0 comments on commit f26fae9

Please sign in to comment.