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

package/enqueue_links/enqueue_links.d.ts

@@ -16,9 +16,9 @@ export interface EnqueueLinksOptions extends RequestQueueOperationOptions {
     requestQueue?: RequestProvider;
     /** A CSS selector matching links to be enqueued. */
     selector?: string;
-    /** Sets {@apilink Request.userData} for newly enqueued requests. */
+    /** Sets {@link Request.userData} for newly enqueued requests. */
     userData?: Dictionary;
-    /** Sets {@apilink Request.label} for newly enqueued requests. */
+    /** Sets {@link Request.label} for newly enqueued requests. */
     label?: string;
     /**
      * If set to `true`, tells the crawler to skip navigation and process the request directly.
@@ -35,7 +35,7 @@ export interface EnqueueLinksOptions extends RequestQueueOperationOptions {
      * containing glob pattern strings matching the URLs to be enqueued.
      *
      * The plain objects must include at least the `glob` property, which holds the glob pattern string.
-     * All remaining keys will be used as request options for the corresponding enqueued {@apilink Request} objects.
+     * All remaining keys will be used as request options for the corresponding enqueued {@link Request} objects.
      *
      * The matching is always case-insensitive.
      * If you need case-sensitive matching, use `regexps` property directly.
@@ -49,7 +49,7 @@ export interface EnqueueLinksOptions extends RequestQueueOperationOptions {
      * containing patterns matching URLs that will **never** be enqueued.
      *
      * The plain objects must include either the `glob` property or the `regexp` property.
-     * All remaining keys will be used as request options for the corresponding enqueued {@apilink Request} objects.
+     * All remaining keys will be used as request options for the corresponding enqueued {@link Request} objects.
      *
      * Glob matching is always case-insensitive.
      * If you need case-sensitive matching, provide a regexp.
@@ -60,7 +60,7 @@ export interface EnqueueLinksOptions extends RequestQueueOperationOptions {
      * containing regular expressions matching the URLs to be enqueued.
      *
      * The plain objects must include at least the `regexp` property, which holds the regular expression.
-     * All remaining keys will be used as request options for the corresponding enqueued {@apilink Request} objects.
+     * All remaining keys will be used as request options for the corresponding enqueued {@link Request} objects.
      *
      * If `regexps` is an empty array or `undefined`, and `globs` are also not defined, then the function
      * enqueues the links with the same subdomain.
@@ -70,11 +70,11 @@ export interface EnqueueLinksOptions extends RequestQueueOperationOptions {
      * *NOTE:* In future versions of SDK the options will be removed.
      * Please use `globs` or `regexps` instead.
      *
-     * An array of {@apilink PseudoUrl} strings or plain objects
-     * containing {@apilink PseudoUrl} strings matching the URLs to be enqueued.
+     * An array of {@link PseudoUrl} strings or plain objects
+     * containing {@link PseudoUrl} strings matching the URLs to be enqueued.
      *
      * The plain objects must include at least the `purl` property, which holds the pseudo-URL string.
-     * All remaining keys will be used as request options for the corresponding enqueued {@apilink Request} objects.
+     * All remaining keys will be used as request options for the corresponding enqueued {@link Request} objects.
      *
      * With a pseudo-URL string, the matching is always case-insensitive.
      * If you need case-sensitive matching, use `regexps` property directly.
@@ -86,7 +86,7 @@ export interface EnqueueLinksOptions extends RequestQueueOperationOptions {
      */
     pseudoUrls?: readonly PseudoUrlInput[];
     /**
-     * Just before a new {@apilink Request} is constructed and enqueued to the {@apilink RequestQueue}, this function can be used
+     * Just before a new {@link Request} is constructed and enqueued to the {@link RequestQueue}, this function can be used
      * to remove it or modify its contents such as `userData`, `payload` or, most importantly `uniqueKey`. This is useful
      * when you need to enqueue multiple `Requests` to the queue that share the same URL, but differ in methods or payloads,
      * or to dynamically update or create `userData`.
@@ -197,11 +197,11 @@ export declare enum EnqueueStrategy {
     SameOrigin = "same-origin"
 }
 /**
- * This function enqueues the urls provided to the {@apilink RequestQueue} provided. If you want to automatically find and enqueue links,
+ * This function enqueues the urls provided to the {@link RequestQueue} provided. If you want to automatically find and enqueue links,
  * you should use the context-aware `enqueueLinks` function provided on the crawler contexts.
  *
  * Optionally, the function allows you to filter the target links' URLs using an array of globs or regular expressions
- * and override settings of the enqueued {@apilink Request} objects.
+ * and override settings of the enqueued {@link Request} objects.
  *
  * **Example usage**
  *
@@ -218,14 +218,14 @@ export declare enum EnqueueStrategy {
  * ```
  *
  * @param options All `enqueueLinks()` parameters are passed via an options object.
- * @returns Promise that resolves to {@apilink BatchAddRequestsResult} object.
+ * @returns Promise that resolves to {@link BatchAddRequestsResult} object.
  */
 export declare function enqueueLinks(options: SetRequired<EnqueueLinksOptions, 'requestQueue' | 'urls'>): Promise<BatchAddRequestsResult>;
 /**
  * @internal
- * This method helps resolve the baseUrl that will be used for filtering in {@apilink enqueueLinks}.
+ * This method helps resolve the baseUrl that will be used for filtering in {@link enqueueLinks}.
  * - If a user provides a base url, we always return it
- * - If a user specifies {@apilink EnqueueStrategy.All} strategy, they do not care if the newly found urls are on the original
+ * - If a user specifies {@link EnqueueStrategy.All} strategy, they do not care if the newly found urls are on the original
  *   request domain, or a redirected one
  * - In all other cases, we return the domain of the original request as that's the one we need to use for filtering
  */

package/enqueue_links/enqueue_links.js

@@ -61,11 +61,11 @@ var EnqueueStrategy;
     EnqueueStrategy["SameOrigin"] = "same-origin";
 })(EnqueueStrategy || (exports.EnqueueStrategy = EnqueueStrategy = {}));
 /**
- * This function enqueues the urls provided to the {@apilink RequestQueue} provided. If you want to automatically find and enqueue links,
+ * This function enqueues the urls provided to the {@link RequestQueue} provided. If you want to automatically find and enqueue links,
  * you should use the context-aware `enqueueLinks` function provided on the crawler contexts.
  *
  * Optionally, the function allows you to filter the target links' URLs using an array of globs or regular expressions
- * and override settings of the enqueued {@apilink Request} objects.
+ * and override settings of the enqueued {@link Request} objects.
  *
  * **Example usage**
  *
@@ -82,7 +82,7 @@ var EnqueueStrategy;
  * ```
  *
  * @param options All `enqueueLinks()` parameters are passed via an options object.
- * @returns Promise that resolves to {@apilink BatchAddRequestsResult} object.
+ * @returns Promise that resolves to {@link BatchAddRequestsResult} object.
  */
 async function enqueueLinks(options) {
     if (!options || Object.keys(options).length === 0) {
@@ -215,9 +215,9 @@ async function enqueueLinks(options) {
 }
 /**
  * @internal
- * This method helps resolve the baseUrl that will be used for filtering in {@apilink enqueueLinks}.
+ * This method helps resolve the baseUrl that will be used for filtering in {@link enqueueLinks}.
  * - If a user provides a base url, we always return it
- * - If a user specifies {@apilink EnqueueStrategy.All} strategy, they do not care if the newly found urls are on the original
+ * - If a user specifies {@link EnqueueStrategy.All} strategy, they do not care if the newly found urls are on the original
  *   request domain, or a redirected one
  * - In all other cases, we return the domain of the original request as that's the one we need to use for filtering
  */

package/enqueue_links/shared.d.ts

@@ -54,8 +54,8 @@ export declare function filterRequestsByPatterns(requests: Request[], patterns?:
  */
 export declare function createRequestOptions(sources: (string | Record<string, unknown>)[], options?: Pick<EnqueueLinksOptions, 'label' | 'userData' | 'baseUrl' | 'skipNavigation' | 'strategy'>): RequestOptions[];
 /**
- * Takes an Apify {@apilink RequestOptions} object and changes its attributes in a desired way. This user-function is used
- * {@apilink enqueueLinks} to modify requests before enqueuing them.
+ * Takes an Apify {@link RequestOptions} object and changes its attributes in a desired way. This user-function is used
+ * {@link enqueueLinks} to modify requests before enqueuing them.
  */
 export interface RequestTransform {
     /**

package/http_clients/base-http-client.d.ts

@@ -13,7 +13,7 @@ type Timeout = {
 };
 type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'HEAD' | 'DELETE' | 'OPTIONS' | 'TRACE' | 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete' | 'options' | 'trace';
 /**
- * Maps permitted values of the `responseType` option on {@apilink HttpRequest} to the types that they produce.
+ * Maps permitted values of the `responseType` option on {@link HttpRequest} to the types that they produce.
  */
 export interface ResponseTypes {
     'json': unknown;
@@ -35,7 +35,7 @@ interface PromiseCookieJar {
 }
 type SimpleHeaders = Record<string, string | string[] | undefined>;
 /**
- * HTTP Request as accepted by {@apilink BaseHttpClient} methods.
+ * HTTP Request as accepted by {@link BaseHttpClient} methods.
  */
 export interface HttpRequest<TResponseType extends keyof ResponseTypes = 'text'> {
     [k: string]: unknown;
@@ -61,7 +61,7 @@ export interface HttpRequest<TResponseType extends keyof ResponseTypes = 'text'>
     sessionToken?: object;
 }
 /**
- * Additional options for HTTP requests that need to be handled separately before passing to {@apilink BaseHttpClient}.
+ * Additional options for HTTP requests that need to be handled separately before passing to {@link BaseHttpClient}.
  */
 export interface HttpRequestOptions<TResponseType extends keyof ResponseTypes = 'text'> extends HttpRequest<TResponseType> {
     /** Search (query string) parameters to be appended to the request URL */
@@ -76,7 +76,7 @@ export interface HttpRequestOptions<TResponseType extends keyof ResponseTypes =
     password?: string;
 }
 /**
- * HTTP response data, without a body, as returned by {@apilink BaseHttpClient} methods.
+ * HTTP response data, without a body, as returned by {@link BaseHttpClient} methods.
  */
 export interface BaseHttpResponseData {
     redirectUrls: URL[];
@@ -92,14 +92,14 @@ interface HttpResponseWithoutBody<TResponseType extends keyof ResponseTypes = ke
     request: HttpRequest<TResponseType>;
 }
 /**
- * HTTP response data as returned by the {@apilink BaseHttpClient.sendRequest} method.
+ * HTTP response data as returned by the {@link BaseHttpClient.sendRequest} method.
  */
 export interface HttpResponse<TResponseType extends keyof ResponseTypes = keyof ResponseTypes> extends HttpResponseWithoutBody<TResponseType> {
     [k: string]: any;
     body: ResponseTypes[TResponseType];
 }
 /**
- * HTTP response data as returned by the {@apilink BaseHttpClient.stream} method.
+ * HTTP response data as returned by the {@link BaseHttpClient.stream} method.
  */
 export interface StreamingHttpResponse extends HttpResponseWithoutBody {
     stream: Readable;
@@ -127,7 +127,7 @@ export interface BaseHttpClient {
     stream(request: HttpRequest, onRedirect?: RedirectHandler): Promise<StreamingHttpResponse>;
 }
 /**
- * Converts {@apilink HttpRequestOptions} to a {@apilink HttpRequest}.
+ * Converts {@link HttpRequestOptions} to a {@link HttpRequest}.
  */
 export declare function processHttpRequestOptions<TResponseType extends keyof ResponseTypes = 'text'>({ searchParams, form, json, username, password, ...request }: HttpRequestOptions<TResponseType>): HttpRequest<TResponseType>;
 export {};

package/http_clients/base-http-client.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.processHttpRequestOptions = processHttpRequestOptions;
 const utils_1 = require("@crawlee/utils");
 /**
- * Converts {@apilink HttpRequestOptions} to a {@apilink HttpRequest}.
+ * Converts {@link HttpRequestOptions} to a {@link HttpRequest}.
  */
 function processHttpRequestOptions({ searchParams, form, json, username, password, ...request }) {
     const url = new URL(request.url);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@crawlee/core",
-    "version": "3.13.3-beta.11",
+    "version": "3.13.3-beta.13",
     "description": "The scalable web crawling and scraping library for JavaScript/Node.js. Enables development of data extraction and web automation jobs (not only) with headless Chrome and Puppeteer.",
     "engines": {
         "node": ">=16.0.0"
@@ -59,9 +59,9 @@
         "@apify/pseudo_url": "^2.0.30",
         "@apify/timeout": "^0.3.0",
         "@apify/utilities": "^2.7.10",
-        "@crawlee/memory-storage": "3.13.3-beta.11",
-        "@crawlee/types": "3.13.3-beta.11",
-        "@crawlee/utils": "3.13.3-beta.11",
+        "@crawlee/memory-storage": "3.13.3-beta.13",
+        "@crawlee/types": "3.13.3-beta.13",
+        "@crawlee/utils": "3.13.3-beta.13",
         "@sapphire/async-queue": "^1.5.1",
         "@vladfrangu/async_event_emitter": "^2.2.2",
         "csv-stringify": "^6.2.0",
@@ -83,5 +83,5 @@
             }
         }
     },
-    "gitHead": "181ad7bb9e703d47c2f05030c0f52cce9d1ea4e1"
+    "gitHead": "dbeb9038f0ef619689f9067563cddcb375207ab6"
 }

package/proxy_configuration.d.ts

@@ -15,7 +15,7 @@ export interface ProxyConfigurationOptions {
      * Custom function that allows you to generate the new proxy URL dynamically. It gets the `sessionId` as a parameter and an optional parameter with the `Request` object when applicable.
      * Can return either stringified proxy URL or `null` if the proxy should not be used. Can be asynchronous.
      *
-     * This function is used to generate the URL when {@apilink ProxyConfiguration.newUrl} or {@apilink ProxyConfiguration.newProxyInfo} is called.
+     * This function is used to generate the URL when {@link ProxyConfiguration.newUrl} or {@link ProxyConfiguration.newProxyInfo} is called.
      */
     newUrlFunction?: ProxyConfigurationFunction;
     /**
@@ -38,7 +38,7 @@ export interface TieredProxy {
 /**
  * The main purpose of the ProxyInfo object is to provide information
  * about the current proxy connection used by the crawler for the request.
- * Outside of crawlers, you can get this object by calling {@apilink ProxyConfiguration.newProxyInfo}.
+ * Outside of crawlers, you can get this object by calling {@link ProxyConfiguration.newProxyInfo}.
  *
  * **Example usage:**
  *
@@ -67,7 +67,7 @@ export interface TieredProxy {
  */
 export interface ProxyInfo {
     /**
-     * The identifier of used {@apilink Session}, if used.
+     * The identifier of used {@link Session}, if used.
      */
     sessionId?: string;
     /**
@@ -129,9 +129,9 @@ declare class ProxyTierTracker {
  * Configures connection to a proxy server with the provided options. Proxy servers are used to prevent target websites from blocking
  * your crawlers based on IP address rate limits or blacklists. Setting proxy configuration in your crawlers automatically configures
  * them to use the selected proxies for all connections. You can get information about the currently used proxy by inspecting
- * the {@apilink ProxyInfo} property in your crawler's page function. There, you can inspect the proxy's URL and other attributes.
+ * the {@link ProxyInfo} property in your crawler's page function. There, you can inspect the proxy's URL and other attributes.
  *
- * If you want to use your own proxies, use the {@apilink ProxyConfigurationOptions.proxyUrls} option. Your list of proxy URLs will
+ * If you want to use your own proxies, use the {@link ProxyConfigurationOptions.proxyUrls} option. Your list of proxy URLs will
  * be rotated by the configuration if this option is provided.
  *
  * **Example usage:**
@@ -164,7 +164,7 @@ export declare class ProxyConfiguration {
     protected log: import("@apify/log").Log;
     protected domainTiers: Map<string, ProxyTierTracker>;
     /**
-     * Creates a {@apilink ProxyConfiguration} instance based on the provided options. Proxy servers are used to prevent target websites from
+     * Creates a {@link ProxyConfiguration} instance based on the provided options. Proxy servers are used to prevent target websites from
      * blocking your crawlers based on IP address rate limits or blacklists. Setting proxy configuration in your crawlers automatically configures
      * them to use the selected proxies for all connections.
      *
@@ -185,16 +185,16 @@ export declare class ProxyConfiguration {
      */
     constructor(options?: ProxyConfigurationOptions);
     /**
-     * This function creates a new {@apilink ProxyInfo} info object.
+     * This function creates a new {@link ProxyInfo} info object.
      * It is used by CheerioCrawler and PuppeteerCrawler to generate proxy URLs and also to allow the user to inspect
      * the currently used proxy via the requestHandler parameter `proxyInfo`.
      * Use it if you want to work with a rich representation of a proxy URL.
-     * If you need the URL string only, use {@apilink ProxyConfiguration.newUrl}.
+     * If you need the URL string only, use {@link ProxyConfiguration.newUrl}.
      * @param [sessionId]
-     *  Represents the identifier of user {@apilink Session} that can be managed by the {@apilink SessionPool} or
+     *  Represents the identifier of user {@link Session} that can be managed by the {@link SessionPool} or
      *  you can use the Apify Proxy [Session](https://docs.apify.com/proxy#sessions) identifier.
      *  When the provided sessionId is a number, it's converted to a string. Property sessionId of
-     *  {@apilink ProxyInfo} is always returned as a type string.
+     *  {@link ProxyInfo} is always returned as a type string.
      *
      *  All the HTTP requests going through the proxy with the same session identifier
      *  will use the same target proxy server (i.e. the same IP address).
@@ -218,7 +218,7 @@ export declare class ProxyConfiguration {
     /**
      * Returns a new proxy URL based on provided configuration options and the `sessionId` parameter.
      * @param [sessionId]
-     *  Represents the identifier of user {@apilink Session} that can be managed by the {@apilink SessionPool} or
+     *  Represents the identifier of user {@link Session} that can be managed by the {@link SessionPool} or
      *  you can use the Apify Proxy [Session](https://docs.apify.com/proxy#sessions) identifier.
      *  When the provided sessionId is a number, it's converted to a string.
      *

package/proxy_configuration.js

@@ -68,9 +68,9 @@ class ProxyTierTracker {
  * Configures connection to a proxy server with the provided options. Proxy servers are used to prevent target websites from blocking
  * your crawlers based on IP address rate limits or blacklists. Setting proxy configuration in your crawlers automatically configures
  * them to use the selected proxies for all connections. You can get information about the currently used proxy by inspecting
- * the {@apilink ProxyInfo} property in your crawler's page function. There, you can inspect the proxy's URL and other attributes.
+ * the {@link ProxyInfo} property in your crawler's page function. There, you can inspect the proxy's URL and other attributes.
  *
- * If you want to use your own proxies, use the {@apilink ProxyConfigurationOptions.proxyUrls} option. Your list of proxy URLs will
+ * If you want to use your own proxies, use the {@link ProxyConfigurationOptions.proxyUrls} option. Your list of proxy URLs will
  * be rotated by the configuration if this option is provided.
  *
  * **Example usage:**
@@ -94,7 +94,7 @@ class ProxyTierTracker {
  */
 class ProxyConfiguration {
     /**
-     * Creates a {@apilink ProxyConfiguration} instance based on the provided options. Proxy servers are used to prevent target websites from
+     * Creates a {@link ProxyConfiguration} instance based on the provided options. Proxy servers are used to prevent target websites from
      * blocking your crawlers based on IP address rate limits or blacklists. Setting proxy configuration in your crawlers automatically configures
      * them to use the selected proxies for all connections.
      *
@@ -178,16 +178,16 @@ class ProxyConfiguration {
         this.tieredProxyUrls = tieredProxyUrls;
     }
     /**
-     * This function creates a new {@apilink ProxyInfo} info object.
+     * This function creates a new {@link ProxyInfo} info object.
      * It is used by CheerioCrawler and PuppeteerCrawler to generate proxy URLs and also to allow the user to inspect
      * the currently used proxy via the requestHandler parameter `proxyInfo`.
      * Use it if you want to work with a rich representation of a proxy URL.
-     * If you need the URL string only, use {@apilink ProxyConfiguration.newUrl}.
+     * If you need the URL string only, use {@link ProxyConfiguration.newUrl}.
      * @param [sessionId]
-     *  Represents the identifier of user {@apilink Session} that can be managed by the {@apilink SessionPool} or
+     *  Represents the identifier of user {@link Session} that can be managed by the {@link SessionPool} or
      *  you can use the Apify Proxy [Session](https://docs.apify.com/proxy#sessions) identifier.
      *  When the provided sessionId is a number, it's converted to a string. Property sessionId of
-     *  {@apilink ProxyInfo} is always returned as a type string.
+     *  {@link ProxyInfo} is always returned as a type string.
      *
      *  All the HTTP requests going through the proxy with the same session identifier
      *  will use the same target proxy server (i.e. the same IP address).
@@ -275,7 +275,7 @@ class ProxyConfiguration {
     /**
      * Returns a new proxy URL based on provided configuration options and the `sessionId` parameter.
      * @param [sessionId]
-     *  Represents the identifier of user {@apilink Session} that can be managed by the {@apilink SessionPool} or
+     *  Represents the identifier of user {@link Session} that can be managed by the {@link SessionPool} or
      *  you can use the Apify Proxy [Session](https://docs.apify.com/proxy#sessions) identifier.
      *  When the provided sessionId is a number, it's converted to a string.
      *

package/request.d.ts

@@ -19,7 +19,7 @@ export declare enum RequestState {
  * Each `Request` instance has the `uniqueKey` property, which can be either specified
  * manually in the constructor or generated automatically from the URL. Two requests with the same `uniqueKey`
  * are considered as pointing to the same web resource. This behavior applies to all Crawlee classes,
- * such as {@apilink RequestList}, {@apilink RequestQueue}, {@apilink PuppeteerCrawler} or {@apilink PlaywrightCrawler}.
+ * such as {@link RequestList}, {@link RequestQueue}, {@link PuppeteerCrawler} or {@link PlaywrightCrawler}.
  *
  * > To access and examine the actual request sent over http, with all autofilled headers you can access
  * `response.request` object from the request handler
@@ -52,7 +52,7 @@ export declare class Request<UserData extends Dictionary = Dictionary> {
      * An actually loaded URL after redirects, if present. HTTP redirects are guaranteed
      * to be included.
      *
-     * When using {@apilink PuppeteerCrawler} or {@apilink PlaywrightCrawler}, meta tag and JavaScript redirects may,
+     * When using {@link PuppeteerCrawler} or {@link PlaywrightCrawler}, meta tag and JavaScript redirects may,
      * or may not be included, depending on their nature. This generally means that redirects,
      * which happen immediately will most likely be included, but delayed redirects will not.
      */
@@ -131,7 +131,7 @@ export declare class Request<UserData extends Dictionary = Dictionary> {
     static hashPayload(payload: BinaryLike): string;
 }
 /**
- * Specifies required and optional fields for constructing a {@apilink Request}.
+ * Specifies required and optional fields for constructing a {@link Request}.
  */
 export interface RequestOptions<UserData extends Dictionary = Dictionary> {
     /** URL of the web page to crawl. It must be a non-empty string. */

package/request.js

@@ -48,7 +48,7 @@ var RequestState;
  * Each `Request` instance has the `uniqueKey` property, which can be either specified
  * manually in the constructor or generated automatically from the URL. Two requests with the same `uniqueKey`
  * are considered as pointing to the same web resource. This behavior applies to all Crawlee classes,
- * such as {@apilink RequestList}, {@apilink RequestQueue}, {@apilink PuppeteerCrawler} or {@apilink PlaywrightCrawler}.
+ * such as {@link RequestList}, {@link RequestQueue}, {@link PuppeteerCrawler} or {@link PlaywrightCrawler}.
  *
  * > To access and examine the actual request sent over http, with all autofilled headers you can access
  * `response.request` object from the request handler
@@ -95,7 +95,7 @@ class Request {
          * An actually loaded URL after redirects, if present. HTTP redirects are guaranteed
          * to be included.
          *
-         * When using {@apilink PuppeteerCrawler} or {@apilink PlaywrightCrawler}, meta tag and JavaScript redirects may,
+         * When using {@link PuppeteerCrawler} or {@link PlaywrightCrawler}, meta tag and JavaScript redirects may,
          * or may not be included, depending on their nature. This generally means that redirects,
          * which happen immediately will most likely be included, but delayed redirects will not.
          */

package/session_pool/session.d.ts

@@ -4,7 +4,7 @@ import { CookieJar } from 'tough-cookie';
 import type { Log } from '@apify/log';
 import type { ResponseLike } from '../cookie_utils';
 /**
- * Persistable {@apilink Session} state.
+ * Persistable {@link Session} state.
  */
 export interface SessionState {
     id: string;

package/session_pool/session_pool.d.ts

@@ -7,7 +7,7 @@ import { KeyValueStore } from '../storages/key_value_store';
 import type { SessionOptions } from './session';
 import { Session } from './session';
 /**
- * Factory user-function which creates customized {@apilink Session} instances.
+ * Factory user-function which creates customized {@link Session} instances.
  */
 export interface CreateSession {
     /**
@@ -24,7 +24,7 @@ export interface SessionPoolOptions {
      * @default 1000
      */
     maxPoolSize?: number;
-    /** The configuration options for {@apilink Session} instances. */
+    /** The configuration options for {@link Session} instances. */
     sessionOptions?: SessionOptions;
     /** Name or Id of `KeyValueStore` where is the `SessionPool` state stored. */
     persistStateKeyValueStoreId?: string;
@@ -54,11 +54,11 @@ export interface SessionPoolOptions {
 }
 /**
  * Handles the rotation, creation and persistence of user-like sessions.
- * Creates a pool of {@apilink Session} instances, that are randomly rotated.
+ * Creates a pool of {@link Session} instances, that are randomly rotated.
  * When some session is marked as blocked, it is removed and new one is created instead (the pool never returns an unusable session).
  * Learn more in the {@doclink guides/session-management | Session management guide}.
  *
- * You can create one by calling the {@apilink SessionPool.open} function.
+ * You can create one by calling the {@link SessionPool.open} function.
  *
  * Session pool is already integrated into crawlers, and it can significantly improve your scraper
  * performance with just 2 lines of code.
@@ -73,10 +73,10 @@ export interface SessionPoolOptions {
  * })
  * ```
  *
- * You can configure the pool with many options. See the {@apilink SessionPoolOptions}.
- * Session pool is by default persisted in default {@apilink KeyValueStore}.
+ * You can configure the pool with many options. See the {@link SessionPoolOptions}.
+ * Session pool is by default persisted in default {@link KeyValueStore}.
  * If you want to have one pool for all runs you have to specify
- * {@apilink SessionPoolOptions.persistStateKeyValueStoreId}.
+ * {@link SessionPoolOptions.persistStateKeyValueStoreId}.
  *
  * **Advanced usage:**
  *
@@ -147,8 +147,8 @@ export declare class SessionPool extends EventEmitter {
      */
     get retiredSessionsCount(): number;
     /**
-     * Starts periodic state persistence and potentially loads SessionPool state from {@apilink KeyValueStore}.
-     * It is called automatically by the {@apilink SessionPool.open} function.
+     * Starts periodic state persistence and potentially loads SessionPool state from {@link KeyValueStore}.
+     * It is called automatically by the {@link SessionPool.open} function.
      */
     initialize(): Promise<void>;
     /**
@@ -184,7 +184,7 @@ export declare class SessionPool extends EventEmitter {
         sessions: import("./session").SessionState[];
     };
     /**
-     * Persists the current state of the `SessionPool` into the default {@apilink KeyValueStore}.
+     * Persists the current state of the `SessionPool` into the default {@link KeyValueStore}.
      * The state is persisted automatically in regular intervals.
      * @param options - Override the persistence options provided in the constructor
      */
@@ -242,9 +242,9 @@ export declare class SessionPool extends EventEmitter {
     protected _maybeLoadSessionPool(): Promise<void>;
     /**
      * Opens a SessionPool and returns a promise resolving to an instance
-     * of the {@apilink SessionPool} class that is already initialized.
+     * of the {@link SessionPool} class that is already initialized.
      *
-     * For more details and code examples, see the {@apilink SessionPool} class.
+     * For more details and code examples, see the {@link SessionPool} class.
      */
     static open(options?: SessionPoolOptions, config?: Configuration): Promise<SessionPool>;
 }

package/session_pool/session_pool.js

@@ -12,11 +12,11 @@ const consts_1 = require("./consts");
 const session_1 = require("./session");
 /**
  * Handles the rotation, creation and persistence of user-like sessions.
- * Creates a pool of {@apilink Session} instances, that are randomly rotated.
+ * Creates a pool of {@link Session} instances, that are randomly rotated.
  * When some session is marked as blocked, it is removed and new one is created instead (the pool never returns an unusable session).
  * Learn more in the {@doclink guides/session-management | Session management guide}.
  *
- * You can create one by calling the {@apilink SessionPool.open} function.
+ * You can create one by calling the {@link SessionPool.open} function.
  *
  * Session pool is already integrated into crawlers, and it can significantly improve your scraper
  * performance with just 2 lines of code.
@@ -31,10 +31,10 @@ const session_1 = require("./session");
  * })
  * ```
  *
- * You can configure the pool with many options. See the {@apilink SessionPoolOptions}.
- * Session pool is by default persisted in default {@apilink KeyValueStore}.
+ * You can configure the pool with many options. See the {@link SessionPoolOptions}.
+ * Session pool is by default persisted in default {@link KeyValueStore}.
  * If you want to have one pool for all runs you have to specify
- * {@apilink SessionPoolOptions.persistStateKeyValueStoreId}.
+ * {@link SessionPoolOptions.persistStateKeyValueStoreId}.
  *
  * **Advanced usage:**
  *
@@ -222,8 +222,8 @@ class SessionPool extends node_events_1.EventEmitter {
         return this.sessions.filter((session) => !session.isUsable()).length;
     }
     /**
-     * Starts periodic state persistence and potentially loads SessionPool state from {@apilink KeyValueStore}.
-     * It is called automatically by the {@apilink SessionPool.open} function.
+     * Starts periodic state persistence and potentially loads SessionPool state from {@link KeyValueStore}.
+     * It is called automatically by the {@link SessionPool.open} function.
      */
     async initialize() {
         if (this.isInitialized) {
@@ -317,7 +317,7 @@ class SessionPool extends node_events_1.EventEmitter {
         };
     }
     /**
-     * Persists the current state of the `SessionPool` into the default {@apilink KeyValueStore}.
+     * Persists the current state of the `SessionPool` into the default {@link KeyValueStore}.
      * The state is persisted automatically in regular intervals.
      * @param options - Override the persistence options provided in the constructor
      */
@@ -437,9 +437,9 @@ class SessionPool extends node_events_1.EventEmitter {
     }
     /**
      * Opens a SessionPool and returns a promise resolving to an instance
-     * of the {@apilink SessionPool} class that is already initialized.
+     * of the {@link SessionPool} class that is already initialized.
      *
-     * For more details and code examples, see the {@apilink SessionPool} class.
+     * For more details and code examples, see the {@link SessionPool} class.
      */
     static async open(options, config) {
         const sessionPool = new SessionPool(options, config);