Skip to content

Commit

Permalink
Release readiness v1.1.6 (#98)
Browse files Browse the repository at this point in the history 
* chore: enhance option api

* chore: docs updated
  • Loading branch information
@asrafalih
asrafalih authored Jul 22, 2024
1 parent a785a05 commit 11ed2ba
Show file tree
Hide file tree
Showing 39 changed files with 881 additions and 807 deletions.
4 changes: 4 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ nseIndia.getEquityHistoricalData(symbol, range).then(data => {

[getEquityIntradayData](https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getequityintradaydata)

[getEquityOptionChain](https://hi-imcodeman.github.io/stock-nse-india/docs/classes/index.nseindia.html#getequityoptionchain)

[getEquitySeries](https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getequityseries)

[getEquityTradeInfo](https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getequitytradeinfo)
Expand All @@ -79,6 +81,8 @@ nseIndia.getEquityHistoricalData(symbol, range).then(data => {

[getIndexHistoricalData](https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getindexhistoricaldata)

[getIndexOptionChain](https://hi-imcodeman.github.io/stock-nse-india/docs/classes/index.nseindia.html#getindexoptionchain)

### Helper Methods
[getGainersAndLosersByIndex](https://hi-imcodeman.github.io/stock-nse-india/modules/helpers.html#getgainersandlosersbyindex)

Expand Down
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

77 changes: 52 additions & 25 deletions docs/classes/index.nseindia.html
View file

Large diffs are not rendered by default.

50 changes: 18 additions & 32 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.5</title>
<meta name="description" content="Documentation for stock-nse-india - v1.1.5">
<title>ApiList | stock-nse-india - v1.1.6</title>
<meta name="description" content="Documentation for stock-nse-india - v1.1.6">
<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.5</a>
<a href="../index.html" class="title">stock-nse-india - v1.1.6</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.5</a>
<a href="../modules.html">stock-nse-india - v1.1.6</a>
</li>
<li>
<a href="../modules/index.html">index</a>
Expand Down Expand Up @@ -89,7 +89,6 @@ <h3>Enumeration members</h3>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="index.apilist.html#merged_daily_reports_capital" class="tsd-kind-icon">MERGED_<wbr>DAILY_<wbr>REPORTS_<wbr>CAPITAL</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="index.apilist.html#merged_daily_reports_debt" class="tsd-kind-icon">MERGED_<wbr>DAILY_<wbr>REPORTS_<wbr>DEBT</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="index.apilist.html#merged_daily_reports_derivatives" class="tsd-kind-icon">MERGED_<wbr>DAILY_<wbr>REPORTS_<wbr>DERIVATIVES</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="index.apilist.html#nse_option_chain" class="tsd-kind-icon">NSE_<wbr>OPTION_<wbr>CHAIN</a></li>
</ul>
</section>
</div>
Expand All @@ -103,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/DIBO237/stock-nse-india/blob/686e069/src/index.ts#L22">index.ts:22</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/d873069/src/index.ts#L23">index.ts:23</a></li>
</ul>
</aside>
</section>
Expand All @@ -113,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/DIBO237/stock-nse-india/blob/686e069/src/index.ts#L24">index.ts:24</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/d873069/src/index.ts#L25">index.ts:25</a></li>
</ul>
</aside>
</section>
Expand All @@ -123,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/DIBO237/stock-nse-india/blob/686e069/src/index.ts#L26">index.ts:26</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/d873069/src/index.ts#L27">index.ts:27</a></li>
</ul>
</aside>
</section>
Expand All @@ -133,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/DIBO237/stock-nse-india/blob/686e069/src/index.ts#L17">index.ts:17</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/d873069/src/index.ts#L18">index.ts:18</a></li>
</ul>
</aside>
</section>
Expand All @@ -143,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/DIBO237/stock-nse-india/blob/686e069/src/index.ts#L19">index.ts:19</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/d873069/src/index.ts#L20">index.ts:20</a></li>
</ul>
</aside>
</section>
Expand All @@ -153,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/DIBO237/stock-nse-india/blob/686e069/src/index.ts#L18">index.ts:18</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/d873069/src/index.ts#L19">index.ts:19</a></li>
</ul>
</aside>
</section>
Expand All @@ -163,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/DIBO237/stock-nse-india/blob/686e069/src/index.ts#L23">index.ts:23</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/d873069/src/index.ts#L24">index.ts:24</a></li>
</ul>
</aside>
</section>
Expand All @@ -173,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/DIBO237/stock-nse-india/blob/686e069/src/index.ts#L25">index.ts:25</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/d873069/src/index.ts#L26">index.ts:26</a></li>
</ul>
</aside>
</section>
Expand All @@ -183,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/DIBO237/stock-nse-india/blob/686e069/src/index.ts#L27">index.ts:27</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/d873069/src/index.ts#L28">index.ts:28</a></li>
</ul>
</aside>
</section>
Expand All @@ -193,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/DIBO237/stock-nse-india/blob/686e069/src/index.ts#L20">index.ts:20</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/d873069/src/index.ts#L21">index.ts:21</a></li>
</ul>
</aside>
</section>
Expand All @@ -203,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/DIBO237/stock-nse-india/blob/686e069/src/index.ts#L21">index.ts:21</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/d873069/src/index.ts#L22">index.ts:22</a></li>
</ul>
</aside>
</section>
Expand All @@ -213,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/DIBO237/stock-nse-india/blob/686e069/src/index.ts#L28">index.ts:28</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/d873069/src/index.ts#L29">index.ts:29</a></li>
</ul>
</aside>
</section>
Expand All @@ -223,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/DIBO237/stock-nse-india/blob/686e069/src/index.ts#L30">index.ts:30</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/d873069/src/index.ts#L31">index.ts:31</a></li>
</ul>
</aside>
</section>
Expand All @@ -233,17 +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/DIBO237/stock-nse-india/blob/686e069/src/index.ts#L29">index.ts:29</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="nse_option_chain" class="tsd-anchor"></a>
<h3>NSE_<wbr>OPTION_<wbr>CHAIN</h3>
<div class="tsd-signature tsd-kind-icon">NSE_<wbr>OPTION_<wbr>CHAIN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;/api/option-chain-indices?symbol&#x3D;&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DIBO237/stock-nse-india/blob/686e069/src/index.ts#L31">index.ts:31</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/d873069/src/index.ts#L30">index.ts:30</a></li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -315,9 +304,6 @@ <h3>NSE_<wbr>OPTION_<wbr>CHAIN</h3>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="index.apilist.html#merged_daily_reports_derivatives" class="tsd-kind-icon">MERGED_<wbr>DAILY_<wbr>REPORTS_<wbr>DERIVATIVES</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="index.apilist.html#nse_option_chain" class="tsd-kind-icon">NSE_<wbr>OPTION_<wbr>CHAIN</a>
</li>
</ul>
</li>
</ul>
Expand Down
22 changes: 11 additions & 11 deletions docs/enums/interface.underlying.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>Underlying | stock-nse-india - v1.1.5</title>
<meta name="description" content="Documentation for stock-nse-india - v1.1.5">
<title>Underlying | stock-nse-india - v1.1.6</title>
<meta name="description" content="Documentation for stock-nse-india - v1.1.6">
<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.5</a>
<a href="../index.html" class="title">stock-nse-india - v1.1.6</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.5</a>
<a href="../modules.html">stock-nse-india - v1.1.6</a>
</li>
<li>
<a href="../modules/interface.html">interface</a>
Expand Down Expand Up @@ -89,7 +89,7 @@ <h3>Nifty</h3>
<div class="tsd-signature tsd-kind-icon">Nifty<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;NIFTY&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DIBO237/stock-nse-india/blob/686e069/src/interface.ts#L80">interface.ts:80</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/d873069/src/interface.ts#L88">interface.ts:88</a></li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -132,9 +132,6 @@ <h3>Nifty</h3>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/interface.datum.html" class="tsd-kind-icon">Datum</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/interface.datumce.html" class="tsd-kind-icon">DatumCE</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/interface.directorydetails.html" class="tsd-kind-icon">Directory<wbr>Details</a>
</li>
Expand Down Expand Up @@ -171,9 +168,6 @@ <h3>Nifty</h3>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/interface.filtered.html" class="tsd-kind-icon">Filtered</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/interface.filteredce.html" class="tsd-kind-icon">FilteredCE</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/interface.indexdetails.html" class="tsd-kind-icon">Index<wbr>Details</a>
</li>
Expand All @@ -189,6 +183,12 @@ <h3>Nifty</h3>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/interface.optionchaindata.html" class="tsd-kind-icon">Option<wbr>Chain<wbr>Data</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/interface.optionsdata.html" class="tsd-kind-icon">Options<wbr>Data</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/interface.optionsdetails.html" class="tsd-kind-icon">Options<wbr>Details</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/interface.preopendetails.html" class="tsd-kind-icon">Pre<wbr>Open<wbr>Details</a>
</li>
Expand Down
10 changes: 6 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.5</title>
<meta name="description" content="Documentation for stock-nse-india - v1.1.5">
<title>stock-nse-india - v1.1.6</title>
<meta name="description" content="Documentation for stock-nse-india - v1.1.6">
<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.5</a>
<a href="index.html" class="title">stock-nse-india - v1.1.6</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.5</h1>
<h1>stock-nse-india - v1.1.6</h1>
</div>
</div>
</header>
Expand Down Expand Up @@ -115,6 +115,7 @@ <h3>Equity Methods</h3>
<p><a href="https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getequitydetails">getEquityDetails</a></p>
<p><a href="https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getequityhistoricaldata">getEquityHistoricalData</a></p>
<p><a href="https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getequityintradaydata">getEquityIntradayData</a></p>
<p><a href="https://hi-imcodeman.github.io/stock-nse-india/docs/classes/index.nseindia.html#getequityoptionchain">getEquityOptionChain</a></p>
<p><a href="https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getequityseries">getEquitySeries</a></p>
<p><a href="https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getequitytradeinfo">getEquityTradeInfo</a></p>
<a href="#index-methods" id="index-methods" style="color: inherit; text-decoration: none;">
Expand All @@ -123,6 +124,7 @@ <h3>Index Methods</h3>
<p><a href="https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getequitystockindices">getEquityStockIndices</a></p>
<p><a href="https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getindexintradaydata">getIndexIntradayData</a></p>
<p><a href="https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getindexhistoricaldata">getIndexHistoricalData</a></p>
<p><a href="https://hi-imcodeman.github.io/stock-nse-india/docs/classes/index.nseindia.html#getindexoptionchain">getIndexOptionChain</a></p>
<a href="#helper-methods" id="helper-methods" style="color: inherit; text-decoration: none;">
<h3>Helper Methods</h3>
</a>
Expand Down
Loading

0 comments on commit 11ed2ba

Please sign in to comment.