Skip to content

Commit

Permalink
chore: readme and docs updated (#82)
Browse files Browse the repository at this point in the history
  • Loading branch information
@asrafalih
asrafalih authored Feb 9, 2024
1 parent fdbc0c5 commit 2b1100a
Show file tree
Hide file tree
Showing 29 changed files with 312 additions and 328 deletions.
6 changes: 6 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -208,3 +208,9 @@ Run the below command for testing and coverage.
```sh
yarn test
```

## Contributors

<a href="https://github.com/hi-imcodeman/stock-nse-india/graphs/contributors">
<img src="https://contrib.rocks/image?repo=hi-imcodeman/stock-nse-india" />
</a>
32 changes: 16 additions & 16 deletions docs/classes/index.nseindia.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>NseIndia | stock-nse-india - v1.1.4</title>
<meta name="description" content="Documentation for stock-nse-india - v1.1.4">
<title>NseIndia | stock-nse-india - v1.1.5</title>
<meta name="description" content="Documentation for stock-nse-india - v1.1.5">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
Expand All @@ -23,7 +23,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">stock-nse-india - v1.1.4</a>
<a href="../index.html" class="title">stock-nse-india - v1.1.5</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand Down Expand Up @@ -52,7 +52,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">stock-nse-india - v1.1.4</a>
<a href="../modules.html">stock-nse-india - v1.1.5</a>
</li>
<li>
<a href="../modules/index.html">index</a>
Expand Down 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/0a558df/src/index.ts#L112">index.ts:112</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L124">index.ts:124</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/0a558df/src/index.ts#L74">index.ts:74</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L85">index.ts:85</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/0a558df/src/index.ts#L105">index.ts:105</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L117">index.ts:117</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -203,7 +203,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/0a558df/src/index.ts#L138">index.ts:138</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L150">index.ts:150</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -226,7 +226,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/0a558df/src/index.ts#L121">index.ts:121</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L133">index.ts:133</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -249,7 +249,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/0a558df/src/index.ts#L162">index.ts:162</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L174">index.ts:174</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -275,7 +275,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/0a558df/src/index.ts#L148">index.ts:148</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L160">index.ts:160</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -301,7 +301,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/0a558df/src/index.ts#L181">index.ts:181</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L193">index.ts:193</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -324,7 +324,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/0a558df/src/index.ts#L190">index.ts:190</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L202">index.ts:202</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -347,7 +347,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/0a558df/src/index.ts#L129">index.ts:129</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L141">index.ts:141</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -370,7 +370,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/0a558df/src/index.ts#L211">index.ts:211</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L223">index.ts:223</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -396,7 +396,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/0a558df/src/index.ts#L199">index.ts:199</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L211">index.ts:211</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
36 changes: 18 additions & 18 deletions docs/enums/index.apilist.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ApiList | stock-nse-india - v1.1.4</title>
<meta name="description" content="Documentation for stock-nse-india - v1.1.4">
<title>ApiList | stock-nse-india - v1.1.5</title>
<meta name="description" content="Documentation for stock-nse-india - v1.1.5">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
Expand All @@ -23,7 +23,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">stock-nse-india - v1.1.4</a>
<a href="../index.html" class="title">stock-nse-india - v1.1.5</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand Down Expand Up @@ -52,7 +52,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">stock-nse-india - v1.1.4</a>
<a href="../modules.html">stock-nse-india - v1.1.5</a>
</li>
<li>
<a href="../modules/index.html">index</a>
Expand Down 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/0a558df/src/index.ts#L21">index.ts:21</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L21">index.ts:21</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/0a558df/src/index.ts#L23">index.ts:23</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L23">index.ts:23</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/0a558df/src/index.ts#L25">index.ts:25</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L25">index.ts:25</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/0a558df/src/index.ts#L16">index.ts:16</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L16">index.ts:16</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/0a558df/src/index.ts#L18">index.ts:18</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L18">index.ts:18</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/0a558df/src/index.ts#L17">index.ts:17</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L17">index.ts:17</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/0a558df/src/index.ts#L22">index.ts:22</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L22">index.ts:22</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/0a558df/src/index.ts#L24">index.ts:24</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L24">index.ts:24</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/0a558df/src/index.ts#L26">index.ts:26</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L26">index.ts:26</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/0a558df/src/index.ts#L19">index.ts:19</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L19">index.ts:19</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/0a558df/src/index.ts#L20">index.ts:20</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L20">index.ts:20</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/0a558df/src/index.ts#L27">index.ts:27</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L27">index.ts:27</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/0a558df/src/index.ts#L29">index.ts:29</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L29">index.ts:29</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/0a558df/src/index.ts#L28">index.ts:28</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/fdbc0c5/src/index.ts#L28">index.ts:28</a></li>
</ul>
</aside>
</section>
Expand Down
14 changes: 10 additions & 4 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>stock-nse-india - v1.1.4</title>
<meta name="description" content="Documentation for stock-nse-india - v1.1.4">
<title>stock-nse-india - v1.1.5</title>
<meta name="description" content="Documentation for stock-nse-india - v1.1.5">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
<script async src="assets/js/search.js" id="search-script"></script>
Expand All @@ -23,7 +23,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">stock-nse-india - v1.1.4</a>
<a href="index.html" class="title">stock-nse-india - v1.1.5</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand All @@ -50,7 +50,7 @@
</div>
<div class="tsd-page-title">
<div class="container">
<h1>stock-nse-india - v1.1.4</h1>
<h1>stock-nse-india - v1.1.5</h1>
</div>
</div>
</header>
Expand Down Expand Up @@ -208,6 +208,12 @@ <h2>Testing</h2>
<p>Run the below command for testing and coverage.</p>
<pre><code class="language-sh"><span style="color: #000000">yarn </span><span style="color: #795E26">test</span>
</code></pre>
<a href="#contributors" id="contributors" style="color: inherit; text-decoration: none;">
<h2>Contributors</h2>
</a>
<a href="https://github.com/hi-imcodeman/stock-nse-india/graphs/contributors">
<img src="https://contrib.rocks/image?repo=hi-imcodeman/stock-nse-india" />
</a>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
Expand Down
Loading

0 comments on commit 2b1100a

Please sign in to comment.