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
Build docs
Ondra Urbandfb346a66fee
diff --git a/docs/api/BasicCrawler.md b/docs/api/BasicCrawler.mdindex 6f54b77fd..86c5ee368 100644--- a/docs/api/BasicCrawler.md+++ b/docs/api/BasicCrawler.md@@ -91,8 +91,7 @@ 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.@@ -127,8 +126,7 @@ 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/basic_crawler.js#L11" target="_blank">source code</a>diff --git a/docs/api/CheerioCrawler.md b/docs/api/CheerioCrawler.mdindex 6926febe8..0d4160221 100644--- a/docs/api/CheerioCrawler.md+++ b/docs/api/CheerioCrawler.md@@ -108,8 +108,7 @@ 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.@@ -147,8 +146,7 @@ await crawler.run();payload, // Are 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>@@ -157,8 +155,7 @@ 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@@ -219,8 +216,7 @@ 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/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 d9c2a5221..059741515 100644--- a/docs/api/PuppeteerCrawler.md+++ b/docs/api/PuppeteerCrawler.md@@ -99,8 +99,7 @@ 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>@@ -154,8 +153,7 @@ 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/puppeteer_crawler.js#L11" target="_blank">source code</a>diff --git a/docs/api/Request.md b/docs/api/Request.mdindex a3edbc7a0..dd98f518a 100644--- a/docs/api/Request.md+++ b/docs/api/Request.md@@ -165,8 +165,7 @@ 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 1ab1e2a6b..c69017d52 100644--- a/docs/api/RequestList.md+++ b/docs/api/RequestList.md@@ -110,8 +110,7 @@ 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>@@ -139,8 +138,7 @@ 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/utils.md b/docs/api/utils.mdindex 9a74c6e43..a8e2cc911 100644--- a/docs/api/utils.md+++ b/docs/api/utils.md@@ -127,19 +127,16 @@ await Apify.utils.enqueueLinks({{name: 'John',surname: 'Doe',-}-</code></pre><pre><code>// userData+}</code></pre><pre><code>// userData{name: 'Albert',age: 31-}-</code></pre><pre><code>// Enqueued request.userData+}</code></pre><pre><code>// Enqueued request.userData{name: 'Albert',surname: 'Doe',age: 31,-}-</code></pre></td></tr></tbody>+}</code></pre></td></tr></tbody></table><a name="utils.sleep"></a>diff --git a/docs/typedefs/ActorRun.md b/docs/typedefs/ActorRun.mdindex 9bf68d855..3e79ac0fa 100644--- a/docs/typedefs/ActorRun.md+++ b/docs/typedefs/ActorRun.md@@ -57,8 +57,7 @@ For more details, see"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>@@ -67,8 +66,7 @@ For more details, see"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>@@ -79,8 +77,7 @@ For more details, see"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>@@ -132,6 +129,5 @@ For more details, see"body": {"message": "Hello world!"}- }-</code></pre></td></tr></tbody>+ }</code></pre></td></tr></tbody></table>