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

package/storages/dataset.d.ts

@@ -97,7 +97,7 @@ export interface DatasetExportToOptions extends DatasetExportOptions {
  * Typically it is used to store crawling results.
  *
  * Do not instantiate this class directly, use the
- * {@apilink Dataset.open} function instead.
+ * {@link Dataset.open} function instead.
  *
  * `Dataset` stores its data either on local disk or in the Apify cloud,
  * depending on whether the `APIFY_LOCAL_STORAGE_DIR` or `APIFY_TOKEN` environment variables are set.
@@ -114,7 +114,7 @@ export interface DatasetExportToOptions extends DatasetExportOptions {
  * If the `APIFY_TOKEN` environment variable is set but `APIFY_LOCAL_STORAGE_DIR` not, the data is stored in the
  * [Apify Dataset](https://docs.apify.com/storage/dataset)
  * cloud storage. Note that you can force usage of the cloud storage also by passing the `forceCloud`
- * option to {@apilink Dataset.open} function,
+ * option to {@link Dataset.open} function,
  * even if the `APIFY_LOCAL_STORAGE_DIR` variable is set.
  *
  * **Example usage:**
@@ -176,7 +176,7 @@ export declare class Dataset<Data extends Dictionary = Dictionary> {
      */
     pushData(data: Data | Data[]): Promise<void>;
     /**
-     * Returns {@apilink DatasetContent} object holding the items in the dataset based on the provided parameters.
+     * Returns {@link DatasetContent} object holding the items in the dataset based on the provided parameters.
      */
     getData(options?: DatasetDataOptions): Promise<DatasetContent<Data>>;
     /**
@@ -332,13 +332,13 @@ export declare class Dataset<Data extends Dictionary = Dictionary> {
      */
     drop(): Promise<void>;
     /**
-     * Opens a dataset and returns a promise resolving to an instance of the {@apilink Dataset} class.
+     * Opens a dataset and returns a promise resolving to an instance of the {@link Dataset} class.
      *
      * Datasets are used to store structured data where each object stored has the same attributes,
      * such as online store products or real estate offers.
      * The actual data is stored either on the local filesystem or in the cloud.
      *
-     * For more details and code examples, see the {@apilink Dataset} class.
+     * For more details and code examples, see the {@link Dataset} class.
      *
      * @param [datasetIdOrName]
      *   ID or name of the dataset to be opened. If `null` or `undefined`,
@@ -347,9 +347,9 @@ export declare class Dataset<Data extends Dictionary = Dictionary> {
      */
     static open<Data extends Dictionary = Dictionary>(datasetIdOrName?: string | null, options?: StorageManagerOptions): Promise<Dataset<Data>>;
     /**
-     * Stores an object or an array of objects to the default {@apilink Dataset} of the current crawler run.
+     * Stores an object or an array of objects to the default {@link Dataset} of the current crawler run.
      *
-     * This is just a convenient shortcut for {@apilink Dataset.pushData}.
+     * This is just a convenient shortcut for {@link Dataset.pushData}.
      * For example, calling the following code:
      * ```javascript
      * await Dataset.pushData({ myValue: 123 });
@@ -361,7 +361,7 @@ export declare class Dataset<Data extends Dictionary = Dictionary> {
      * await dataset.pushData({ myValue: 123 });
      * ```
      *
-     * For more information, see {@apilink Dataset.open} and {@apilink Dataset.pushData}
+     * For more information, see {@link Dataset.open} and {@link Dataset.pushData}
      *
      * **IMPORTANT**: Make sure to use the `await` keyword when calling `pushData()`,
      * otherwise the crawler process might finish before the data are stored!
@@ -372,7 +372,7 @@ export declare class Dataset<Data extends Dictionary = Dictionary> {
      */
     static pushData<Data extends Dictionary = Dictionary>(item: Data | Data[]): Promise<void>;
     /**
-     * Returns {@apilink DatasetContent} object holding the items in the dataset based on the provided parameters.
+     * Returns {@link DatasetContent} object holding the items in the dataset based on the provided parameters.
      */
     static getData<Data extends Dictionary = Dictionary>(options?: DatasetDataOptions): Promise<DatasetContent<Data>>;
 }
@@ -381,8 +381,8 @@ export declare class Dataset<Data extends Dictionary = Dictionary> {
  */
 export interface DatasetConsumer<Data> {
     /**
-     * @param item Current {@apilink Dataset} entry being processed.
-     * @param index Position of current {@apilink Dataset} entry.
+     * @param item Current {@link Dataset} entry being processed.
+     * @param index Position of current {@link Dataset} entry.
      */
     (item: Data, index: number): Awaitable<void>;
 }
@@ -392,8 +392,8 @@ export interface DatasetConsumer<Data> {
 export interface DatasetMapper<Data, R> {
     /**
      * User-function used in the `Dataset.map()` API.
-     * @param item Current {@apilink Dataset} entry being processed.
-     * @param index Position of current {@apilink Dataset} entry.
+     * @param item Current {@link Dataset} entry being processed.
+     * @param index Position of current {@link Dataset} entry.
      */
     (item: Data, index: number): Awaitable<R>;
 }
@@ -403,8 +403,8 @@ export interface DatasetMapper<Data, R> {
 export interface DatasetReducer<T, Data> {
     /**
      * @param memo Previous state of the reduction.
-     * @param item Current {@apilink Dataset} entry being processed.
-     * @param index Position of current {@apilink Dataset} entry.
+     * @param item Current {@link Dataset} entry being processed.
+     * @param index Position of current {@link Dataset} entry.
      */
     (memo: T, item: Data, index: number): Awaitable<T>;
 }

package/storages/dataset.js

@@ -90,7 +90,7 @@ function chunkBySize(items, limitBytes) {
  * Typically it is used to store crawling results.
  *
  * Do not instantiate this class directly, use the
- * {@apilink Dataset.open} function instead.
+ * {@link Dataset.open} function instead.
  *
  * `Dataset` stores its data either on local disk or in the Apify cloud,
  * depending on whether the `APIFY_LOCAL_STORAGE_DIR` or `APIFY_TOKEN` environment variables are set.
@@ -107,7 +107,7 @@ function chunkBySize(items, limitBytes) {
  * If the `APIFY_TOKEN` environment variable is set but `APIFY_LOCAL_STORAGE_DIR` not, the data is stored in the
  * [Apify Dataset](https://docs.apify.com/storage/dataset)
  * cloud storage. Note that you can force usage of the cloud storage also by passing the `forceCloud`
- * option to {@apilink Dataset.open} function,
+ * option to {@link Dataset.open} function,
  * even if the `APIFY_LOCAL_STORAGE_DIR` variable is set.
  *
  * **Example usage:**
@@ -216,7 +216,7 @@ class Dataset {
         }
     }
     /**
-     * Returns {@apilink DatasetContent} object holding the items in the dataset based on the provided parameters.
+     * Returns {@link DatasetContent} object holding the items in the dataset based on the provided parameters.
      */
     async getData(options = {}) {
         (0, access_checking_1.checkStorageAccess)();
@@ -429,13 +429,13 @@ class Dataset {
         manager.closeStorage(this);
     }
     /**
-     * Opens a dataset and returns a promise resolving to an instance of the {@apilink Dataset} class.
+     * Opens a dataset and returns a promise resolving to an instance of the {@link Dataset} class.
      *
      * Datasets are used to store structured data where each object stored has the same attributes,
      * such as online store products or real estate offers.
      * The actual data is stored either on the local filesystem or in the cloud.
      *
-     * For more details and code examples, see the {@apilink Dataset} class.
+     * For more details and code examples, see the {@link Dataset} class.
      *
      * @param [datasetIdOrName]
      *   ID or name of the dataset to be opened. If `null` or `undefined`,
@@ -456,9 +456,9 @@ class Dataset {
         return manager.openStorage(datasetIdOrName, options.storageClient);
     }
     /**
-     * Stores an object or an array of objects to the default {@apilink Dataset} of the current crawler run.
+     * Stores an object or an array of objects to the default {@link Dataset} of the current crawler run.
      *
-     * This is just a convenient shortcut for {@apilink Dataset.pushData}.
+     * This is just a convenient shortcut for {@link Dataset.pushData}.
      * For example, calling the following code:
      * ```javascript
      * await Dataset.pushData({ myValue: 123 });
@@ -470,7 +470,7 @@ class Dataset {
      * await dataset.pushData({ myValue: 123 });
      * ```
      *
-     * For more information, see {@apilink Dataset.open} and {@apilink Dataset.pushData}
+     * For more information, see {@link Dataset.open} and {@link Dataset.pushData}
      *
      * **IMPORTANT**: Make sure to use the `await` keyword when calling `pushData()`,
      * otherwise the crawler process might finish before the data are stored!
@@ -484,7 +484,7 @@ class Dataset {
         return dataset.pushData(item);
     }
     /**
-     * Returns {@apilink DatasetContent} object holding the items in the dataset based on the provided parameters.
+     * Returns {@link DatasetContent} object holding the items in the dataset based on the provided parameters.
      */
     static async getData(options = {}) {
         const dataset = await this.open();

package/storages/key_value_store.d.ts

@@ -17,16 +17,16 @@ export declare const maybeStringify: <T>(value: T, options: {
  * for saving screenshots, crawler inputs and outputs, web pages, PDFs or to persist the state of crawlers.
  *
  * Do not instantiate this class directly, use the
- * {@apilink KeyValueStore.open} function instead.
+ * {@link KeyValueStore.open} function instead.
  *
  * Each crawler run is associated with a default key-value store, which is created exclusively
  * for the run. By convention, the crawler input and output are stored into the
  * default key-value store under the `INPUT` and `OUTPUT` key, respectively.
  * Typically, input and output are JSON files, although it can be any other format.
  * To access the default key-value store directly, you can use the
- * {@apilink KeyValueStore.getValue} and {@apilink KeyValueStore.setValue} convenience functions.
+ * {@link KeyValueStore.getValue} and {@link KeyValueStore.setValue} convenience functions.
  *
- * To access the input, you can also use the {@apilink KeyValueStore.getInput} convenience function.
+ * To access the input, you can also use the {@link KeyValueStore.getInput} convenience function.
  *
  * `KeyValueStore` stores its data on a local disk.
  *
@@ -93,7 +93,7 @@ export declare class KeyValueStore {
      * If the record does not exist, the function resolves to `null`.
      *
      * To save or delete a value in the key-value store, use the
-     * {@apilink KeyValueStore.setValue} function.
+     * {@link KeyValueStore.setValue} function.
      *
      * **Example usage:**
      *
@@ -124,7 +124,7 @@ export declare class KeyValueStore {
      * If the record does not exist, the function resolves to `null`.
      *
      * To save or delete a value in the key-value store, use the
-     * {@apilink KeyValueStore.setValue} function.
+     * {@link KeyValueStore.setValue} function.
      *
      * **Example usage:**
      *
@@ -179,7 +179,7 @@ export declare class KeyValueStore {
      * regardless whether the record existed or not.
      *
      * To retrieve a value from the key-value store, use the
-     * {@apilink KeyValueStore.getValue} function.
+     * {@link KeyValueStore.getValue} function.
      *
      * **IMPORTANT:** Always make sure to use the `await` keyword when calling `setValue()`,
      * otherwise the crawler process might finish before the value is stored!
@@ -231,13 +231,13 @@ export declare class KeyValueStore {
      */
     getPublicUrl(key: string): string;
     /**
-     * Opens a key-value store and returns a promise resolving to an instance of the {@apilink KeyValueStore} class.
+     * Opens a key-value store and returns a promise resolving to an instance of the {@link KeyValueStore} class.
      *
      * Key-value stores are used to store records or files, along with their MIME content type.
      * The records are stored and retrieved using a unique key.
      * The actual data is stored either on a local filesystem or in the Apify cloud.
      *
-     * For more details and code examples, see the {@apilink KeyValueStore} class.
+     * For more details and code examples, see the {@link KeyValueStore} class.
      *
      * @param [storeIdOrName]
      *   ID or name of the key-value store to be opened. If `null` or `undefined`,
@@ -246,9 +246,9 @@ export declare class KeyValueStore {
      */
     static open(storeIdOrName?: string | null, options?: StorageManagerOptions): Promise<KeyValueStore>;
     /**
-     * Gets a value from the default {@apilink KeyValueStore} associated with the current crawler run.
+     * Gets a value from the default {@link KeyValueStore} associated with the current crawler run.
      *
-     * This is just a convenient shortcut for {@apilink KeyValueStore.getValue}.
+     * This is just a convenient shortcut for {@link KeyValueStore.getValue}.
      * For example, calling the following code:
      * ```javascript
      * const value = await KeyValueStore.getValue('my-key');
@@ -260,10 +260,10 @@ export declare class KeyValueStore {
      * const value = await store.getValue('my-key');
      * ```
      *
-     * To store the value to the default key-value store, you can use the {@apilink KeyValueStore.setValue} function.
+     * To store the value to the default key-value store, you can use the {@link KeyValueStore.setValue} function.
      *
-     * For more information, see  {@apilink KeyValueStore.open}
-     * and  {@apilink KeyValueStore.getValue}.
+     * For more information, see  {@link KeyValueStore.open}
+     * and  {@link KeyValueStore.getValue}.
      *
      * @param key Unique record key.
      * @returns
@@ -275,9 +275,9 @@ export declare class KeyValueStore {
      */
     static getValue<T = unknown>(key: string): Promise<T | null>;
     /**
-     * Gets a value from the default {@apilink KeyValueStore} associated with the current crawler run.
+     * Gets a value from the default {@link KeyValueStore} associated with the current crawler run.
      *
-     * This is just a convenient shortcut for {@apilink KeyValueStore.getValue}.
+     * This is just a convenient shortcut for {@link KeyValueStore.getValue}.
      * For example, calling the following code:
      * ```javascript
      * const value = await KeyValueStore.getValue('my-key');
@@ -289,10 +289,10 @@ export declare class KeyValueStore {
      * const value = await store.getValue('my-key');
      * ```
      *
-     * To store the value to the default key-value store, you can use the {@apilink KeyValueStore.setValue} function.
+     * To store the value to the default key-value store, you can use the {@link KeyValueStore.setValue} function.
      *
-     * For more information, see  {@apilink KeyValueStore.open}
-     * and  {@apilink KeyValueStore.getValue}.
+     * For more information, see  {@link KeyValueStore.open}
+     * and  {@link KeyValueStore.getValue}.
      *
      * @param key Unique record key.
      * @param defaultValue Fallback that will be returned if no value if present in the storage.
@@ -304,16 +304,16 @@ export declare class KeyValueStore {
      */
     static getValue<T = unknown>(key: string, defaultValue: T): Promise<T>;
     /**
-     * Tests whether a record with the given key exists in the default {@apilink KeyValueStore} associated with the current crawler run.
+     * Tests whether a record with the given key exists in the default {@link KeyValueStore} associated with the current crawler run.
      * @param key The queried record key.
      * @returns `true` if the record exists, `false` if it does not.
      */
     static recordExists(key: string): Promise<boolean>;
     static getAutoSavedValue<T extends Dictionary = Dictionary>(key: string, defaultValue?: T): Promise<T>;
     /**
-     * Stores or deletes a value in the default {@apilink KeyValueStore} associated with the current crawler run.
+     * Stores or deletes a value in the default {@link KeyValueStore} associated with the current crawler run.
      *
-     * This is just a convenient shortcut for  {@apilink KeyValueStore.setValue}.
+     * This is just a convenient shortcut for  {@link KeyValueStore.setValue}.
      * For example, calling the following code:
      * ```javascript
      * await KeyValueStore.setValue('OUTPUT', { foo: "bar" });
@@ -325,10 +325,10 @@ export declare class KeyValueStore {
      * await store.setValue('OUTPUT', { foo: "bar" });
      * ```
      *
-     * To get a value from the default key-value store, you can use the  {@apilink KeyValueStore.getValue} function.
+     * To get a value from the default key-value store, you can use the  {@link KeyValueStore.getValue} function.
      *
-     * For more information, see  {@apilink KeyValueStore.open}
-     * and  {@apilink KeyValueStore.getValue}.
+     * For more information, see  {@link KeyValueStore.open}
+     * and  {@link KeyValueStore.getValue}.
      *
      * @param key
      *   Unique record key.
@@ -343,16 +343,16 @@ export declare class KeyValueStore {
      */
     static setValue<T>(key: string, value: T | null, options?: RecordOptions): Promise<void>;
     /**
-     * Gets the crawler input value from the default {@apilink KeyValueStore} associated with the current crawler run.
+     * Gets the crawler input value from the default {@link KeyValueStore} associated with the current crawler run.
      * By default, it will try to find root input files (either extension-less, `.json` or `.txt`),
-     * or alternatively read the input from the default {@apilink KeyValueStore}.
+     * or alternatively read the input from the default {@link KeyValueStore}.
      *
      * Note that the `getInput()` function does not cache the value read from the key-value store.
      * If you need to use the input multiple times in your crawler,
      * it is far more efficient to read it once and store it locally.
      *
-     * For more information, see {@apilink KeyValueStore.open}
-     * and {@apilink KeyValueStore.getValue}.
+     * For more information, see {@link KeyValueStore.open}
+     * and {@link KeyValueStore.getValue}.
      *
      * @returns
      *   Returns a promise that resolves to an object, string
@@ -364,13 +364,13 @@ export declare class KeyValueStore {
     static getInput<T = Dictionary | string | Buffer>(): Promise<T | null>;
 }
 /**
- * User-function used in the  {@apilink KeyValueStore.forEachKey} method.
+ * User-function used in the  {@link KeyValueStore.forEachKey} method.
  */
 export interface KeyConsumer {
     /**
-     * @param key Current {@apilink KeyValueStore} key being processed.
-     * @param index Position of the current key in {@apilink KeyValueStore}.
-     * @param info Information about the current {@apilink KeyValueStore} entry.
+     * @param key Current {@link KeyValueStore} key being processed.
+     * @param index Position of the current key in {@link KeyValueStore}.
+     * @param info Information about the current {@link KeyValueStore} entry.
      * @param info.size Size of the value associated with the current key in bytes.
      */
     (key: string, index: number, info: {

package/storages/key_value_store.js

@@ -48,16 +48,16 @@ exports.maybeStringify = maybeStringify;
  * for saving screenshots, crawler inputs and outputs, web pages, PDFs or to persist the state of crawlers.
  *
  * Do not instantiate this class directly, use the
- * {@apilink KeyValueStore.open} function instead.
+ * {@link KeyValueStore.open} function instead.
  *
  * Each crawler run is associated with a default key-value store, which is created exclusively
  * for the run. By convention, the crawler input and output are stored into the
  * default key-value store under the `INPUT` and `OUTPUT` key, respectively.
  * Typically, input and output are JSON files, although it can be any other format.
  * To access the default key-value store directly, you can use the
- * {@apilink KeyValueStore.getValue} and {@apilink KeyValueStore.setValue} convenience functions.
+ * {@link KeyValueStore.getValue} and {@link KeyValueStore.setValue} convenience functions.
  *
- * To access the input, you can also use the {@apilink KeyValueStore.getInput} convenience function.
+ * To access the input, you can also use the {@link KeyValueStore.getInput} convenience function.
  *
  * `KeyValueStore` stores its data on a local disk.
  *
@@ -164,7 +164,7 @@ class KeyValueStore {
      * If the record does not exist, the function resolves to `null`.
      *
      * To save or delete a value in the key-value store, use the
-     * {@apilink KeyValueStore.setValue} function.
+     * {@link KeyValueStore.setValue} function.
      *
      * **Example usage:**
      *
@@ -254,7 +254,7 @@ class KeyValueStore {
      * regardless whether the record existed or not.
      *
      * To retrieve a value from the key-value store, use the
-     * {@apilink KeyValueStore.getValue} function.
+     * {@link KeyValueStore.getValue} function.
      *
      * **IMPORTANT:** Always make sure to use the `await` keyword when calling `setValue()`,
      * otherwise the crawler process might finish before the value is stored!
@@ -376,13 +376,13 @@ class KeyValueStore {
         return `file://${process.cwd()}/storage/key_value_stores/${name}/${key}`;
     }
     /**
-     * Opens a key-value store and returns a promise resolving to an instance of the {@apilink KeyValueStore} class.
+     * Opens a key-value store and returns a promise resolving to an instance of the {@link KeyValueStore} class.
      *
      * Key-value stores are used to store records or files, along with their MIME content type.
      * The records are stored and retrieved using a unique key.
      * The actual data is stored either on a local filesystem or in the Apify cloud.
      *
-     * For more details and code examples, see the {@apilink KeyValueStore} class.
+     * For more details and code examples, see the {@link KeyValueStore} class.
      *
      * @param [storeIdOrName]
      *   ID or name of the key-value store to be opened. If `null` or `undefined`,
@@ -403,9 +403,9 @@ class KeyValueStore {
         return manager.openStorage(storeIdOrName, options.storageClient);
     }
     /**
-     * Gets a value from the default {@apilink KeyValueStore} associated with the current crawler run.
+     * Gets a value from the default {@link KeyValueStore} associated with the current crawler run.
      *
-     * This is just a convenient shortcut for {@apilink KeyValueStore.getValue}.
+     * This is just a convenient shortcut for {@link KeyValueStore.getValue}.
      * For example, calling the following code:
      * ```javascript
      * const value = await KeyValueStore.getValue('my-key');
@@ -417,10 +417,10 @@ class KeyValueStore {
      * const value = await store.getValue('my-key');
      * ```
      *
-     * To store the value to the default key-value store, you can use the {@apilink KeyValueStore.setValue} function.
+     * To store the value to the default key-value store, you can use the {@link KeyValueStore.setValue} function.
      *
-     * For more information, see  {@apilink KeyValueStore.open}
-     * and  {@apilink KeyValueStore.getValue}.
+     * For more information, see  {@link KeyValueStore.open}
+     * and  {@link KeyValueStore.getValue}.
      *
      * @param key Unique record key.
      * @param defaultValue Fallback that will be returned if no value if present in the storage.
@@ -436,7 +436,7 @@ class KeyValueStore {
         return store.getValue(key, defaultValue);
     }
     /**
-     * Tests whether a record with the given key exists in the default {@apilink KeyValueStore} associated with the current crawler run.
+     * Tests whether a record with the given key exists in the default {@link KeyValueStore} associated with the current crawler run.
      * @param key The queried record key.
      * @returns `true` if the record exists, `false` if it does not.
      */
@@ -449,9 +449,9 @@ class KeyValueStore {
         return store.getAutoSavedValue(key, defaultValue);
     }
     /**
-     * Stores or deletes a value in the default {@apilink KeyValueStore} associated with the current crawler run.
+     * Stores or deletes a value in the default {@link KeyValueStore} associated with the current crawler run.
      *
-     * This is just a convenient shortcut for  {@apilink KeyValueStore.setValue}.
+     * This is just a convenient shortcut for  {@link KeyValueStore.setValue}.
      * For example, calling the following code:
      * ```javascript
      * await KeyValueStore.setValue('OUTPUT', { foo: "bar" });
@@ -463,10 +463,10 @@ class KeyValueStore {
      * await store.setValue('OUTPUT', { foo: "bar" });
      * ```
      *
-     * To get a value from the default key-value store, you can use the  {@apilink KeyValueStore.getValue} function.
+     * To get a value from the default key-value store, you can use the  {@link KeyValueStore.getValue} function.
      *
-     * For more information, see  {@apilink KeyValueStore.open}
-     * and  {@apilink KeyValueStore.getValue}.
+     * For more information, see  {@link KeyValueStore.open}
+     * and  {@link KeyValueStore.getValue}.
      *
      * @param key
      *   Unique record key.
@@ -484,16 +484,16 @@ class KeyValueStore {
         return store.setValue(key, value, options);
     }
     /**
-     * Gets the crawler input value from the default {@apilink KeyValueStore} associated with the current crawler run.
+     * Gets the crawler input value from the default {@link KeyValueStore} associated with the current crawler run.
      * By default, it will try to find root input files (either extension-less, `.json` or `.txt`),
-     * or alternatively read the input from the default {@apilink KeyValueStore}.
+     * or alternatively read the input from the default {@link KeyValueStore}.
      *
      * Note that the `getInput()` function does not cache the value read from the key-value store.
      * If you need to use the input multiple times in your crawler,
      * it is far more efficient to read it once and store it locally.
      *
-     * For more information, see {@apilink KeyValueStore.open}
-     * and {@apilink KeyValueStore.getValue}.
+     * For more information, see {@link KeyValueStore.open}
+     * and {@link KeyValueStore.getValue}.
      *
      * @returns
      *   Returns a promise that resolves to an object, string