Skip to content

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.

docs: do not document deprecated options like `handlePageFunction`

Martin Adámekec1e0d2f2b63
diff --git a/packages/basic-crawler/src/internals/basic-crawler.ts b/packages/basic-crawler/src/internals/basic-crawler.ts
index 49ce30e2b..ba744364f 100644
--- a/packages/basic-crawler/src/internals/basic-crawler.ts
+++ b/packages/basic-crawler/src/internals/basic-crawler.ts
@@ -101,6 +101,7 @@ export interface BasicCrawlerOptions<Context extends CrawlingContext = BasicCraw
* {@link Request.pushErrorMessage|`Request.pushErrorMessage()`} function.
*
* @deprecated `handleRequestFunction` has been renamed to `requestHandler` and will be removed in a future version.
+ * @ignore
*/
handleRequestFunction?: RequestHandler<Context>;
@@ -130,6 +131,7 @@ export interface BasicCrawlerOptions<Context extends CrawlingContext = BasicCraw
* Timeout in which the function passed as {@link BasicCrawlerOptions.requestHandler|`requestHandler`} needs to finish, in seconds.
* @default 60
* @deprecated `handleRequestTimeoutSecs` has been renamed to `requestHandlerTimeoutSecs` and will be removed in a future version.
+ * @ignore
*/
handleRequestTimeoutSecs?: number;
@@ -163,6 +165,7 @@ export interface BasicCrawlerOptions<Context extends CrawlingContext = BasicCraw
* represents the last error thrown during processing of the request.
*
* @deprecated `handleFailedRequestFunction` has been renamed to `failedRequestHandler` and will be removed in a future version.
+ * @ignore
*/
handleFailedRequestFunction?: FailedRequestHandler<Context>;
diff --git a/packages/browser-crawler/src/internals/browser-crawler.ts b/packages/browser-crawler/src/internals/browser-crawler.ts
index f5946a13b..b3cd80cab 100644
--- a/packages/browser-crawler/src/internals/browser-crawler.ts
+++ b/packages/browser-crawler/src/internals/browser-crawler.ts
@@ -146,6 +146,7 @@ export interface BrowserCrawlerOptions<
* {@link Request.pushErrorMessage|`Request.pushErrorMessage()`} function.
*
* @deprecated `handlePageFunction` has been renamed to `requestHandler` and will be removed in a future version.
+ * @ignore
*/
handlePageFunction?: BrowserCrawlerHandleRequest<Context>;
@@ -182,6 +183,7 @@ export interface BrowserCrawlerOptions<
* represents the last error thrown during processing of the request.
*
* @deprecated `handleFailedRequestFunction` has been renamed to `failedRequestHandler` and will be removed in a future version.
+ * @ignore
*/
handleFailedRequestFunction?: BrowserCrawlerHandleFailedRequest<Context>;
diff --git a/packages/cheerio-crawler/src/internals/cheerio-crawler.ts b/packages/cheerio-crawler/src/internals/cheerio-crawler.ts
index bae755640..191d3c4fd 100644
--- a/packages/cheerio-crawler/src/internals/cheerio-crawler.ts
+++ b/packages/cheerio-crawler/src/internals/cheerio-crawler.ts
@@ -125,6 +125,7 @@ export interface CheerioCrawlerOptions<JSONData = Dictionary> extends Omit<Basic
* {@link Request.pushErrorMessage} function.
*
* @deprecated `handlePageFunction` has been renamed to `requestHandler` and will be removed in a future version.
+ * @ignore
*/
handlePageFunction?: CheerioRequestHandler<JSONData>;
@@ -181,6 +182,7 @@ export interface CheerioCrawlerOptions<JSONData = Dictionary> extends Omit<Basic
* for the default implementation of this function.
*
* @deprecated `handleFailedRequestFunction` has been renamed to `failedRequestHandler` and will be removed in a future version.
+ * @ignore
*/
handleFailedRequestFunction?: CheerioFailedRequestHandler<JSONData>;
diff --git a/packages/playwright-crawler/src/internals/playwright-crawler.ts b/packages/playwright-crawler/src/internals/playwright-crawler.ts
index 76aa2d178..9e484f639 100644
--- a/packages/playwright-crawler/src/internals/playwright-crawler.ts
+++ b/packages/playwright-crawler/src/internals/playwright-crawler.ts
@@ -77,6 +77,7 @@ export interface PlaywrightCrawlerOptions extends BrowserCrawlerOptions<
* {@link Request.pushErrorMessage} function.
*
* @deprecated `handlePageFunction` has been renamed to `requestHandler` and will be removed in a future version.
+ * @ignore
*/
handlePageFunction?: PlaywrightRequestHandler;