apify 3.4.0 → 3.4.1-beta.29

package/{actor.d.ts → dist/actor.d.ts}

@@ -3,37 +3,257 @@ import { Dataset, RequestQueue } from '@crawlee/core';
 import type { Awaitable, Dictionary, SetStatusMessageOptions, StorageClient } from '@crawlee/types';
 import type { ActorCallOptions, ApifyClientOptions, RunAbortOptions, TaskCallOptions, Webhook, WebhookEventType } from 'apify-client';
 import { ActorRun as ClientActorRun, ApifyClient } from 'apify-client';
-import { ChargingManager } from './charging';
-import type { ChargeOptions, ChargeResult } from './charging';
-import { Configuration } from './configuration';
-import { KeyValueStore } from './key_value_store';
-import type { ProxyConfigurationOptions } from './proxy_configuration';
-import { ProxyConfiguration } from './proxy_configuration';
+import type { ChargeOptions, ChargeResult } from './charging.js';
+import { ChargingManager } from './charging.js';
+import { Configuration } from './configuration.js';
+import { KeyValueStore } from './key_value_store.js';
+import type { ProxyConfigurationOptions } from './proxy_configuration.js';
+import { ProxyConfiguration } from './proxy_configuration.js';
+export interface InitOptions {
+    storage?: StorageClient;
+}
+export interface ExitOptions {
+    /** Exit with given status message */
+    statusMessage?: string;
+    /**
+     * Amount of time, in seconds, to wait for all event handlers to finish before exiting the process.
+     * @default 30
+     */
+    timeoutSecs?: number;
+    /** Exit code, defaults to 0 */
+    exitCode?: number;
+    /** Call `process.exit()`? Defaults to true */
+    exit?: boolean;
+}
+export interface MainOptions extends ExitOptions, InitOptions {
+}
+/**
+ * Parsed representation of the Apify environment variables.
+ * This object is returned by the {@link Actor.getEnv} function.
+ */
+export interface ApifyEnv {
+    /**
+     * ID of the Actor (ACTOR_ID)
+     */
+    actorId: string | null;
+    /**
+     * ID of the Actor run (ACTOR_RUN_ID)
+     */
+    actorRunId: string | null;
+    /**
+     * ID of the Actor task (ACTOR_TASK_ID)
+     */
+    actorTaskId: string | null;
+    /**
+     * ID of the Actor build used in the run. (ACTOR_BUILD_ID)
+     */
+    actorBuildId: string | null;
+    /**
+     * ID of the user who started the Actor - note that it might be
+     * different than the owner of the Actor (APIFY_USER_ID)
+     */
+    userId: string | null;
+    /**
+     * Authentication token representing privileges given to the Actor run,
+     * it can be passed to various Apify APIs (APIFY_TOKEN)
+     */
+    token: string | null;
+    /**
+     * Date when the Actor was started (ACTOR_STARTED_AT)
+     */
+    startedAt: Date | null;
+    /**
+     * Date when the Actor will time out (ACTOR_TIMEOUT_AT)
+     */
+    timeoutAt: Date | null;
+    /**
+     * ID of the key-value store where input and output data of this
+     * Actor is stored (ACTOR_DEFAULT_KEY_VALUE_STORE_ID)
+     */
+    defaultKeyValueStoreId: string | null;
+    /**
+     * ID of the dataset where input and output data of this
+     * Actor is stored (ACTOR_DEFAULT_DATASET_ID)
+     */
+    defaultDatasetId: string | null;
+    /**
+     * Amount of memory allocated for the Actor,
+     * in megabytes (ACTOR_MEMORY_MBYTES)
+     */
+    memoryMbytes: number | null;
+    /**
+     * If set to "1", the web browsers inside the Actor should run in headless
+     * mode because there is no windowing system available. (APIFY_HEADLESS)
+     */
+    headless: string | null;
+    /**
+     * Is set to "1" if the Actor is running on Apify servers.
+     * (APIFY_IS_AT_HOME)
+     */
+    isAtHome: string | null;
+    /**
+     * The Apify Proxy password of the user who started the Actor. (APIFY_PROXY_PASSWORD)
+     */
+    proxyPassword: string | null;
+    proxyHostname: string | null;
+    proxyPort: string | null;
+    /**
+     * You can visit this page to troubleshoot your proxy connection. (APIFY_PROXY_STATUS_URL)
+     */
+    proxyStatusUrl: string | null;
+    apiBaseUrl: string | null;
+    apiPublicBaseUrl: string | null;
+    chromeExecutablePath: string | null;
+    dedicatedCpus: string | null;
+    disableOutdatedWarning: 1 | null;
+    fact: string | null;
+    inputSecretsPrivateKeyFile: string | null;
+    inputSecretsPrivateKeyPassphrase: string | null;
+    /**
+     * Defines the path to a local directory where KeyValueStore, Dataset, and RequestQueue
+     * store their data. Typically, it is set to ./storage. If omitted, you should define the
+     * APIFY_TOKEN environment variable instead. See more info on combination of this and
+     * APIFY_TOKEN [here](https://docs.apify.com/sdk/js/docs/guides/environment-variables#combinations-of-apify_local_storage_dir-and-apify_token)(CRAWLEE_STORAGE_DIR)
+     */
+    localStorageDir: string | null;
+    /**
+     * Specifies the minimum log level, which can be one of the following values (in order of severity): DEBUG, INFO, WARNING and ERROR
+     * (APIFY_LOG_LEVEL)
+     */
+    logLevel: string | null;
+    logFormat: string | null;
+    /**
+     * Origin for the Actor run, i.e. how it was started. See [here](https://docs.apify.com/sdk/python/reference/enum/MetaOrigin)
+     * for more details. (APIFY_META_ORIGIN)
+     */
+    metaOrigin: string | null;
+    /**
+     * The key of the input record in the Actor’s default key-value store (ACTOR_INPUT_KEY)
+     */
+    inputKey: string | null;
+    sdkLatestVersion: string | null;
+    systemInfoIntervalMillis: string | null;
+    workflowKey: string | null;
+    actorBuildNumber: string | null;
+    actorEventsWsUrl: string | null;
+    actorMaxPaidDatasetItems: number | null;
+    containerPort: number | null;
+    containerUrl: string | null;
+    defaultRequestQueueId: string | null;
+}
+export type UserFunc<T = unknown> = () => Awaitable<T>;
+export interface CallOptions extends ActorCallOptions {
+    /**
+     * User API token that is used to run the Actor. By default, it is taken from the `APIFY_TOKEN` environment variable.
+     */
+    token?: string;
+}
+export interface CallTaskOptions extends TaskCallOptions {
+    /**
+     * User API token that is used to run the Actor. By default, it is taken from the `APIFY_TOKEN` environment variable.
+     */
+    token?: string;
+}
+export interface AbortOptions extends RunAbortOptions {
+    /**
+     * User API token that is used to run the Actor. By default, it is taken from the `APIFY_TOKEN` environment variable.
+     */
+    token?: string;
+    /** Exit with given status message */
+    statusMessage?: string;
+}
+export interface WebhookOptions {
+    /**
+     * Array of event types, which you can set for Actor run, see
+     * the [Actor run events](https://docs.apify.com/webhooks/events#actor-run) in the Apify doc.
+     */
+    eventTypes: readonly WebhookEventType[];
+    /**
+     * URL which will be requested using HTTP POST request, when Actor run will reach the set event type.
+     */
+    requestUrl: string;
+    /**
+     * Payload template is a JSON-like string that describes the structure of the webhook POST request payload.
+     * It uses JSON syntax, extended with a double curly braces syntax for injecting variables `{{variable}}`.
+     * Those variables are resolved at the time of the webhook's dispatch, and a list of available variables with their descriptions
+     * is available in the [Apify webhook documentation](https://docs.apify.com/webhooks).
+     * If `payloadTemplate` is omitted, the default payload template is used
+     * ([view docs](https://docs.apify.com/webhooks/actions#payload-template)).
+     */
+    payloadTemplate?: string;
+    /**
+     * Idempotency key enables you to ensure that a webhook will not be added multiple times in case of
+     * an Actor restart or other situation that would cause the `addWebhook()` function to be called again.
+     * We suggest using the Actor run ID as the idempotency key. You can get the run ID by calling
+     * {@link Actor.getEnv} function.
+     */
+    idempotencyKey?: string;
+}
+export interface MetamorphOptions {
+    /**
+     * Content type for the `input`. If not specified,
+     * `input` is expected to be an object that will be stringified to JSON and content type set to
+     * `application/json; charset=utf-8`. If `options.contentType` is specified, then `input` must be a
+     * `String` or `Buffer`.
+     */
+    contentType?: string;
+    /**
+     * Tag or number of the target Actor build to metamorph into (e.g. `beta` or `1.2.345`).
+     * If not provided, the run uses build tag or number from the default Actor run configuration (typically `latest`).
+     */
+    build?: string;
+    /** @internal */
+    customAfterSleepMillis?: number;
+}
+export interface RebootOptions {
+    /** @internal */
+    customAfterSleepMillis?: number;
+}
+export interface OpenStorageOptions {
+    /**
+     * If set to `true` then the cloud storage is used even if the `CRAWLEE_STORAGE_DIR`
+     * environment variable is set. This way it is possible to combine local and cloud storage.
+     * @default false
+     */
+    forceCloud?: boolean;
+}
+export { ClientActorRun as ActorRun };
+/**
+ * Exit codes for the Actor process.
+ * The error codes must be in the range 1-128, to avoid collision with signal exits
+ * and to ensure Docker will handle them correctly!
+ * @internal should be removed if we decide to remove `Actor.main()`
+ */
+export declare const EXIT_CODES: {
+    SUCCESS: number;
+    ERROR_USER_FUNCTION_THREW: number;
+    ERROR_UNKNOWN: number;
+};
 /**
  * `Actor` class serves as an alternative approach to the static helpers exported from the package. It allows to pass configuration
  * that will be used on the instance methods. Environment variables will have precedence over this configuration.
- * See {@apilink Configuration} for details about what can be configured and what are the default values.
+ * See {@link Configuration} for details about what can be configured and what are the default values.
  */
 export declare class Actor<Data extends Dictionary = Dictionary> {
     /** @internal */
     static _instance: Actor;
     /**
-     * Configuration of this SDK instance (provided to its constructor). See {@apilink Configuration} for details.
+     * Configuration of this SDK instance (provided to its constructor). See {@link Configuration} for details.
      * @internal
      */
     readonly config: Configuration;
     /**
-     * Default {@apilink ApifyClient} instance.
+     * Default {@link ApifyClient} instance.
      * @internal
      */
     readonly apifyClient: ApifyClient;
     /**
-     * Default {@apilink EventManager} instance.
+     * Default {@link EventManager} instance.
      * @internal
      */
     readonly eventManager: EventManager;
     /**
-     * Whether the Actor instance was initialized. This is set by calling {@apilink Actor.init}.
+     * Whether the Actor instance was initialized. This is set by calling {@link Actor.init}.
      */
     initialized: boolean;
     /**
@@ -64,7 +284,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      * - When running on the Apify platform (i.e. `APIFY_IS_AT_HOME` environment variable is set),
      *   it sets up a connection to listen for platform events.
      *   For example, to get a notification about an imminent migration to another server.
-     *   See {@apilink Actor.events} for details.
+     *   See {@link Actor.events} for details.
      * - It invokes the user function passed as the `userFunc` parameter.
      * - If the user function returned a promise, waits for it to resolve.
      * - If the user function throws an exception or some other error is encountered,
@@ -133,9 +353,9 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
     /**
      * Runs an Actor on the Apify platform using the current user account (determined by the `APIFY_TOKEN` environment variable).
      *
-     * The result of the function is an {@apilink ActorRun} object that contains details about the Actor run.
+     * The result of the function is an {@link ActorRun} object that contains details about the Actor run.
      *
-     * If you want to run an Actor task rather than an Actor, please use the {@apilink Actor.callTask} function instead.
+     * If you want to run an Actor task rather than an Actor, please use the {@link Actor.callTask} function instead.
      *
      * For more information about Actors, read the [documentation](https://docs.apify.com/actor).
      *
@@ -159,7 +379,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      * Runs an Actor on the Apify platform using the current user account (determined by the `APIFY_TOKEN` environment variable),
      * unlike `Actor.call`, this method just starts the run without waiting for finish.
      *
-     * The result of the function is an {@apilink ActorRun} object that contains details about the Actor run.
+     * The result of the function is an {@link ActorRun} object that contains details about the Actor run.
      *
      * For more information about Actors, read the
      * [documentation](https://docs.apify.com/actor).
@@ -183,7 +403,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
     /**
      * Aborts given Actor run on the Apify platform using the current user account (determined by the `APIFY_TOKEN` environment variable).
      *
-     * The result of the function is an {@apilink ActorRun} object that contains details about the Actor run.
+     * The result of the function is an {@link ActorRun} object that contains details about the Actor run.
      *
      * For more information about Actors, read the
      * [documentation](https://docs.apify.com/actor).
@@ -199,11 +419,11 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
     /**
      * Runs an actor task on the Apify platform using the current user account (determined by the `APIFY_TOKEN` environment variable).
      *
-     * The result of the function is an {@apilink ActorRun} object that contains details about the Actor run.
+     * The result of the function is an {@link ActorRun} object that contains details about the Actor run.
      *
      * Note that an Actor task is a saved input configuration and options for an Actor.
      * If you want to run an Actor directly rather than an Actor task, please use the
-     * {@apilink Actor.call} function instead.
+     * {@link Actor.call} function instead.
      *
      * For more information about Actor tasks, read the [documentation](https://docs.apify.com/tasks).
      *
@@ -268,9 +488,9 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      */
     setStatusMessage(statusMessage: string, options?: SetStatusMessageOptions): Promise<ClientActorRun>;
     /**
-     * Stores an object or an array of objects to the default {@apilink Dataset} of the current Actor run.
+     * Stores an object or an array of objects to the default {@link Dataset} of the current Actor 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:
      * ```js
      * await Actor.pushData({ myValue: 123 });
@@ -282,7 +502,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      * await dataset.pushData({ myValue: 123 });
      * ```
      *
-     * For more information, see {@apilink Actor.openDataset} and {@apilink Dataset.pushData}
+     * For more information, see {@link Actor.openDataset} and {@link Dataset.pushData}
      *
      * **IMPORTANT**: Make sure to use the `await` keyword when calling `pushData()`,
      * otherwise the Actor process might finish before the data are stored!
@@ -293,9 +513,9 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      */
     pushData(item: Data | Data[]): Promise<void>;
     /**
-     * Stores an object or an array of objects to the default {@apilink Dataset} of the current Actor run.
+     * Stores an object or an array of objects to the default {@link Dataset} of the current Actor 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:
      * ```js
      * await Actor.pushData({ myValue: 123 });
@@ -307,7 +527,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      * await dataset.pushData({ myValue: 123 });
      * ```
      *
-     * For more information, see {@apilink Actor.openDataset} and {@apilink Dataset.pushData}
+     * For more information, see {@link Actor.openDataset} and {@link Dataset.pushData}
      *
      * **IMPORTANT**: Make sure to use the `await` keyword when calling `pushData()`,
      * otherwise the Actor process might finish before the data are stored!
@@ -319,13 +539,13 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      */
     pushData(item: Data | Data[], eventName: string): Promise<ChargeResult>;
     /**
-     * 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`,
@@ -335,9 +555,9 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      */
     openDataset(datasetIdOrName?: string | null, options?: OpenStorageOptions): Promise<Dataset<Data>>;
     /**
-     * Gets a value from the default {@apilink KeyValueStore} associated with the current Actor run.
+     * Gets a value from the default {@link KeyValueStore} associated with the current Actor 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:
      * ```js
      * const value = await Actor.getValue('my-key');
@@ -349,10 +569,10 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      * const value = await store.getValue('my-key');
      * ```
      *
-     * To store the value to the default key-value store, you can use the {@apilink Actor.setValue} function.
+     * To store the value to the default key-value store, you can use the {@link Actor.setValue} function.
      *
-     * For more information, see  {@apilink Actor.openKeyValueStore}
-     * and  {@apilink KeyValueStore.getValue}.
+     * For more information, see  {@link Actor.openKeyValueStore}
+     * and  {@link KeyValueStore.getValue}.
      *
      * @param key Unique record key.
      * @returns
@@ -364,9 +584,9 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      */
     getValue<T = unknown>(key: string): Promise<T | null>;
     /**
-     * Stores or deletes a value in the default {@apilink KeyValueStore} associated with the current Actor run.
+     * Stores or deletes a value in the default {@link KeyValueStore} associated with the current Actor 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:
      * ```js
      * await Actor.setValue('OUTPUT', { foo: "bar" });
@@ -378,10 +598,10 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      * await store.setValue('OUTPUT', { foo: "bar" });
      * ```
      *
-     * To get a value from the default key-value store, you can use the  {@apilink Actor.getValue} function.
+     * To get a value from the default key-value store, you can use the  {@link Actor.getValue} function.
      *
-     * For more information, see  {@apilink Actor.openKeyValueStore}
-     * and  {@apilink KeyValueStore.getValue}.
+     * For more information, see  {@link Actor.openKeyValueStore}
+     * and  {@link KeyValueStore.getValue}.
      *
      * @param key
      *   Unique record key.
@@ -396,7 +616,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      */
     setValue<T>(key: string, value: T | null, options?: RecordOptions): Promise<void>;
     /**
-     * Gets the Actor input value from the default {@apilink KeyValueStore} associated with the current Actor run.
+     * Gets the Actor input value from the default {@link KeyValueStore} associated with the current Actor run.
      *
      * This is just a convenient shortcut for [`keyValueStore.getValue('INPUT')`](core/class/KeyValueStore#getValue).
      * For example, calling the following code:
@@ -414,8 +634,8 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      * If you need to use the input multiple times in your Actor,
      * it is far more efficient to read it once and store it locally.
      *
-     * For more information, see  {@apilink Actor.openKeyValueStore}
-     * and {@apilink KeyValueStore.getValue}.
+     * For more information, see  {@link Actor.openKeyValueStore}
+     * and {@link KeyValueStore.getValue}.
      *
      * @returns
      *   Returns a promise that resolves to an object, string
@@ -426,18 +646,18 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      */
     getInput<T = Dictionary | string | Buffer>(): Promise<T | null>;
     /**
-     * Gets the Actor input value just like the {@apilink Actor.getInput} method,
+     * Gets the Actor input value just like the {@link Actor.getInput} method,
      * but throws if it is not found.
      */
     getInputOrThrow<T = Dictionary | string | Buffer>(): Promise<T>;
     /**
-     * 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`,
@@ -448,14 +668,14 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
     openKeyValueStore(storeIdOrName?: string | null, options?: OpenStorageOptions): Promise<KeyValueStore>;
     /**
      * Opens a request queue and returns a promise resolving to an instance
-     * of the {@apilink RequestQueue} class.
+     * of the {@link RequestQueue} class.
      *
-     * {@apilink RequestQueue} represents a queue of URLs to crawl, which is stored either on local filesystem or in the cloud.
+     * {@link RequestQueue} represents a queue of URLs to crawl, which is stored either on local filesystem or in the cloud.
      * The queue is used for deep crawling of websites, where you start with several URLs and then
      * recursively follow links to other pages. The data structure supports both breadth-first
      * and depth-first crawling orders.
      *
-     * For more details and code examples, see the {@apilink RequestQueue} class.
+     * For more details and code examples, see the {@link RequestQueue} class.
      *
      * @param [queueIdOrName]
      *   ID or name of the request queue to be opened. If `null` or `undefined`,
@@ -466,13 +686,13 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
     openRequestQueue(queueIdOrName?: string | null, options?: OpenStorageOptions): Promise<RequestQueue>;
     /**
      * Creates a proxy configuration and returns a promise resolving to an instance
-     * of the {@apilink ProxyConfiguration} class that is already initialized.
+     * of the {@link ProxyConfiguration} class that is already initialized.
      *
      * 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.
      *
-     * For more details and code examples, see the {@apilink ProxyConfiguration} class.
+     * For more details and code examples, see the {@link ProxyConfiguration} class.
      *
      * ```js
      *
@@ -516,11 +736,11 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      */
     getChargingManager(): ChargingManager;
     /**
-     * Modifies Actor env vars so parsing respects the structure of {@apilink ApifyEnv} interface.
+     * Modifies Actor env vars so parsing respects the structure of {@link ApifyEnv} interface.
      */
     private getModifiedActorEnvVars;
     /**
-     * Returns a new {@apilink ApifyEnv} object which contains information parsed from all the Apify environment variables.
+     * Returns a new {@link ApifyEnv} object which contains information parsed from all the Apify environment variables.
      *
      * For the list of the Apify environment variables, see
      * [Actor documentation](https://docs.apify.com/actor/run#environment-variables).
@@ -579,7 +799,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      * - When running on the Apify platform (i.e. `APIFY_IS_AT_HOME` environment variable is set),
      *   it sets up a connection to listen for platform events.
      *   For example, to get a notification about an imminent migration to another server.
-     *   See {@apilink Actor.events} for details.
+     *   See {@link Actor.events} for details.
      * - It invokes the user function passed as the `userFunc` parameter.
      * - If the user function returned a promise, waits for it to resolve.
      * - If the user function throws an exception or some other error is encountered,
@@ -632,7 +852,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      * from 25% to 100% on the platform.
      *
      * Calling `Actor.exit()` is required if you use the `Actor.init()` method, since it opens websocket connection
-     * (see {@apilink Actor.events} for details), which needs to be terminated for the code to finish.
+     * (see {@link Actor.events} for details), which needs to be terminated for the code to finish.
      *
      * ```js
      * import { gotScraping } from 'got-scraping';
@@ -665,9 +885,9 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
     /**
      * Runs an Actor on the Apify platform using the current user account (determined by the `APIFY_TOKEN` environment variable).
      *
-     * The result of the function is an {@apilink ActorRun} object that contains details about the Actor run.
+     * The result of the function is an {@link ActorRun} object that contains details about the Actor run.
      *
-     * If you want to run an Actor task rather than an Actor, please use the {@apilink Actor.callTask} function instead.
+     * If you want to run an Actor task rather than an Actor, please use the {@link Actor.callTask} function instead.
      *
      * For more information about Actors, read the [documentation](https://docs.apify.com/actor).
      *
@@ -689,11 +909,11 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
     /**
      * Runs an Actor task on the Apify platform using the current user account (determined by the `APIFY_TOKEN` environment variable).
      *
-     * The result of the function is an {@apilink ActorRun} object that contains details about the Actor run.
+     * The result of the function is an {@link ActorRun} object that contains details about the Actor run.
      *
      * Note that an Actor task is a saved input configuration and options for an Actor.
      * If you want to run an Actor directly rather than an Actor task, please use the
-     * {@apilink Actor.call} function instead.
+     * {@link Actor.call} function instead.
      *
      * For more information about Actor tasks, read the [documentation](https://docs.apify.com/tasks).
      *
@@ -716,7 +936,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      * Runs an Actor on the Apify platform using the current user account (determined by the `APIFY_TOKEN` environment variable),
      * unlike `Actor.call`, this method just starts the run without waiting for finish.
      *
-     * The result of the function is an {@apilink ActorRun} object that contains details about the Actor run.
+     * The result of the function is an {@link ActorRun} object that contains details about the Actor run.
      *
      * For more information about Actors, read the
      * [documentation](https://docs.apify.com/actor).
@@ -739,7 +959,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
     /**
      * Aborts given Actor run on the Apify platform using the current user account (determined by the `APIFY_TOKEN` environment variable).
      *
-     * The result of the function is an {@apilink ActorRun} object that contains details about the Actor run.
+     * The result of the function is an {@link ActorRun} object that contains details about the Actor run.
      *
      * For more information about Actors, read the
      * [documentation](https://docs.apify.com/actor).
@@ -795,9 +1015,9 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      */
     static setStatusMessage(statusMessage: string, options?: SetStatusMessageOptions): Promise<ClientActorRun>;
     /**
-     * Stores an object or an array of objects to the default {@apilink Dataset} of the current Actor run.
+     * Stores an object or an array of objects to the default {@link Dataset} of the current Actor 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:
      * ```js
      * await Actor.pushData({ myValue: 123 });
@@ -809,7 +1029,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      * await dataset.pushData({ myValue: 123 });
      * ```
      *
-     * For more information, see {@apilink Actor.openDataset} and {@apilink Dataset.pushData}
+     * For more information, see {@link Actor.openDataset} and {@link Dataset.pushData}
      *
      * **IMPORTANT**: Make sure to use the `await` keyword when calling `pushData()`,
      * otherwise the Actor process might finish before the data are stored!
@@ -819,9 +1039,9 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      */
     static pushData<Data extends Dictionary = Dictionary>(item: Data | Data[]): Promise<void>;
     /**
-     * Stores an object or an array of objects to the default {@apilink Dataset} of the current Actor run.
+     * Stores an object or an array of objects to the default {@link Dataset} of the current Actor 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:
      * ```js
      * await Actor.pushData({ myValue: 123 });
@@ -833,7 +1053,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      * await dataset.pushData({ myValue: 123 });
      * ```
      *
-     * For more information, see {@apilink Actor.openDataset} and {@apilink Dataset.pushData}
+     * For more information, see {@link Actor.openDataset} and {@link Dataset.pushData}
      *
      * **IMPORTANT**: Make sure to use the `await` keyword when calling `pushData()`,
      * otherwise the Actor process might finish before the data are stored!
@@ -844,13 +1064,13 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      */
     static pushData<Data extends Dictionary = Dictionary>(item: Data | Data[], eventName: string): Promise<ChargeResult>;
     /**
-     * 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`,
@@ -859,9 +1079,9 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      */
     static openDataset<Data extends Dictionary = Dictionary>(datasetIdOrName?: string | null, options?: OpenStorageOptions): Promise<Dataset<Data>>;
     /**
-     * Gets a value from the default {@apilink KeyValueStore} associated with the current Actor run.
+     * Gets a value from the default {@link KeyValueStore} associated with the current Actor 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:
      * ```js
      * const value = await Actor.getValue('my-key');
@@ -873,10 +1093,10 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      * const value = await store.getValue('my-key');
      * ```
      *
-     * To store the value to the default key-value store, you can use the {@apilink Actor.setValue} function.
+     * To store the value to the default key-value store, you can use the {@link Actor.setValue} function.
      *
-     * For more information, see  {@apilink Actor.openKeyValueStore}
-     * and  {@apilink KeyValueStore.getValue}.
+     * For more information, see  {@link Actor.openKeyValueStore}
+     * and  {@link KeyValueStore.getValue}.
      *
      * @param key Unique record key.
      * @returns
@@ -887,9 +1107,9 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      */
     static getValue<T = unknown>(key: string): Promise<T | null>;
     /**
-     * Stores or deletes a value in the default {@apilink KeyValueStore} associated with the current Actor run.
+     * Stores or deletes a value in the default {@link KeyValueStore} associated with the current Actor 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:
      * ```js
      * await Actor.setValue('OUTPUT', { foo: "bar" });
@@ -901,10 +1121,10 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      * await store.setValue('OUTPUT', { foo: "bar" });
      * ```
      *
-     * To get a value from the default key-value store, you can use the  {@apilink Actor.getValue} function.
+     * To get a value from the default key-value store, you can use the  {@link Actor.getValue} function.
      *
-     * For more information, see  {@apilink Actor.openKeyValueStore}
-     * and  {@apilink KeyValueStore.getValue}.
+     * For more information, see  {@link Actor.openKeyValueStore}
+     * and  {@link KeyValueStore.getValue}.
      *
      * @param key
      *   Unique record key.
@@ -918,9 +1138,9 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      */
     static setValue<T>(key: string, value: T | null, options?: RecordOptions): Promise<void>;
     /**
-     * Gets the Actor input value from the default {@apilink KeyValueStore} associated with the current Actor run.
+     * Gets the Actor input value from the default {@link KeyValueStore} associated with the current Actor run.
      *
-     * This is just a convenient shortcut for {@apilink KeyValueStore.getValue | `keyValueStore.getValue('INPUT')`}.
+     * This is just a convenient shortcut for {@link KeyValueStore.getValue | `keyValueStore.getValue('INPUT')`}.
      * For example, calling the following code:
      * ```js
      * const input = await Actor.getInput();
@@ -936,7 +1156,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      * If you need to use the input multiple times in your Actor,
      * it is far more efficient to read it once and store it locally.
      *
-     * For more information, see {@apilink Actor.openKeyValueStore} and {@apilink KeyValueStore.getValue}.
+     * For more information, see {@link Actor.openKeyValueStore} and {@link KeyValueStore.getValue}.
      *
      * @returns
      *   Returns a promise that resolves to an object, string
@@ -946,18 +1166,18 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      */
     static getInput<T = Dictionary | string | Buffer>(): Promise<T | null>;
     /**
-     * Gets the Actor input value just like the {@apilink Actor.getInput} method,
+     * Gets the Actor input value just like the {@link Actor.getInput} method,
      * but throws if it is not found.
      */
     static getInputOrThrow<T = Dictionary | string | Buffer>(): Promise<T>;
     /**
-     * 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`,
@@ -967,14 +1187,14 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
     static openKeyValueStore(storeIdOrName?: string | null, options?: OpenStorageOptions): Promise<KeyValueStore>;
     /**
      * Opens a request queue and returns a promise resolving to an instance
-     * of the {@apilink RequestQueue} class.
+     * of the {@link RequestQueue} class.
      *
-     * {@apilink RequestQueue} represents a queue of URLs to crawl, which is stored either on local filesystem or in the cloud.
+     * {@link RequestQueue} represents a queue of URLs to crawl, which is stored either on local filesystem or in the cloud.
      * The queue is used for deep crawling of websites, where you start with several URLs and then
      * recursively follow links to other pages. The data structure supports both breadth-first
      * and depth-first crawling orders.
      *
-     * For more details and code examples, see the {@apilink RequestQueue} class.
+     * For more details and code examples, see the {@link RequestQueue} class.
      *
      * @param [queueIdOrName]
      *   ID or name of the request queue to be opened. If `null` or `undefined`,
@@ -984,13 +1204,13 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
     static openRequestQueue(queueIdOrName?: string | null, options?: OpenStorageOptions): Promise<RequestQueue>;
     /**
      * Creates a proxy configuration and returns a promise resolving to an instance
-     * of the {@apilink ProxyConfiguration} class that is already initialized.
+     * of the {@link ProxyConfiguration} class that is already initialized.
      *
      * 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.
      *
-     * For more details and code examples, see the {@apilink ProxyConfiguration} class.
+     * For more details and code examples, see the {@link ProxyConfiguration} class.
      *
      * ```js
      *
@@ -1031,7 +1251,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      */
     static getChargingManager(): ChargingManager;
     /**
-     * Returns a new {@apilink ApifyEnv} object which contains information parsed from all the Apify environment variables.
+     * Returns a new {@link ApifyEnv} object which contains information parsed from all the Apify environment variables.
      *
      * For the list of the Apify environment variables, see
      * [Actor documentation](https://docs.apify.com/actor/run#environment-variables).
@@ -1050,233 +1270,13 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      * Returns `true` when code is running on Apify platform and `false` otherwise (for example locally).
      */
     static isAtHome(): boolean;
-    /** Default {@apilink ApifyClient} instance. */
+    /** Default {@link ApifyClient} instance. */
     static get apifyClient(): ApifyClient;
-    /** Default {@apilink Configuration} instance. */
+    /** Default {@link Configuration} instance. */
     static get config(): Configuration;
     /** @internal */
     static getDefaultInstance(): Actor;
     private _openStorage;
     private _ensureActorInit;
 }
-export interface InitOptions {
-    storage?: StorageClient;
-}
-export interface MainOptions extends ExitOptions, InitOptions {
-}
-/**
- * Parsed representation of the Apify environment variables.
- * This object is returned by the {@apilink Actor.getEnv} function.
- */
-export interface ApifyEnv {
-    /**
-     * ID of the Actor (ACTOR_ID)
-     */
-    actorId: string | null;
-    /**
-     * ID of the Actor run (ACTOR_RUN_ID)
-     */
-    actorRunId: string | null;
-    /**
-     * ID of the Actor task (ACTOR_TASK_ID)
-     */
-    actorTaskId: string | null;
-    /**
-     * ID of the Actor build used in the run. (ACTOR_BUILD_ID)
-     */
-    actorBuildId: string | null;
-    /**
-     * ID of the user who started the Actor - note that it might be
-     * different than the owner of the Actor (APIFY_USER_ID)
-     */
-    userId: string | null;
-    /**
-     * Authentication token representing privileges given to the Actor run,
-     * it can be passed to various Apify APIs (APIFY_TOKEN)
-     */
-    token: string | null;
-    /**
-     * Date when the Actor was started (ACTOR_STARTED_AT)
-     */
-    startedAt: Date | null;
-    /**
-     * Date when the Actor will time out (ACTOR_TIMEOUT_AT)
-     */
-    timeoutAt: Date | null;
-    /**
-     * ID of the key-value store where input and output data of this
-     * Actor is stored (ACTOR_DEFAULT_KEY_VALUE_STORE_ID)
-     */
-    defaultKeyValueStoreId: string | null;
-    /**
-     * ID of the dataset where input and output data of this
-     * Actor is stored (ACTOR_DEFAULT_DATASET_ID)
-     */
-    defaultDatasetId: string | null;
-    /**
-     * Amount of memory allocated for the Actor,
-     * in megabytes (ACTOR_MEMORY_MBYTES)
-     */
-    memoryMbytes: number | null;
-    /**
-     * If set to "1", the web browsers inside the Actor should run in headless
-     * mode because there is no windowing system available. (APIFY_HEADLESS)
-     */
-    headless: string | null;
-    /**
-     * Is set to "1" if the Actor is running on Apify servers.
-     * (APIFY_IS_AT_HOME)
-     */
-    isAtHome: string | null;
-    /**
-     * The Apify Proxy password of the user who started the Actor. (APIFY_PROXY_PASSWORD)
-     */
-    proxyPassword: string | null;
-    proxyHostname: string | null;
-    proxyPort: string | null;
-    /**
-     * You can visit this page to troubleshoot your proxy connection. (APIFY_PROXY_STATUS_URL)
-     */
-    proxyStatusUrl: string | null;
-    apiBaseUrl: string | null;
-    apiPublicBaseUrl: string | null;
-    chromeExecutablePath: string | null;
-    dedicatedCpus: string | null;
-    disableOutdatedWarning: 1 | null;
-    fact: string | null;
-    inputSecretsPrivateKeyFile: string | null;
-    inputSecretsPrivateKeyPassphrase: string | null;
-    /**
-     * Defines the path to a local directory where KeyValueStore, Dataset, and RequestQueue
-     * store their data. Typically, it is set to ./storage. If omitted, you should define the
-     * APIFY_TOKEN environment variable instead. See more info on combination of this and
-     * APIFY_TOKEN [here](https://docs.apify.com/sdk/js/docs/guides/environment-variables#combinations-of-apify_local_storage_dir-and-apify_token)(CRAWLEE_STORAGE_DIR)
-     */
-    localStorageDir: string | null;
-    /**
-     * Specifies the minimum log level, which can be one of the following values (in order of severity): DEBUG, INFO, WARNING and ERROR
-     * (APIFY_LOG_LEVEL)
-     */
-    logLevel: string | null;
-    logFormat: string | null;
-    /**
-     * Origin for the Actor run, i.e. how it was started. See [here](https://docs.apify.com/sdk/python/reference/enum/MetaOrigin)
-     * for more details. (APIFY_META_ORIGIN)
-     */
-    metaOrigin: string | null;
-    /**
-     * The key of the input record in the Actor’s default key-value store (ACTOR_INPUT_KEY)
-     */
-    inputKey: string | null;
-    sdkLatestVersion: string | null;
-    systemInfoIntervalMillis: string | null;
-    workflowKey: string | null;
-    actorBuildNumber: string | null;
-    actorEventsWsUrl: string | null;
-    actorMaxPaidDatasetItems: number | null;
-    containerPort: number | null;
-    containerUrl: string | null;
-    defaultRequestQueueId: string | null;
-}
-export type UserFunc<T = unknown> = () => Awaitable<T>;
-export interface CallOptions extends ActorCallOptions {
-    /**
-     * User API token that is used to run the Actor. By default, it is taken from the `APIFY_TOKEN` environment variable.
-     */
-    token?: string;
-}
-export interface CallTaskOptions extends TaskCallOptions {
-    /**
-     * User API token that is used to run the Actor. By default, it is taken from the `APIFY_TOKEN` environment variable.
-     */
-    token?: string;
-}
-export interface AbortOptions extends RunAbortOptions {
-    /**
-     * User API token that is used to run the Actor. By default, it is taken from the `APIFY_TOKEN` environment variable.
-     */
-    token?: string;
-    /** Exit with given status message */
-    statusMessage?: string;
-}
-export interface WebhookOptions {
-    /**
-     * Array of event types, which you can set for Actor run, see
-     * the [Actor run events](https://docs.apify.com/webhooks/events#actor-run) in the Apify doc.
-     */
-    eventTypes: readonly WebhookEventType[];
-    /**
-     * URL which will be requested using HTTP POST request, when Actor run will reach the set event type.
-     */
-    requestUrl: string;
-    /**
-     * Payload template is a JSON-like string that describes the structure of the webhook POST request payload.
-     * It uses JSON syntax, extended with a double curly braces syntax for injecting variables `{{variable}}`.
-     * Those variables are resolved at the time of the webhook's dispatch, and a list of available variables with their descriptions
-     * is available in the [Apify webhook documentation](https://docs.apify.com/webhooks).
-     * If `payloadTemplate` is omitted, the default payload template is used
-     * ([view docs](https://docs.apify.com/webhooks/actions#payload-template)).
-     */
-    payloadTemplate?: string;
-    /**
-     * Idempotency key enables you to ensure that a webhook will not be added multiple times in case of
-     * an Actor restart or other situation that would cause the `addWebhook()` function to be called again.
-     * We suggest using the Actor run ID as the idempotency key. You can get the run ID by calling
-     * {@apilink Actor.getEnv} function.
-     */
-    idempotencyKey?: string;
-}
-export interface MetamorphOptions {
-    /**
-     * Content type for the `input`. If not specified,
-     * `input` is expected to be an object that will be stringified to JSON and content type set to
-     * `application/json; charset=utf-8`. If `options.contentType` is specified, then `input` must be a
-     * `String` or `Buffer`.
-     */
-    contentType?: string;
-    /**
-     * Tag or number of the target Actor build to metamorph into (e.g. `beta` or `1.2.345`).
-     * If not provided, the run uses build tag or number from the default Actor run configuration (typically `latest`).
-     */
-    build?: string;
-    /** @internal */
-    customAfterSleepMillis?: number;
-}
-export interface RebootOptions {
-    /** @internal */
-    customAfterSleepMillis?: number;
-}
-export interface ExitOptions {
-    /** Exit with given status message */
-    statusMessage?: string;
-    /**
-     * Amount of time, in seconds, to wait for all event handlers to finish before exiting the process.
-     * @default 30
-     */
-    timeoutSecs?: number;
-    /** Exit code, defaults to 0 */
-    exitCode?: number;
-    /** Call `process.exit()`? Defaults to true */
-    exit?: boolean;
-}
-export interface OpenStorageOptions {
-    /**
-     * If set to `true` then the cloud storage is used even if the `CRAWLEE_STORAGE_DIR`
-     * environment variable is set. This way it is possible to combine local and cloud storage.
-     * @default false
-     */
-    forceCloud?: boolean;
-}
-export { ClientActorRun as ActorRun };
-/**
- * Exit codes for the Actor process.
- * The error codes must be in the range 1-128, to avoid collision with signal exits
- * and to ensure Docker will handle them correctly!
- * @internal should be removed if we decide to remove `Actor.main()`
- */
-export declare const EXIT_CODES: {
-    SUCCESS: number;
-    ERROR_USER_FUNCTION_THREW: number;
-    ERROR_UNKNOWN: number;
-};
 //# sourceMappingURL=actor.d.ts.map