@crawlee/core 3.0.3-beta.7 → 3.0.3

package/storages/request_list.d.ts

@@ -9,8 +9,8 @@ export declare const STATE_PERSISTENCE_KEY = "REQUEST_LIST_STATE";
 export declare const REQUESTS_PERSISTENCE_KEY = "REQUEST_LIST_REQUESTS";
 export interface RequestListOptions {
     /**
-     * An array of sources of URLs for the {@link RequestList}. It can be either an array of strings,
-     * plain objects that define at least the `url` property, or an array of {@link Request} instances.
+     * An array of sources of URLs for the {@apilink RequestList}. It can be either an array of strings,
+     * plain objects that define at least the `url` property, or an array of {@apilink Request} instances.
      *
      * **IMPORTANT:** The `sources` array will be consumed (left empty) after `RequestList` initializes.
      * This is a measure to prevent memory leaks in situations when millions of sources are
@@ -44,15 +44,15 @@ export interface RequestListOptions {
     sources?: Source[];
     /**
      * A function that will be called to get the sources for the `RequestList`, but only if `RequestList`
-     * was not able to fetch their persisted version (see {@link RequestListOptions.persistRequestsKey}).
-     * It must return an `Array` of {@link Request} or {@link RequestOptions}.
+     * was not able to fetch their persisted version (see {@apilink RequestListOptions.persistRequestsKey}).
+     * It must return an `Array` of {@apilink Request} or {@apilink RequestOptions}.
      *
      * This is very useful in a scenario when getting the sources is a resource intensive or time consuming
      * task, such as fetching URLs from multiple sitemaps or parsing URLs from large datasets. Using the
      * `sourcesFunction` in combination with `persistStateKey` and `persistRequestsKey` will allow you to
      * fetch and parse those URLs only once, saving valuable time when your crawler migrates or restarts.
      *
-     * If both {@link RequestListOptions.sources} and {@link RequestListOptions.sourcesFunction} are provided,
+     * If both {@apilink RequestListOptions.sources} and {@apilink RequestListOptions.sourcesFunction} are provided,
      * the sources returned by the function will be added after the `sources`.
      *
      * **Example:**
@@ -99,12 +99,12 @@ export interface RequestListOptions {
     persistStateKey?: string;
     /**
      * Identifies the key in the default key-value store under which the `RequestList` persists its
-     * Requests during the {@link RequestList.initialize} call.
+     * Requests during the {@apilink RequestList.initialize} call.
      * This is necessary if `persistStateKey` is set and the source URLs might potentially change,
      * to ensure consistency of the source URLs and state object. However, it comes with some
      * storage and performance overheads.
      *
-     * If `persistRequestsKey` is not set, {@link RequestList.initialize} will always fetch the sources
+     * If `persistRequestsKey` is not set, {@apilink RequestList.initialize} will always fetch the sources
      * from their origin, check that they are consistent with the restored state (if any)
      * and throw an error if they are not.
      */
@@ -130,7 +130,7 @@ export interface RequestListOptions {
     state?: RequestListState;
     /**
      * By default, `RequestList` will deduplicate the provided URLs. Default deduplication is based
-     * on the `uniqueKey` property of passed source {@link Request} objects.
+     * on the `uniqueKey` property of passed source {@apilink Request} objects.
      *
      * If the property is not present, it is generated by normalizing the URL. If present, it is kept intact.
      * In any case, only one request per `uniqueKey` is added to the `RequestList` resulting in removal
@@ -150,19 +150,19 @@ export interface RequestListOptions {
 /**
  * Represents a static list of URLs to crawl.
  * The URLs can be provided either in code or parsed from a text file hosted on the web.
- * `RequestList` is used by {@link BasicCrawler}, {@link CheerioCrawler}, {@link PuppeteerCrawler}
- * and {@link PlaywrightCrawler} as a source of URLs to crawl.
+ * `RequestList` is used by {@apilink BasicCrawler}, {@apilink CheerioCrawler}, {@apilink PuppeteerCrawler}
+ * and {@apilink PlaywrightCrawler} as a source of URLs to crawl.
  *
- * Each URL is represented using an instance of the {@link Request} class.
+ * Each URL is represented using an instance of the {@apilink Request} class.
  * The list can only contain unique URLs. More precisely, it can only contain `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 to the list multiple times, corresponding {@link Request} objects will need to have different
+ * To add a single URL to the list multiple times, corresponding {@apilink Request} objects will need to have different
  * `uniqueKey` properties. You can use the `keepDuplicateUrls` option to do this for you when initializing the
  * `RequestList` from sources.
  *
- * Once you create an instance of `RequestList`, you need to call the {@link RequestList.initialize} function
+ * Once you create an instance of `RequestList`, you need to call the {@apilink RequestList.initialize} function
  * before the instance can be used. After that, no more URLs can be added to the list.
- * Unlike {@link RequestQueue}, `RequestList` is static but it can contain even millions of URLs.
+ * Unlike {@apilink RequestQueue}, `RequestList` is static but it can contain even millions of URLs.
  * > Note that `RequestList` can be used together with `RequestQueue` by the same crawler.
  * > In such cases, each request from `RequestList` is enqueued into `RequestQueue` first and then consumed from the latter.
  * > This is necessary to avoid the same URL being processed more than once (from the list first and then possibly from the queue).
@@ -171,9 +171,9 @@ export interface RequestListOptions {
  *
  * `RequestList` has an internal state where it stores information about which requests were already handled,
  * which are in progress and which were reclaimed. The state may be automatically persisted to the default
- * {@link KeyValueStore} by setting the `persistStateKey` option so that if the Node.js process is restarted,
+ * {@apilink KeyValueStore} by setting the `persistStateKey` option so that if the Node.js process is restarted,
  * the crawling can continue where it left off. The automated persisting is launched upon receiving the `persistState`
- * event that is periodically emitted by {@link EventManager}.
+ * event that is periodically emitted by {@apilink EventManager}.
  *
  * The internal state is closely tied to the provided sources (URLs). If the sources change on crawler restart, the state will become corrupted and
  * `RequestList` will raise an exception. This typically happens when the sources is a list of URLs downloaded from the web.
@@ -279,7 +279,7 @@ export declare class RequestList {
      */
     protected _addRequestsFromSources(): Promise<void>;
     /**
-     * Persists the current state of the `RequestList` into the default {@link KeyValueStore}.
+     * Persists the current state of the `RequestList` into the default {@apilink KeyValueStore}.
      * The state is persisted automatically in regular intervals, but calling this method manually
      * is useful in cases where you want to have the most current state available after you pause
      * or stop fetching its requests. For example after you pause or abort a crawl. Or just before
@@ -307,7 +307,7 @@ export declare class RequestList {
      */
     getState(): RequestListState;
     /**
-     * Resolves to `true` if the next call to {@link RequestList.fetchNextRequest} function
+     * Resolves to `true` if the next call to {@apilink RequestList.fetchNextRequest} function
      * would return `null`, otherwise it resolves to `false`.
      * Note that even if the list is empty, there might be some pending requests currently being processed.
      */
@@ -317,8 +317,8 @@ export declare class RequestList {
      */
     isFinished(): Promise<boolean>;
     /**
-     * Gets the next {@link Request} to process. First, the function gets a request previously reclaimed
-     * using the {@link RequestList.reclaimRequest} function, if there is any.
+     * Gets the next {@apilink Request} to process. First, the function gets a request previously reclaimed
+     * using the {@apilink RequestList.reclaimRequest} function, if there is any.
      * Otherwise it gets the next request from sources.
      *
      * The function's `Promise` resolves to `null` if there are no more
@@ -372,14 +372,14 @@ export declare class RequestList {
     handledCount(): number;
     /**
      * Opens a request list and returns a promise resolving to an instance
-     * of the {@link RequestList} class that is already initialized.
+     * of the {@apilink RequestList} class that is already initialized.
      *
-     * {@link RequestList} represents a list of URLs to crawl, which is always stored in memory.
+     * {@apilink RequestList} represents a list of URLs to crawl, which is always stored in memory.
      * To enable picking up where left off after a process restart, the request list sources
      * are persisted to the key-value store at initialization of the list. Then, while crawling,
      * a small state object is regularly persisted to keep track of the crawling status.
      *
-     * For more details and code examples, see the {@link RequestList} class.
+     * For more details and code examples, see the {@apilink RequestList} class.
      *
      * **Example usage:**
      *
@@ -405,23 +405,23 @@ export declare class RequestList {
      *   If `null`, the list will not be persisted and will only be stored in memory. Process restart
      *   will then cause the list to be crawled again from the beginning. We suggest always using a name.
      * @param [sources]
-     *  An array of sources of URLs for the {@link RequestList}. It can be either an array of strings,
-     *  plain objects that define at least the `url` property, or an array of {@link Request} instances.
+     *  An array of sources of URLs for the {@apilink RequestList}. It can be either an array of strings,
+     *  plain objects that define at least the `url` property, or an array of {@apilink Request} instances.
      *
-     *  **IMPORTANT:** The `sources` array will be consumed (left empty) after {@link RequestList} initializes.
+     *  **IMPORTANT:** The `sources` array will be consumed (left empty) after {@apilink RequestList} initializes.
      *  This is a measure to prevent memory leaks in situations when millions of sources are
      *  added.
      *
      *  Additionally, the `requestsFromUrl` property may be used instead of `url`,
-     *  which will instruct {@link RequestList} to download the source URLs from a given remote location.
+     *  which will instruct {@apilink RequestList} to download the source URLs from a given remote location.
      *  The URLs will be parsed from the received response. In this case you can limit the URLs
      *  using `regex` parameter containing regular expression pattern for URLs to be included.
      *
-     *  For details, see the {@link RequestListOptions.sources}
+     *  For details, see the {@apilink RequestListOptions.sources}
      * @param [options]
-     *   The {@link RequestList} options. Note that the `listName` parameter supersedes
-     *   the {@link RequestListOptions.persistStateKey} and {@link RequestListOptions.persistRequestsKey}
-     *   options and the `sources` parameter supersedes the {@link RequestListOptions.sources} option.
+     *   The {@apilink RequestList} options. Note that the `listName` parameter supersedes
+     *   the {@apilink RequestListOptions.persistStateKey} and {@apilink RequestListOptions.persistRequestsKey}
+     *   options and the `sources` parameter supersedes the {@apilink RequestListOptions.sources} option.
      */
     static open(listNameOrOptions: string | null | RequestListOptions, sources?: Source[], options?: RequestListOptions): Promise<RequestList>;
     /**
@@ -430,8 +430,8 @@ export declare class RequestList {
     private _downloadListOfUrls;
 }
 /**
- * Represents state of a {@link RequestList}. It can be used to resume a {@link RequestList} which has been previously processed.
- * You can obtain the state by calling {@link RequestList.getState} and receive an object with
+ * Represents state of a {@apilink RequestList}. It can be used to resume a {@apilink RequestList} which has been previously processed.
+ * You can obtain the state by calling {@apilink RequestList.getState} and receive an object with
  * the following structure:
  *
  * ```

package/storages/request_list.js

@@ -18,19 +18,19 @@ const CONTENT_TYPE_BINARY = 'application/octet-stream';
 /**
  * Represents a static list of URLs to crawl.
  * The URLs can be provided either in code or parsed from a text file hosted on the web.
- * `RequestList` is used by {@link BasicCrawler}, {@link CheerioCrawler}, {@link PuppeteerCrawler}
- * and {@link PlaywrightCrawler} as a source of URLs to crawl.
+ * `RequestList` is used by {@apilink BasicCrawler}, {@apilink CheerioCrawler}, {@apilink PuppeteerCrawler}
+ * and {@apilink PlaywrightCrawler} as a source of URLs to crawl.
  *
- * Each URL is represented using an instance of the {@link Request} class.
+ * Each URL is represented using an instance of the {@apilink Request} class.
  * The list can only contain unique URLs. More precisely, it can only contain `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 to the list multiple times, corresponding {@link Request} objects will need to have different
+ * To add a single URL to the list multiple times, corresponding {@apilink Request} objects will need to have different
  * `uniqueKey` properties. You can use the `keepDuplicateUrls` option to do this for you when initializing the
  * `RequestList` from sources.
  *
- * Once you create an instance of `RequestList`, you need to call the {@link RequestList.initialize} function
+ * Once you create an instance of `RequestList`, you need to call the {@apilink RequestList.initialize} function
  * before the instance can be used. After that, no more URLs can be added to the list.
- * Unlike {@link RequestQueue}, `RequestList` is static but it can contain even millions of URLs.
+ * Unlike {@apilink RequestQueue}, `RequestList` is static but it can contain even millions of URLs.
  * > Note that `RequestList` can be used together with `RequestQueue` by the same crawler.
  * > In such cases, each request from `RequestList` is enqueued into `RequestQueue` first and then consumed from the latter.
  * > This is necessary to avoid the same URL being processed more than once (from the list first and then possibly from the queue).
@@ -39,9 +39,9 @@ const CONTENT_TYPE_BINARY = 'application/octet-stream';
  *
  * `RequestList` has an internal state where it stores information about which requests were already handled,
  * which are in progress and which were reclaimed. The state may be automatically persisted to the default
- * {@link KeyValueStore} by setting the `persistStateKey` option so that if the Node.js process is restarted,
+ * {@apilink KeyValueStore} by setting the `persistStateKey` option so that if the Node.js process is restarted,
  * the crawling can continue where it left off. The automated persisting is launched upon receiving the `persistState`
- * event that is periodically emitted by {@link EventManager}.
+ * event that is periodically emitted by {@apilink EventManager}.
  *
  * The internal state is closely tied to the provided sources (URLs). If the sources change on crawler restart, the state will become corrupted and
  * `RequestList` will raise an exception. This typically happens when the sources is a list of URLs downloaded from the web.
@@ -338,7 +338,7 @@ class RequestList {
         }
     }
     /**
-     * Persists the current state of the `RequestList` into the default {@link KeyValueStore}.
+     * Persists the current state of the `RequestList` into the default {@apilink KeyValueStore}.
      * The state is persisted automatically in regular intervals, but calling this method manually
      * is useful in cases where you want to have the most current state available after you pause
      * or stop fetching its requests. For example after you pause or abort a crawl. Or just before
@@ -463,7 +463,7 @@ class RequestList {
         };
     }
     /**
-     * Resolves to `true` if the next call to {@link RequestList.fetchNextRequest} function
+     * Resolves to `true` if the next call to {@apilink RequestList.fetchNextRequest} function
      * would return `null`, otherwise it resolves to `false`.
      * Note that even if the list is empty, there might be some pending requests currently being processed.
      */
@@ -479,8 +479,8 @@ class RequestList {
         return this.inProgress.size === 0 && this.nextIndex >= this.requests.length;
     }
     /**
-     * Gets the next {@link Request} to process. First, the function gets a request previously reclaimed
-     * using the {@link RequestList.reclaimRequest} function, if there is any.
+     * Gets the next {@apilink Request} to process. First, the function gets a request previously reclaimed
+     * using the {@apilink RequestList.reclaimRequest} function, if there is any.
      * Otherwise it gets the next request from sources.
      *
      * The function's `Promise` resolves to `null` if there are no more
@@ -650,14 +650,14 @@ class RequestList {
     }
     /**
      * Opens a request list and returns a promise resolving to an instance
-     * of the {@link RequestList} class that is already initialized.
+     * of the {@apilink RequestList} class that is already initialized.
      *
-     * {@link RequestList} represents a list of URLs to crawl, which is always stored in memory.
+     * {@apilink RequestList} represents a list of URLs to crawl, which is always stored in memory.
      * To enable picking up where left off after a process restart, the request list sources
      * are persisted to the key-value store at initialization of the list. Then, while crawling,
      * a small state object is regularly persisted to keep track of the crawling status.
      *
-     * For more details and code examples, see the {@link RequestList} class.
+     * For more details and code examples, see the {@apilink RequestList} class.
      *
      * **Example usage:**
      *
@@ -683,23 +683,23 @@ class RequestList {
      *   If `null`, the list will not be persisted and will only be stored in memory. Process restart
      *   will then cause the list to be crawled again from the beginning. We suggest always using a name.
      * @param [sources]
-     *  An array of sources of URLs for the {@link RequestList}. It can be either an array of strings,
-     *  plain objects that define at least the `url` property, or an array of {@link Request} instances.
+     *  An array of sources of URLs for the {@apilink RequestList}. It can be either an array of strings,
+     *  plain objects that define at least the `url` property, or an array of {@apilink Request} instances.
      *
-     *  **IMPORTANT:** The `sources` array will be consumed (left empty) after {@link RequestList} initializes.
+     *  **IMPORTANT:** The `sources` array will be consumed (left empty) after {@apilink RequestList} initializes.
      *  This is a measure to prevent memory leaks in situations when millions of sources are
      *  added.
      *
      *  Additionally, the `requestsFromUrl` property may be used instead of `url`,
-     *  which will instruct {@link RequestList} to download the source URLs from a given remote location.
+     *  which will instruct {@apilink RequestList} to download the source URLs from a given remote location.
      *  The URLs will be parsed from the received response. In this case you can limit the URLs
      *  using `regex` parameter containing regular expression pattern for URLs to be included.
      *
-     *  For details, see the {@link RequestListOptions.sources}
+     *  For details, see the {@apilink RequestListOptions.sources}
      * @param [options]
-     *   The {@link RequestList} options. Note that the `listName` parameter supersedes
-     *   the {@link RequestListOptions.persistStateKey} and {@link RequestListOptions.persistRequestsKey}
-     *   options and the `sources` parameter supersedes the {@link RequestListOptions.sources} option.
+     *   The {@apilink RequestList} options. Note that the `listName` parameter supersedes
+     *   the {@apilink RequestListOptions.persistStateKey} and {@apilink RequestListOptions.persistRequestsKey}
+     *   options and the `sources` parameter supersedes the {@apilink RequestListOptions.sources} option.
      */
     static async open(listNameOrOptions, sources, options = {}) {
         if (listNameOrOptions != null && typeof listNameOrOptions === 'object') {

package/storages/request_queue.d.ts

@@ -40,7 +40,7 @@ export declare const STORAGE_CONSISTENCY_DELAY_MILLIS = 3000;
 export declare function getRequestId(uniqueKey: string): string;
 /**
  * A helper class that is used to report results from various
- * {@link RequestQueue} functions as well as {@link enqueueLinks}.
+ * {@apilink RequestQueue} functions as well as {@apilink enqueueLinks}.
  */
 export interface QueueOperationInfo {
     /** Indicates if request was already present in the queue. */
@@ -56,7 +56,7 @@ export interface RequestQueueOperationOptions {
      * If set to `true`:
      *   - while adding the request to the queue: the request will be added to the foremost position in the queue.
      *   - while reclaiming the request: the request will be placed to the beginning of the queue, so that it's returned
-     *   in the next call to {@link RequestQueue.fetchNextRequest}.
+     *   in the next call to {@apilink RequestQueue.fetchNextRequest}.
      * By default, it's put to the end of the queue.
      * @default false
      */
@@ -67,17 +67,17 @@ export interface RequestQueueOperationOptions {
  * 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 {@link Request} class.
- * The queue can only contain unique URLs. More precisely, it can only contain {@link Request} instances
+ * 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
  * 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 {@link Request} objects will need to have different `uniqueKey` properties.
+ * corresponding {@apilink Request} objects will need to have different `uniqueKey` properties.
  *
- * Do not instantiate this class directly, use the {@link RequestQueue.open} function instead.
+ * Do not instantiate this class directly, use the {@apilink RequestQueue.open} function instead.
  *
- * `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.
+ * `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.
  * 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,
@@ -89,7 +89,7 @@ export interface RequestQueueOperationOptions {
  * 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 {@link RequestQueue.open} function,
+ * option to {@apilink RequestQueue.open} function,
  * even if the `APIFY_LOCAL_STORAGE_DIR` variable is set.
  *
  * **Example usage:**
@@ -152,12 +152,12 @@ export declare class RequestQueue {
      *
      * If a request with the same `uniqueKey` property is already present in the queue,
      * it will not be updated. You can find out whether this happened from the resulting
-     * {@link QueueOperationInfo} object.
+     * {@apilink QueueOperationInfo} object.
      *
      * To add multiple requests to the queue by extracting links from a webpage,
-     * see the {@link enqueueLinks} helper function.
+     * see the {@apilink enqueueLinks} helper function.
      *
-     * @param requestLike {@link Request} object or vanilla object with request data.
+     * @param requestLike {@apilink Request} object or vanilla object with request data.
      * Note that the function sets the `uniqueKey` and `id` fields to the passed Request.
      * @param [options] Request queue operation options.
      */
@@ -167,9 +167,9 @@ export declare class RequestQueue {
      *
      * If a request that is passed in is already present due to its `uniqueKey` property being the same,
      * it will not be updated. You can find out whether this happened by finding the request in the resulting
-     * {@link BatchAddRequestsResult} object.
+     * {@apilink BatchAddRequestsResult} object.
      *
-     * @param requestsLike {@link Request} objects or vanilla objects with request data.
+     * @param requestsLike {@apilink Request} objects or vanilla objects with request data.
      * Note that the function sets the `uniqueKey` and `id` fields to the passed requests if missing.
      * @param [options] Request queue operation options.
      */
@@ -185,15 +185,15 @@ export declare class RequestQueue {
      * 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
-     * {@link RequestQueue.markRequestHandled}
+     * {@apilink RequestQueue.markRequestHandled}
      * to mark the request as handled in the queue. If there was some error in processing the request,
-     * call {@link RequestQueue.reclaimRequest} instead,
+     * call {@apilink 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 {@link RequestQueue.isFinished} instead.
+     * use {@apilink RequestQueue.isFinished} instead.
      *
      * @returns
      *   Returns the request object or `null` if there are no more pending requests.
@@ -201,23 +201,23 @@ export declare class RequestQueue {
     fetchNextRequest<T extends Dictionary = Dictionary>(): Promise<Request<T> | null>;
     /**
      * Marks a request that was previously returned by the
-     * {@link RequestQueue.fetchNextRequest}
+     * {@apilink RequestQueue.fetchNextRequest}
      * function as handled after successful processing.
      * Handled requests will never again be returned by the `fetchNextRequest` function.
      */
     markRequestHandled(request: Request): Promise<QueueOperationInfo | null>;
     /**
      * Reclaims a failed request back to the queue, so that it can be returned for processing later again
-     * by another call to {@link RequestQueue.fetchNextRequest}.
+     * by another call to {@apilink 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.
      */
     reclaimRequest(request: Request, options?: RequestQueueOperationOptions): Promise<QueueOperationInfo | null>;
     /**
-     * Resolves to `true` if the next call to {@link RequestQueue.fetchNextRequest}
+     * Resolves to `true` if the next call to {@apilink RequestQueue.fetchNextRequest}
      * would return `null`, otherwise it resolves to `false`.
      * Note that even if the queue is empty, there might be some pending requests currently being processed.
-     * If you need to ensure that there is no activity in the queue, use {@link RequestQueue.isFinished}.
+     * If you need to ensure that there is no activity in the queue, use {@apilink RequestQueue.isFinished}.
      */
     isEmpty(): Promise<boolean>;
     /**
@@ -290,14 +290,14 @@ export declare class RequestQueue {
     getInfo(): Promise<RequestQueueInfo | undefined>;
     /**
      * Opens a request queue and returns a promise resolving to an instance
-     * of the {@link RequestQueue} class.
+     * of the {@apilink RequestQueue} class.
      *
-     * {@link RequestQueue} represents a queue of URLs to crawl, which is stored either on local filesystem or in the cloud.
+     * {@apilink 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 {@link RequestQueue} class.
+     * For more details and code examples, see the {@apilink RequestQueue} class.
      *
      * @param [queueIdOrName]
      *   ID or name of the request queue to be opened. If `null` or `undefined`,

package/storages/request_queue.js

@@ -67,17 +67,17 @@ exports.getRequestId = getRequestId;
  * 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 {@link Request} class.
- * The queue can only contain unique URLs. More precisely, it can only contain {@link Request} instances
+ * 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
  * 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 {@link Request} objects will need to have different `uniqueKey` properties.
+ * corresponding {@apilink Request} objects will need to have different `uniqueKey` properties.
  *
- * Do not instantiate this class directly, use the {@link RequestQueue.open} function instead.
+ * Do not instantiate this class directly, use the {@apilink RequestQueue.open} function instead.
  *
- * `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.
+ * `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.
  * 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,
@@ -89,7 +89,7 @@ exports.getRequestId = getRequestId;
  * 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 {@link RequestQueue.open} function,
+ * option to {@apilink RequestQueue.open} function,
  * even if the `APIFY_LOCAL_STORAGE_DIR` variable is set.
  *
  * **Example usage:**
@@ -244,12 +244,12 @@ class RequestQueue {
      *
      * If a request with the same `uniqueKey` property is already present in the queue,
      * it will not be updated. You can find out whether this happened from the resulting
-     * {@link QueueOperationInfo} object.
+     * {@apilink QueueOperationInfo} object.
      *
      * To add multiple requests to the queue by extracting links from a webpage,
-     * see the {@link enqueueLinks} helper function.
+     * see the {@apilink enqueueLinks} helper function.
      *
-     * @param requestLike {@link Request} object or vanilla object with request data.
+     * @param requestLike {@apilink Request} object or vanilla object with request data.
      * Note that the function sets the `uniqueKey` and `id` fields to the passed Request.
      * @param [options] Request queue operation options.
      */
@@ -295,9 +295,9 @@ class RequestQueue {
      *
      * If a request that is passed in is already present due to its `uniqueKey` property being the same,
      * it will not be updated. You can find out whether this happened by finding the request in the resulting
-     * {@link BatchAddRequestsResult} object.
+     * {@apilink BatchAddRequestsResult} object.
      *
-     * @param requestsLike {@link Request} objects or vanilla objects with request data.
+     * @param requestsLike {@apilink Request} objects or vanilla objects with request data.
      * Note that the function sets the `uniqueKey` and `id` fields to the passed requests if missing.
      * @param [options] Request queue operation options.
      */
@@ -386,15 +386,15 @@ class RequestQueue {
      * 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
-     * {@link RequestQueue.markRequestHandled}
+     * {@apilink RequestQueue.markRequestHandled}
      * to mark the request as handled in the queue. If there was some error in processing the request,
-     * call {@link RequestQueue.reclaimRequest} instead,
+     * call {@apilink 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 {@link RequestQueue.isFinished} instead.
+     * use {@apilink RequestQueue.isFinished} instead.
      *
      * @returns
      *   Returns the request object or `null` if there are no more pending requests.
@@ -451,7 +451,7 @@ class RequestQueue {
     }
     /**
      * Marks a request that was previously returned by the
-     * {@link RequestQueue.fetchNextRequest}
+     * {@apilink RequestQueue.fetchNextRequest}
      * function as handled after successful processing.
      * Handled requests will never again be returned by the `fetchNextRequest` function.
      */
@@ -480,7 +480,7 @@ class RequestQueue {
     }
     /**
      * Reclaims a failed request back to the queue, so that it can be returned for processing later again
-     * by another call to {@link RequestQueue.fetchNextRequest}.
+     * by another call to {@apilink 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.
      */
@@ -517,10 +517,10 @@ class RequestQueue {
         return queueOperationInfo;
     }
     /**
-     * Resolves to `true` if the next call to {@link RequestQueue.fetchNextRequest}
+     * Resolves to `true` if the next call to {@apilink RequestQueue.fetchNextRequest}
      * would return `null`, otherwise it resolves to `false`.
      * Note that even if the queue is empty, there might be some pending requests currently being processed.
-     * If you need to ensure that there is no activity in the queue, use {@link RequestQueue.isFinished}.
+     * If you need to ensure that there is no activity in the queue, use {@apilink RequestQueue.isFinished}.
      */
     async isEmpty() {
         await this._ensureHeadIsNonEmpty();
@@ -709,14 +709,14 @@ class RequestQueue {
     }
     /**
      * Opens a request queue and returns a promise resolving to an instance
-     * of the {@link RequestQueue} class.
+     * of the {@apilink RequestQueue} class.
      *
-     * {@link RequestQueue} represents a queue of URLs to crawl, which is stored either on local filesystem or in the cloud.
+     * {@apilink 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 {@link RequestQueue} class.
+     * For more details and code examples, see the {@apilink RequestQueue} class.
      *
      * @param [queueIdOrName]
      *   ID or name of the request queue to be opened. If `null` or `undefined`,

package/storages/utils.d.ts

@@ -4,7 +4,7 @@ import { Configuration } from '../configuration';
  * 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` {@link Configuration}
+ * explicitly, e.g. via `RequestList.open()`). We can disable that via `purgeOnStart` {@apilink 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

package/storages/utils.js

@@ -7,7 +7,7 @@ const configuration_1 = require("../configuration");
  * 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` {@link Configuration}
+ * explicitly, e.g. via `RequestList.open()`). We can disable that via `purgeOnStart` {@apilink 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