Skip to content

Commit

Permalink
Release readiness for v2.0.0 (#23)
Browse files Browse the repository at this point in the history 
* chore: version upgraded in package.json

* chore: examples modified

* chore: docs generated

* chore: EOL added
  • Loading branch information
@asrafalih
asrafalih authored Feb 22, 2021
1 parent f5e7f05 commit 4edb369
Show file tree
Hide file tree
Showing 22 changed files with 163 additions and 151 deletions.
8 changes: 4 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ scraper.start(["telivision", "mobiles"]); // It will scrape only specified categ

### scraper.stats(showAsNumbers?=false)

This method will show the stasts of scraper. By default stats will come as numerals like (3.1k, 1.45GB)
This method will show the stats of scraper. By default stats will come as numerals like (3.1k, 1.45GB)

- `showAsNumbers?` {boolean} Stats will return as number instead of numerals.

Expand Down Expand Up @@ -182,7 +182,7 @@ scraper.on("data", (data) => {

### events: 'categoryCompleted'

Emitted when all products scraped by category.
Emitted when all products scraped for the category.

**Example**

Expand All @@ -195,7 +195,7 @@ scraper.on("categoryCompleted", (completedCategoryInfo) => {

### events: 'finished'

Emitted when scraper finished
Emitted when scraper finished.

**Example**

Expand Down Expand Up @@ -234,7 +234,7 @@ scraper.on("retry", (retryInfo) => {

### events: 'retryHalted'

Emitted if any retries failed 10 times.
Emitted if any retries failed for 10 times.

**Example**

Expand Down
14 changes: 7 additions & 7 deletions docs/classes/index.flipkartscraper.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>FlipkartScraper | flipkart-scraper - v1.1.0</title>
<meta name="description" content="Documentation for flipkart-scraper - v1.1.0">
<title>FlipkartScraper | flipkart-scraper - v2.0.0</title>
<meta name="description" content="Documentation for flipkart-scraper - v2.0.0">
<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">flipkart-scraper - v1.1.0</a>
<a href="../index.html" class="title">flipkart-scraper - v2.0.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand All @@ -50,7 +50,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">flipkart-scraper - v1.1.0</a>
<a href="../modules.html">flipkart-scraper - v2.0.0</a>
</li>
<li>
<a href="../modules/index.html">index</a>
Expand Down Expand Up @@ -118,7 +118,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/3e6d6c2/src/index.ts#L93">index.ts:93</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/244fc7a/src/index.ts#L93">index.ts:93</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -157,7 +157,7 @@ <h3>start</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/3e6d6c2/src/index.ts#L177">index.ts:177</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/244fc7a/src/index.ts#L177">index.ts:177</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -182,7 +182,7 @@ <h3>stats</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/3e6d6c2/src/index.ts#L112">index.ts:112</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/244fc7a/src/index.ts#L112">index.ts:112</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
18 changes: 9 additions & 9 deletions docs/enums/enums.scraperstatus.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>ScraperStatus | flipkart-scraper - v1.1.0</title>
<meta name="description" content="Documentation for flipkart-scraper - v1.1.0">
<title>ScraperStatus | flipkart-scraper - v2.0.0</title>
<meta name="description" content="Documentation for flipkart-scraper - v2.0.0">
<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">flipkart-scraper - v1.1.0</a>
<a href="../index.html" class="title">flipkart-scraper - v2.0.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand All @@ -50,7 +50,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">flipkart-scraper - v1.1.0</a>
<a href="../modules.html">flipkart-scraper - v2.0.0</a>
</li>
<li>
<a href="../modules/enums.html">enums</a>
Expand Down Expand Up @@ -91,7 +91,7 @@ <h3>FINISHED</h3>
<div class="tsd-signature tsd-kind-icon">FINISHED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;finished&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/3e6d6c2/src/enums.ts#L6">enums.ts:6</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/244fc7a/src/enums.ts#L6">enums.ts:6</a></li>
</ul>
</aside>
</section>
Expand All @@ -101,7 +101,7 @@ <h3>INPROGRESS</h3>
<div class="tsd-signature tsd-kind-icon">INPROGRESS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;inprogress&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/3e6d6c2/src/enums.ts#L3">enums.ts:3</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/244fc7a/src/enums.ts#L3">enums.ts:3</a></li>
</ul>
</aside>
</section>
Expand All @@ -111,7 +111,7 @@ <h3>PAUSED</h3>
<div class="tsd-signature tsd-kind-icon">PAUSED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;paused&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/3e6d6c2/src/enums.ts#L4">enums.ts:4</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/244fc7a/src/enums.ts#L4">enums.ts:4</a></li>
</ul>
</aside>
</section>
Expand All @@ -121,7 +121,7 @@ <h3>READY</h3>
<div class="tsd-signature tsd-kind-icon">READY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;ready&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/3e6d6c2/src/enums.ts#L2">enums.ts:2</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/244fc7a/src/enums.ts#L2">enums.ts:2</a></li>
</ul>
</aside>
</section>
Expand All @@ -131,7 +131,7 @@ <h3>STOPPED</h3>
<div class="tsd-signature tsd-kind-icon">STOPPED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;stopped&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/3e6d6c2/src/enums.ts#L5">enums.ts:5</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/244fc7a/src/enums.ts#L5">enums.ts:5</a></li>
</ul>
</aside>
</section>
Expand Down
16 changes: 8 additions & 8 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>flipkart-scraper - v1.1.0</title>
<meta name="description" content="Documentation for flipkart-scraper - v1.1.0">
<title>flipkart-scraper - v2.0.0</title>
<meta name="description" content="Documentation for flipkart-scraper - v2.0.0">
<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">flipkart-scraper - v1.1.0</a>
<a href="index.html" class="title">flipkart-scraper - v2.0.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand All @@ -48,7 +48,7 @@
</div>
<div class="tsd-page-title">
<div class="container">
<h1>flipkart-scraper - v1.1.0</h1>
<h1>flipkart-scraper - v2.0.0</h1>
</div>
</div>
</header>
Expand Down Expand Up @@ -144,7 +144,7 @@ <h3>scraper.start([categoriesToScrape])</h3>
<a href="#scraperstatsshowasnumbersfalse" id="scraperstatsshowasnumbersfalse" style="color: inherit; text-decoration: none;">
<h3>scraper.stats(showAsNumbers?=false)</h3>
</a>
<p>This method will show the stasts of scraper. By default stats will come as numerals like (3.1k, 1.45GB)</p>
<p>This method will show the stats of scraper. By default stats will come as numerals like (3.1k, 1.45GB)</p>
<ul>
<li><code>showAsNumbers?</code> {boolean} Stats will return as number instead of numerals.</li>
</ul>
Expand Down Expand Up @@ -223,7 +223,7 @@ <h3>events: &#39;data&#39;</h3>
<a href="#events-39categorycompleted39" id="events-39categorycompleted39" style="color: inherit; text-decoration: none;">
<h3>events: &#39;categoryCompleted&#39;</h3>
</a>
<p>Emitted when all products scraped by category.</p>
<p>Emitted when all products scraped for the category.</p>
<p><strong>Example</strong></p>
<pre><code class="language-javascript"><span style="color: #008000">// &#039;categoryCompleted&#039; event handler</span>
<span style="color: #001080">scraper</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">&quot;categoryCompleted&quot;</span><span style="color: #000000">, (</span><span style="color: #001080">completedCategoryInfo</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
Expand All @@ -233,7 +233,7 @@ <h3>events: &#39;categoryCompleted&#39;</h3>
<a href="#events-39finished39" id="events-39finished39" style="color: inherit; text-decoration: none;">
<h3>events: &#39;finished&#39;</h3>
</a>
<p>Emitted when scraper finished</p>
<p>Emitted when scraper finished.</p>
<p><strong>Example</strong></p>
<pre><code class="language-javascript"><span style="color: #008000">// &#039;finished&#039; event handler</span>
<span style="color: #001080">scraper</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">&quot;finished&quot;</span><span style="color: #000000">, (</span><span style="color: #001080">info</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
Expand Down Expand Up @@ -263,7 +263,7 @@ <h3>events: &#39;retry&#39;</h3>
<a href="#events-39retryhalted39" id="events-39retryhalted39" style="color: inherit; text-decoration: none;">
<h3>events: &#39;retryHalted&#39;</h3>
</a>
<p>Emitted if any retries failed 10 times.</p>
<p>Emitted if any retries failed for 10 times.</p>
<p><strong>Example</strong></p>
<pre><code class="language-javascript"><span style="color: #008000">// Triggerd when retry failed 10 times</span>
<span style="color: #001080">scraper</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">&quot;retryHalted&quot;</span><span style="color: #000000">, (</span><span style="color: #001080">retryHaltInfo</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
Expand Down
16 changes: 8 additions & 8 deletions docs/interfaces/interfaces.categoryinfo.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>CategoryInfo | flipkart-scraper - v1.1.0</title>
<meta name="description" content="Documentation for flipkart-scraper - v1.1.0">
<title>CategoryInfo | flipkart-scraper - v2.0.0</title>
<meta name="description" content="Documentation for flipkart-scraper - v2.0.0">
<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">flipkart-scraper - v1.1.0</a>
<a href="../index.html" class="title">flipkart-scraper - v2.0.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand All @@ -50,7 +50,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">flipkart-scraper - v1.1.0</a>
<a href="../modules.html">flipkart-scraper - v2.0.0</a>
</li>
<li>
<a href="../modules/interfaces.html">interfaces</a>
Expand Down Expand Up @@ -98,7 +98,7 @@ <h3>category</h3>
<div class="tsd-signature tsd-kind-icon">category<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/3e6d6c2/src/interfaces.ts#L75">interfaces.ts:75</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/244fc7a/src/interfaces.ts#L75">interfaces.ts:75</a></li>
</ul>
</aside>
</section>
Expand All @@ -108,7 +108,7 @@ <h3>elapsed</h3>
<div class="tsd-signature tsd-kind-icon">elapsed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/3e6d6c2/src/interfaces.ts#L78">interfaces.ts:78</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/244fc7a/src/interfaces.ts#L78">interfaces.ts:78</a></li>
</ul>
</aside>
</section>
Expand All @@ -118,7 +118,7 @@ <h3>no<wbr>OfPages</h3>
<div class="tsd-signature tsd-kind-icon">no<wbr>OfPages<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/3e6d6c2/src/interfaces.ts#L76">interfaces.ts:76</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/244fc7a/src/interfaces.ts#L76">interfaces.ts:76</a></li>
</ul>
</aside>
</section>
Expand All @@ -128,7 +128,7 @@ <h3>total<wbr>Products</h3>
<div class="tsd-signature tsd-kind-icon">total<wbr>Products<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/3e6d6c2/src/interfaces.ts#L77">interfaces.ts:77</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/244fc7a/src/interfaces.ts#L77">interfaces.ts:77</a></li>
</ul>
</aside>
</section>
Expand Down
12 changes: 6 additions & 6 deletions docs/interfaces/interfaces.finishedinfo.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>FinishedInfo | flipkart-scraper - v1.1.0</title>
<meta name="description" content="Documentation for flipkart-scraper - v1.1.0">
<title>FinishedInfo | flipkart-scraper - v2.0.0</title>
<meta name="description" content="Documentation for flipkart-scraper - v2.0.0">
<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">flipkart-scraper - v1.1.0</a>
<a href="../index.html" class="title">flipkart-scraper - v2.0.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand All @@ -50,7 +50,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">flipkart-scraper - v1.1.0</a>
<a href="../modules.html">flipkart-scraper - v2.0.0</a>
</li>
<li>
<a href="../modules/interfaces.html">interfaces</a>
Expand Down Expand Up @@ -96,7 +96,7 @@ <h3>message</h3>
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/3e6d6c2/src/interfaces.ts#L89">interfaces.ts:89</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/244fc7a/src/interfaces.ts#L89">interfaces.ts:89</a></li>
</ul>
</aside>
</section>
Expand All @@ -106,7 +106,7 @@ <h3>total<wbr>Request</h3>
<div class="tsd-signature tsd-kind-icon">total<wbr>Request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/3e6d6c2/src/interfaces.ts#L90">interfaces.ts:90</a></li>
<li>Defined in <a href="https://github.com/hi-imcodeman/flipkart-scraper/blob/244fc7a/src/interfaces.ts#L90">interfaces.ts:90</a></li>
</ul>
</aside>
</section>
Expand Down
Loading

0 comments on commit 4edb369

Please sign in to comment.