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: fix `enqueueLinks` documentation on option interactions (#3057)

Jindřich Bär136e3adbb03d
diff --git a/packages/core/src/enqueue_links/enqueue_links.ts b/packages/core/src/enqueue_links/enqueue_links.ts
index 6a87e1173..97c51d6ba 100644
--- a/packages/core/src/enqueue_links/enqueue_links.ts
+++ b/packages/core/src/enqueue_links/enqueue_links.ts
@@ -47,7 +47,12 @@ export interface EnqueueLinksOptions extends RequestQueueOperationOptions {
/** Sets {@apilink Request.userData} for newly enqueued requests. */
userData?: Dictionary;
- /** Sets {@apilink Request.label} for newly enqueued requests. */
+ /**
+ * Sets {@apilink Request.label} for newly enqueued requests.
+ *
+ * Note that the request options specified in `globs`, `regexps`, or `pseudoUrls` objects
+ * have priority over this option.
+ */
label?: string;
/**
@@ -141,9 +146,8 @@ export interface EnqueueLinksOptions extends RequestQueueOperationOptions {
* }
* ```
*
- * Note that `transformRequestFunction` has a priority over request options
- * specified in `globs`, `regexps`, or `pseudoUrls` objects,
- * and thus some options could be over-written by `transformRequestFunction`.
+ * Note that the request options specified in `globs`, `regexps`, or `pseudoUrls` objects
+ * have priority over this function. Some request options returned by `transformRequestFunction` may be overwritten by pattern-based options from `globs`, `regexps`, or `pseudoUrls`.
*/
transformRequestFunction?: RequestTransform;