Skip to content

Commit

Permalink
Release readiness for v1.1.2 (#60)
Browse files Browse the repository at this point in the history 
* chore: vercel.json removed for now

* chore: move dist to build

* chore: added some badges

* chore: docs updated

* chore: added EOL on eslintignore file
  • Loading branch information
@asrafalih
asrafalih authored Jan 28, 2023
1 parent 2bc3f3e commit ebc5fe0
Show file tree
Hide file tree
Showing 33 changed files with 294 additions and 320 deletions.
1 change: 1 addition & 0 deletions .eslintignore
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
node_modules
build
dist
2 changes: 2 additions & 0 deletions .npmignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,7 @@ docs/
examples/
.eslintrc
.eslintignore
.gitignore
*.map
Dockerfile
coverage
9 changes: 1 addition & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# National Stock Exchange - India (Unofficial)

![](https://github.com/hi-imcodeman/stock-nse-india/workflows/CI/badge.svg)
![](https://github.com/hi-imcodeman/stock-nse-india/workflows/CI/badge.svg) ![npm](https://img.shields.io/npm/dt/stock-nse-india) ![NPM](https://img.shields.io/npm/l/stock-nse-india) ![GitHub Release Date - Published_At](https://img.shields.io/github/release-date/hi-imcodeman/stock-nse-india) ![GitHub top language](https://img.shields.io/github/languages/top/hi-imcodeman/stock-nse-india)

This package will help us to get equity/index details and historical data from National Stock Exchange of India.

Expand Down Expand Up @@ -200,13 +200,6 @@ For API service documentation please hit http://localhoast:3001/api-docs

https://hub.docker.com/r/imcodeman/nseindia

## Demo

Please the use below links for the demo.

**Demo URL:** https://stock-nse-india.herokuapp.com/

**API Docs URL:** https://stock-nse-india.herokuapp.com/api-docs

## Testing

Expand Down
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.1</title>
<meta name="description" content="Documentation for stock-nse-india - v1.1.1">
<title>NseIndia | stock-nse-india - v1.1.2</title>
<meta name="description" content="Documentation for stock-nse-india - v1.1.2">
<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.1</a>
<a href="../index.html" class="title">stock-nse-india - v1.1.2</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.1</a>
<a href="../modules.html">stock-nse-india - v1.1.2</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/a5d45ec/src/index.ts#L116">index.ts:116</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/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/a5d45ec/src/index.ts#L74">index.ts:74</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/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/a5d45ec/src/index.ts#L106">index.ts:106</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/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/a5d45ec/src/index.ts#L141">index.ts:141</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/src/index.ts#L142">index.ts:142</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/a5d45ec/src/index.ts#L125">index.ts:125</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/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/a5d45ec/src/index.ts#L164">index.ts:164</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/src/index.ts#L166">index.ts:166</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/a5d45ec/src/index.ts#L150">index.ts:150</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/src/index.ts#L152">index.ts:152</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/a5d45ec/src/index.ts#L182">index.ts:182</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/src/index.ts#L185">index.ts:185</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/a5d45ec/src/index.ts#L190">index.ts:190</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/src/index.ts#L194">index.ts:194</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/a5d45ec/src/index.ts#L133">index.ts:133</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/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/a5d45ec/src/index.ts#L211">index.ts:211</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/src/index.ts#L215">index.ts:215</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/a5d45ec/src/index.ts#L199">index.ts:199</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/src/index.ts#L203">index.ts:203</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.1</title>
<meta name="description" content="Documentation for stock-nse-india - v1.1.1">
<title>ApiList | stock-nse-india - v1.1.2</title>
<meta name="description" content="Documentation for stock-nse-india - v1.1.2">
<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.1</a>
<a href="../index.html" class="title">stock-nse-india - v1.1.2</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.1</a>
<a href="../modules.html">stock-nse-india - v1.1.2</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/a5d45ec/src/index.ts#L22">index.ts:22</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/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/a5d45ec/src/index.ts#L24">index.ts:24</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/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/a5d45ec/src/index.ts#L26">index.ts:26</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/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/a5d45ec/src/index.ts#L17">index.ts:17</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/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/a5d45ec/src/index.ts#L19">index.ts:19</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/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/a5d45ec/src/index.ts#L18">index.ts:18</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/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/a5d45ec/src/index.ts#L23">index.ts:23</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/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/a5d45ec/src/index.ts#L25">index.ts:25</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/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/a5d45ec/src/index.ts#L27">index.ts:27</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/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/a5d45ec/src/index.ts#L20">index.ts:20</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/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/a5d45ec/src/index.ts#L21">index.ts:21</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/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/a5d45ec/src/index.ts#L28">index.ts:28</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/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/a5d45ec/src/index.ts#L30">index.ts:30</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/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/a5d45ec/src/index.ts#L29">index.ts:29</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/stock-nse-india/blob/3c80e21/src/index.ts#L29">index.ts:29</a></li>
</ul>
</aside>
</section>
Expand Down
Loading

0 comments on commit ebc5fe0

Please sign in to comment.