@crawlee/core 3.13.3-beta.11 → 3.13.3-beta.13

package/storages/request_queue.js

@@ -19,17 +19,17 @@ const RECENTLY_HANDLED_CACHE_SIZE = 1000;
  * where you start with several URLs and then recursively
  * follow links to other pages. The data structure supports both breadth-first and depth-first crawling orders.
  *
- * Each URL is represented using an instance of the {@apilink Request} class.
- * The queue can only contain unique URLs. More precisely, it can only contain {@apilink Request} instances
+ * Each URL is represented using an instance of the {@link Request} class.
+ * The queue can only contain unique URLs. More precisely, it can only contain {@link Request} instances
  * with distinct `uniqueKey` properties. By default, `uniqueKey` is generated from the URL, but it can also be overridden.
  * To add a single URL multiple times to the queue,
- * corresponding {@apilink Request} objects will need to have different `uniqueKey` properties.
+ * corresponding {@link Request} objects will need to have different `uniqueKey` properties.
  *
- * Do not instantiate this class directly, use the {@apilink RequestQueue.open} function instead.
+ * Do not instantiate this class directly, use the {@link RequestQueue.open} function instead.
  *
- * `RequestQueue` is used by {@apilink BasicCrawler}, {@apilink CheerioCrawler}, {@apilink PuppeteerCrawler}
- * and {@apilink PlaywrightCrawler} as a source of URLs to crawl.
- * Unlike {@apilink RequestList}, `RequestQueue` supports dynamic adding and removing of requests.
+ * `RequestQueue` is used by {@link BasicCrawler}, {@link CheerioCrawler}, {@link PuppeteerCrawler}
+ * and {@link PlaywrightCrawler} as a source of URLs to crawl.
+ * Unlike {@link RequestList}, `RequestQueue` supports dynamic adding and removing of requests.
  * On the other hand, the queue is not optimized for operations that add or remove a large number of URLs in a batch.
  *
  * `RequestQueue` stores its data either on local disk or in the Apify Cloud,
@@ -41,7 +41,7 @@ const RECENTLY_HANDLED_CACHE_SIZE = 1000;
  * If the `APIFY_TOKEN` environment variable is set but `APIFY_LOCAL_STORAGE_DIR` is not, the data is stored in the
  * [Apify Request Queue](https://docs.apify.com/storage/request-queue)
  * cloud storage. Note that you can force usage of the cloud storage also by passing the `forceCloud`
- * option to {@apilink RequestQueue.open} function,
+ * option to {@link RequestQueue.open} function,
  * even if the `APIFY_LOCAL_STORAGE_DIR` variable is set.
  *
  * **Example usage:**
@@ -60,7 +60,7 @@ const RECENTLY_HANDLED_CACHE_SIZE = 1000;
  * ```
  * @category Sources
  *
- * @deprecated RequestQueue v1 is deprecated and will be removed in the future. Please use {@apilink RequestQueue} instead.
+ * @deprecated RequestQueue v1 is deprecated and will be removed in the future. Please use {@link RequestQueue} instead.
  */
 class RequestQueue extends request_provider_1.RequestProvider {
     /**
@@ -96,15 +96,15 @@ class RequestQueue extends request_provider_1.RequestProvider {
      * Returns a next request in the queue to be processed, or `null` if there are no more pending requests.
      *
      * Once you successfully finish processing of the request, you need to call
-     * {@apilink RequestQueue.markRequestHandled}
+     * {@link RequestQueue.markRequestHandled}
      * to mark the request as handled in the queue. If there was some error in processing the request,
-     * call {@apilink RequestQueue.reclaimRequest} instead,
+     * call {@link RequestQueue.reclaimRequest} instead,
      * so that the queue will give the request to some other consumer in another call to the `fetchNextRequest` function.
      *
      * Note that the `null` return value doesn't mean the queue processing finished,
      * it means there are currently no pending requests.
      * To check whether all requests in queue were finished,
-     * use {@apilink RequestQueue.isFinished} instead.
+     * use {@link RequestQueue.isFinished} instead.
      *
      * @returns
      *   Returns the request object or `null` if there are no more pending requests.
@@ -273,7 +273,7 @@ class RequestQueue extends request_provider_1.RequestProvider {
     }
     /**
      * Reclaims a failed request back to the queue, so that it can be returned for processing later again
-     * by another call to {@apilink RequestQueue.fetchNextRequest}.
+     * by another call to {@link RequestQueue.fetchNextRequest}.
      * The request record in the queue is updated using the provided `request` parameter.
      * For example, this lets you store the number of retries or error messages for the request.
      */
@@ -311,14 +311,14 @@ class RequestQueue extends request_provider_1.RequestProvider {
     }
     /**
      * Opens a request queue and returns a promise resolving to an instance
-     * of the {@apilink RequestQueue} class.
+     * of the {@link RequestQueue} class.
      *
-     * {@apilink RequestQueue} represents a queue of URLs to crawl, which is stored either on local filesystem or in the cloud.
+     * {@link RequestQueue} represents a queue of URLs to crawl, which is stored either on local filesystem or in the cloud.
      * The queue is used for deep crawling of websites, where you start with several URLs and then
      * recursively follow links to other pages. The data structure supports both breadth-first
      * and depth-first crawling orders.
      *
-     * For more details and code examples, see the {@apilink RequestQueue} class.
+     * For more details and code examples, see the {@link RequestQueue} class.
      *
      * @param [queueIdOrName]
      *   ID or name of the request queue to be opened. If `null` or `undefined`,

package/storages/request_queue_v2.d.ts

@@ -8,17 +8,17 @@ import { RequestProvider } from './request_provider';
  * where you start with several URLs and then recursively
  * follow links to other pages. The data structure supports both breadth-first and depth-first crawling orders.
  *
- * Each URL is represented using an instance of the {@apilink Request} class.
- * The queue can only contain unique URLs. More precisely, it can only contain {@apilink Request} instances
+ * Each URL is represented using an instance of the {@link Request} class.
+ * The queue can only contain unique URLs. More precisely, it can only contain {@link Request} instances
  * with distinct `uniqueKey` properties. By default, `uniqueKey` is generated from the URL, but it can also be overridden.
  * To add a single URL multiple times to the queue,
- * corresponding {@apilink Request} objects will need to have different `uniqueKey` properties.
+ * corresponding {@link Request} objects will need to have different `uniqueKey` properties.
  *
- * Do not instantiate this class directly, use the {@apilink RequestQueue.open} function instead.
+ * Do not instantiate this class directly, use the {@link RequestQueue.open} function instead.
  *
- * `RequestQueue` is used by {@apilink BasicCrawler}, {@apilink CheerioCrawler}, {@apilink PuppeteerCrawler}
- * and {@apilink PlaywrightCrawler} as a source of URLs to crawl.
- * Unlike {@apilink RequestList}, `RequestQueue` supports dynamic adding and removing of requests.
+ * `RequestQueue` is used by {@link BasicCrawler}, {@link CheerioCrawler}, {@link PuppeteerCrawler}
+ * and {@link PlaywrightCrawler} as a source of URLs to crawl.
+ * Unlike {@link RequestList}, `RequestQueue` supports dynamic adding and removing of requests.
  * On the other hand, the queue is not optimized for operations that add or remove a large number of URLs in a batch.
  *
  * **Example usage:**

package/storages/request_queue_v2.js

@@ -18,17 +18,17 @@ const RECENTLY_HANDLED_CACHE_SIZE = 1000;
  * where you start with several URLs and then recursively
  * follow links to other pages. The data structure supports both breadth-first and depth-first crawling orders.
  *
- * Each URL is represented using an instance of the {@apilink Request} class.
- * The queue can only contain unique URLs. More precisely, it can only contain {@apilink Request} instances
+ * Each URL is represented using an instance of the {@link Request} class.
+ * The queue can only contain unique URLs. More precisely, it can only contain {@link Request} instances
  * with distinct `uniqueKey` properties. By default, `uniqueKey` is generated from the URL, but it can also be overridden.
  * To add a single URL multiple times to the queue,
- * corresponding {@apilink Request} objects will need to have different `uniqueKey` properties.
+ * corresponding {@link Request} objects will need to have different `uniqueKey` properties.
  *
- * Do not instantiate this class directly, use the {@apilink RequestQueue.open} function instead.
+ * Do not instantiate this class directly, use the {@link RequestQueue.open} function instead.
  *
- * `RequestQueue` is used by {@apilink BasicCrawler}, {@apilink CheerioCrawler}, {@apilink PuppeteerCrawler}
- * and {@apilink PlaywrightCrawler} as a source of URLs to crawl.
- * Unlike {@apilink RequestList}, `RequestQueue` supports dynamic adding and removing of requests.
+ * `RequestQueue` is used by {@link BasicCrawler}, {@link CheerioCrawler}, {@link PuppeteerCrawler}
+ * and {@link PlaywrightCrawler} as a source of URLs to crawl.
+ * Unlike {@link RequestList}, `RequestQueue` supports dynamic adding and removing of requests.
  * On the other hand, the queue is not optimized for operations that add or remove a large number of URLs in a batch.
  *
  * **Example usage:**

package/storages/utils.d.ts

@@ -16,7 +16,7 @@ interface PurgeDefaultStorageOptions {
  * Purging will remove all the files in all storages except for INPUT.json in the default KV store.
  *
  * Purging of storages is happening automatically when we run our crawler (or when we open some storage
- * explicitly, e.g. via `RequestList.open()`). We can disable that via `purgeOnStart` {@apilink Configuration}
+ * explicitly, e.g. via `RequestList.open()`). We can disable that via `purgeOnStart` {@link Configuration}
  * option or by setting `CRAWLEE_PURGE_ON_START` environment variable to `0` or `false`.
  *
  * This is a shortcut for running (optional) `purge` method on the StorageClient interface, in other words
@@ -30,7 +30,7 @@ export declare function purgeDefaultStorages(options?: PurgeDefaultStorageOption
  * Purging will remove all the files in all storages except for INPUT.json in the default KV store.
  *
  * Purging of storages is happening automatically when we run our crawler (or when we open some storage
- * explicitly, e.g. via `RequestList.open()`). We can disable that via `purgeOnStart` {@apilink Configuration}
+ * explicitly, e.g. via `RequestList.open()`). We can disable that via `purgeOnStart` {@link Configuration}
  * option or by setting `CRAWLEE_PURGE_ON_START` environment variable to `0` or `false`.
  *
  * This is a shortcut for running (optional) `purge` method on the StorageClient interface, in other words