Crawlee—A web scraping and browser automation library for Node.js to build reliable crawlers. In JavaScript and TypeScript. Extract data for AI, LLMs, RAG, or GPTs. Download HTML, PDF, JPG, PNG, and other files from websites. Works with Puppeteer, Playwright, Cheerio, JSDOM, and raw HTTP. Both headful and headless mode. With proxy rotation.
TypeScript apifyautomationcrawlercrawlingheadlessheadless-chromejavascriptnodejsnpmplaywrightpuppeteerscraperscrapingtypescriptweb-crawlerweb-crawlingweb-scraping
Regenerated docs
Jan Curn14418f6727ef
diff --git a/docs/api/BasicCrawler.md b/docs/api/BasicCrawler.mdindex 9b642a394..022050446 100644--- a/docs/api/BasicCrawler.md+++ b/docs/api/BasicCrawler.md@@ -84,7 +84,8 @@ await crawler.run();<pre><code>{request: Request,autoscaledPool: AutoscaledPool-}</code></pre><p> where the <a href="request"><code>Request</code></a> instance represents the URL to crawl.</p>+}+</code></pre><p> where the <a href="request"><code>Request</code></a> instance represents the URL to crawl.</p><p> The function must return a promise, which is then awaited by the crawler.</p><p> If the function throws an exception, the crawler will try to re-crawl therequest later, up to <code>option.maxRequestRetries</code> times.@@ -120,7 +121,8 @@ await crawler.run();<pre><code>{request: Request,error: Error,-}</code></pre><p> where the <a href="request"><code>Request</code></a> instance corresponds to the failed request, and the <code>Error</code> instance+}+</code></pre><p> where the <a href="request"><code>Request</code></a> instance corresponds to the failed request, and the <code>Error</code> instancerepresents the last error thrown during processing of the request.</p><p> See<a href="https://github.com/apifytech/apify-js/blob/master/src/crawlers/basic_crawler.js#L11" target="_blank">source code</a>diff --git a/docs/api/CheerioCrawler.md b/docs/api/CheerioCrawler.mdindex 54ee3c72f..a2743798d 100644--- a/docs/api/CheerioCrawler.md+++ b/docs/api/CheerioCrawler.md@@ -105,7 +105,8 @@ await crawler.run();request: Request,response: Object // An instance of Node's http.IncomingMessage object,autoscaledPool: AutoscaledPool-}</code></pre><p> With the <a href="request"><code>Request</code></a> object representing the URL to crawl.</p>+}+</code></pre><p> With the <a href="request"><code>Request</code></a> object representing the URL to crawl.</p><p> If the function returns a promise, it is awaited by the crawler.</p><p> If the function throws an exception, the crawler will try to re-crawl therequest later, up to <code>option.maxRequestRetries</code> times.@@ -146,7 +147,8 @@ await crawler.run();payload, // Provided by RequestList and/or RequestQueuestrictSSL, // Use options.ignoreSslErrorsproxy, // Use options.useApifyProxy or options.proxyUrls- }</code></pre></td></tr><tr>+ }+</code></pre></td></tr><tr><td><code>[options.prepareRequestFunction]</code></td><td><code>function</code></td><td></td></tr><tr>@@ -155,7 +157,8 @@ await crawler.run();<p> The function receives the following object as an argument:</p><pre><code>{request: Request-}</code></pre><p> where the <a href="request"><code>Request</code></a> instance corresponds to the initialized request.</p>+}+</code></pre><p> where the <a href="request"><code>Request</code></a> instance corresponds to the initialized request.</p><p> The function should modify the properties of the passed <a href="request"><code>Request</code></a> instancein place because there are already earlier references to it. Making a copy and returning it fromthis function is therefore not supported, because it would create inconsistencies where@@ -216,7 +219,8 @@ await crawler.run();<pre><code>{request: Request,error: Error,-}</code></pre><p> where the <a href="request"><code>Request</code></a> instance corresponds to the failed request, and the <code>Error</code> instance+}+</code></pre><p> where the <a href="request"><code>Request</code></a> instance corresponds to the failed request, and the <code>Error</code> instancerepresents the last error thrown during processing of the request.</p><p> See <a href="https://github.com/apifytech/apify-js/blob/master/src/crawlers/cheerio_crawler.js#L13">source code</a>for the default implementation of this function.</p>diff --git a/docs/api/PuppeteerCrawler.md b/docs/api/PuppeteerCrawler.mdindex 14059d499..1bb368f22 100644--- a/docs/api/PuppeteerCrawler.md+++ b/docs/api/PuppeteerCrawler.md@@ -94,7 +94,8 @@ await crawler.run();page: Page,puppeteerPool: PuppeteerPool,autoscaledPool: AutoscaledPool-}</code></pre><p> <code>request</code> is an instance of the <a href="request"><code>Request</code></a> object with details about the URL to open, HTTP method etc.+}+</code></pre><p> <code>request</code> is an instance of the <a href="request"><code>Request</code></a> object with details about the URL to open, HTTP method etc.<code>response</code> is an instance of the <code>Puppeteer</code><a href="https://pptr.dev/#?product=Puppeteer&show=api-class-page" target="_blank"><code>Page</code></a><code>page</code> is an instance of the <code>Puppeteer</code>@@ -155,7 +156,8 @@ await crawler.run();<pre><code>{request: Request,error: Error,-}</code></pre><p> Where the <a href="request"><code>Request</code></a> instance corresponds to the failed request, and the <code>Error</code> instance+}+</code></pre><p> Where the <a href="request"><code>Request</code></a> instance corresponds to the failed request, and the <code>Error</code> instancerepresents the last error thrown during processing of the request.</p><p> See<a href="https://github.com/apifytech/apify-js/blob/master/src/crawlers/puppeteer_crawler.js#L301" target="_blank">source code</a>diff --git a/docs/api/Request.md b/docs/api/Request.mdindex 808308a20..dc9b4c48c 100644--- a/docs/api/Request.md+++ b/docs/api/Request.md@@ -166,7 +166,8 @@ to override the default behavior and specify which URLs shall be considered equa<pre><code> {Accept: 'text/html','Content-Type': 'application/json'- }</code></pre></td></tr><tr>+ }+</code></pre></td></tr><tr><td><code>[options.userData]</code></td><td><code>Object</code></td><td><code>{}</code></td></tr><tr>diff --git a/docs/api/RequestList.md b/docs/api/RequestList.mdindex c98df283f..2b19689ec 100644--- a/docs/api/RequestList.md+++ b/docs/api/RequestList.md@@ -104,7 +104,8 @@ await requestList.reclaimRequest(request2);{ method: 'GET', url: 'http://example.com/a/b' },// Batch import of URLs from a file hosted on the web{ method: 'POST', requestsFromUrl: 'http://example.com/urls.txt' },-]</code></pre></td></tr><tr>+]+</code></pre></td></tr><tr><td><code>[options.persistStateKey]</code></td><td><code>String</code></td><td></td></tr><tr>@@ -132,7 +133,8 @@ await requestList.reclaimRequest(request2);'unique-key-1': true,'unique-key-4': true,},-}</code></pre><p> Note that the preferred (and simpler) way to persist the state of crawling of the <code>RequestList</code>+}+</code></pre><p> Note that the preferred (and simpler) way to persist the state of crawling of the <code>RequestList</code>is to use the <code>stateKeyPrefix</code> parameter instead.</p></td></tr><tr><td><code>[options.keepDuplicateUrls]</code></td><td><code>Boolean</code></td><td><code>false</code></td>diff --git a/docs/api/puppeteer.md b/docs/api/puppeteer.mdindex 668b15278..5c17b96cb 100644--- a/docs/api/puppeteer.md+++ b/docs/api/puppeteer.md@@ -135,13 +135,14 @@ objects.a combination of <code>url</code>, <code>method</code> and <code>payload</code> which enables crawling of websites that navigate using form submits(POST requests).</p><p> <strong>Example:</strong></p>-<pre><code class="language-javascript"> {+<pre><code class="lang-javascript"> {transformRequestFunction: (request) => {request.userData.foo = 'bar';request.useExtendedUniqueKey = true;return request;}- }</code></pre>+ }+</code></pre></td></tr><tr><td><code>[options.waitForPageIdleSecs]</code></td><td><code>number</code></td><td><code>1</code></td></tr>diff --git a/docs/api/utils.md b/docs/api/utils.mdindex 08cb1dc18..6163a4f48 100644--- a/docs/api/utils.md+++ b/docs/api/utils.md@@ -126,13 +126,14 @@ objects.<p> For example: by adding <code>keepUrlFragment: true</code> to the <code>request</code> object, URL fragments will not be removedwhen <code>uniqueKey</code> is computed.</p><p> <strong>Example:</strong></p>-<pre><code class="language-javascript"> {+<pre><code class="lang-javascript"> {transformRequestFunction: (request) => {request.userData.foo = 'bar';request.keepUrlFragment = true;return request;}- }</code></pre>+ }+</code></pre></td></tr></tbody></table><a name="utils.requestAsBrowser"></a>@@ -196,7 +197,7 @@ request. All `options` not recognized by this function are passed to it, so see<tr><td colspan="3"><p>Function accepts <code>response</code> object as a single parameter and should return true or false.If function returns true request gets aborted. This function is passed to the- (@apify/http-request)[<a href="https://www.npmjs.com/package/@apify/http-request">https://www.npmjs.com/package/@apify/http-request]</a> NPM package.</p>+ (@apify/http-request)[<a href="https://www.npmjs.com/package/@apify/http-request]">https://www.npmjs.com/package/@apify/http-request]</a> NPM package.</p></td></tr></tbody></table><a name="utils.sleep"></a>diff --git a/docs/typedefs/ActorRun.md b/docs/typedefs/ActorRun.mdindex 571bffacc..d3cee5406 100644--- a/docs/typedefs/ActorRun.md+++ b/docs/typedefs/ActorRun.md@@ -55,7 +55,8 @@ certain fields. For more details, see <a href="https://apify.com/docs/actor#run""origin": "API","clientIp": "1.2.3.4","userAgent": "ApifyClient/0.2.13 (Linux; Node/v8.11.3)"- }</code></pre></td></tr><tr>+ }+</code></pre></td></tr><tr><td><code>stats</code></td><td><code>Object</code></td></tr><tr>@@ -64,7 +65,8 @@ certain fields. For more details, see <a href="https://apify.com/docs/actor#run""inputBodyLen": 22,"restartCount": 0,"workersUsed": 1,- }</code></pre><p> Beware that object fields might change in future releases.</p>+ }+</code></pre><p> Beware that object fields might change in future releases.</p></td></tr><tr><td><code>options</code></td><td><code>Object</code></td></tr>@@ -75,7 +77,8 @@ certain fields. For more details, see <a href="https://apify.com/docs/actor#run""waitSecs": 0,"memoryMbytes": 256,"diskMbytes": 512- }</code></pre></td></tr><tr>+ }+</code></pre></td></tr><tr><td><code>buildId</code></td><td><code>String</code></td></tr><tr>@@ -127,5 +130,6 @@ certain fields. For more details, see <a href="https://apify.com/docs/actor#run""body": {"message": "Hello world!"}- }</code></pre></td></tr></tbody>+ }+</code></pre></td></tr></tbody></table>