Skip to content

Commit

Permalink
chore(release): 2.0.4 [skip ci]
Browse files Browse the repository at this point in the history 
## [2.0.4](v2.0.3...v2.0.4) (2021-11-15)

### Bug Fixes

* make jsdom and pino peer dependencies ([5aabad2](5aabad2))
  • Loading branch information
@semantic-release-bot
semantic-release-bot committed Nov 15, 2021
1 parent 32146cd commit 97bfd4b
Show file tree
Hide file tree
Showing 10 changed files with 37 additions and 24 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
## [2.0.4](https://github.com/armand1m/papercut/compare/v2.0.3...v2.0.4) (2021-11-15)


### Bug Fixes

* make jsdom and pino peer dependencies ([5aabad2](https://github.com/armand1m/papercut/commit/5aabad246c45127f9a3f5b23f18e1aa407410704))

## [2.0.3](https://github.com/armand1m/papercut/compare/v2.0.2...v2.0.3) (2021-11-15)


Expand Down
12 changes: 9 additions & 3 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,14 @@
<a href="#papercut" id="papercut" style="color: inherit; text-decoration: none;">
<h1>Papercut</h1>
</a>
<p><a href="https://www.npmjs.com/package/@armand1m/papercut"><img src="https://img.shields.io/npm/v/@armand1m/papercut.svg" alt="NPM"></a> <a href="https://standardjs.com"><img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="JavaScript Style Guide"></a>
<a href="https://codecov.io/gh/armand1m/papercut"><img src="https://codecov.io/gh/armand1m/papercut/branch/master/graph/badge.svg" alt="codecov"></a>
<a href="https://bundlephobia.com/result?p=@armand1m/papercut"><img src="https://badgen.net/bundlephobia/min/@armand1m/papercut" alt="bundlephobia"></a>
<a href="https://bundlephobia.com/result?p=@armand1m/papercut"><img src="https://badgen.net/bundlephobia/minzip/@armand1m/papercut" alt="bundlephobia"></a></p>
<blockquote>
<p>Papercut is a scraping/crawling library for Node.js, written in Typescript.</p>
<p>It provides a type-safe and small foundation that makes it fairly easy to scrape webpages with confidence.</p>
</blockquote>
<p>Papercut provides a small type-safe and tested foundation that makes it fairly easy to scrape webpages with confidence.</p>

<a href="#features" id="features" style="color: inherit; text-decoration: none;">
<h2>Features</h2>
Expand Down Expand Up @@ -63,8 +69,8 @@ <h3>Quick example</h3>
<p>Create an empty project with yarn:</p>
<pre><code class="language-sh"><span class="hl-0">mkdir papercut-demo</span><br/><span class="hl-1">cd</span><span class="hl-0"> papercut-demo</span><br/><span class="hl-0">yarn init -y</span>
</code></pre>
<p>Add papercut:</p>
<pre><code class="language-sh"><span class="hl-0">yarn add @armand1m/papercut</span>
<p>Add papercut and the needed peer dependencies:</p>
<pre><code class="language-sh"><span class="hl-0">yarn add @armand1m/papercut jsdom pino</span>
</code></pre>

<a href="#single-page-scraper" id="single-page-scraper" style="color: inherit; text-decoration: none;">
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/CreateRunnerProps.html
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CreateRunnerProps | @armand1m/papercut</title><meta name="description" content="Documentation for @armand1m/papercut"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><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">@armand1m/papercut</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@armand1m/papercut</a></li><li><a href="CreateRunnerProps.html">CreateRunnerProps</a></li></ul><h1>Interface CreateRunnerProps</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CreateRunnerProps</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CreateRunnerProps.html#logger" class="tsd-kind-icon">logger</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CreateRunnerProps.html#options" class="tsd-kind-icon">options</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="logger" class="tsd-anchor"></a><h3>logger</h3><div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Logger</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/armand1m/papercut/blob/34787fc/src/scraper/createRunner.ts#L68">scraper/createRunner.ts:68</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CreateRunnerProps | @armand1m/papercut</title><meta name="description" content="Documentation for @armand1m/papercut"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><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">@armand1m/papercut</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@armand1m/papercut</a></li><li><a href="CreateRunnerProps.html">CreateRunnerProps</a></li></ul><h1>Interface CreateRunnerProps</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CreateRunnerProps</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CreateRunnerProps.html#logger" class="tsd-kind-icon">logger</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CreateRunnerProps.html#options" class="tsd-kind-icon">options</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="logger" class="tsd-anchor"></a><h3>logger</h3><div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Logger</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/armand1m/papercut/blob/32146cd/src/scraper/createRunner.ts#L68">scraper/createRunner.ts:68</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A pino.Logger instance.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="options" class="tsd-anchor"></a><h3>options</h3><div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <a href="ScraperOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ScraperOptions</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/armand1m/papercut/blob/34787fc/src/scraper/createRunner.ts#L73">scraper/createRunner.ts:73</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="options" class="tsd-anchor"></a><h3>options</h3><div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <a href="ScraperOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ScraperOptions</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/armand1m/papercut/blob/32146cd/src/scraper/createRunner.ts#L73">scraper/createRunner.ts:73</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The scraper options.
Use this to tweak log, cache and concurrency settings.</p>
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="CreateRunnerProps.html" class="tsd-kind-icon">Create<wbr/>Runner<wbr/>Props</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CreateRunnerProps.html#logger" class="tsd-kind-icon">logger</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CreateRunnerProps.html#options" class="tsd-kind-icon">options</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
Loading

0 comments on commit 97bfd4b

Please sign in to comment.