apify 3.4.1-beta.6 → 3.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/{dist/actor.d.ts → actor.d.ts} +85 -85
  2. package/{dist/actor.js → actor.js} +77 -77
  3. package/package.json +10 -10
  4. package/{dist/platform_event_manager.d.ts → platform_event_manager.d.ts} +3 -3
  5. package/{dist/platform_event_manager.js → platform_event_manager.js} +3 -3
  6. package/{dist/proxy_configuration.d.ts → proxy_configuration.d.ts} +10 -10
  7. package/{dist/proxy_configuration.d.ts.map → proxy_configuration.d.ts.map} +1 -1
  8. package/{dist/proxy_configuration.js → proxy_configuration.js} +36 -41
  9. package/proxy_configuration.js.map +1 -0
  10. package/tsconfig.build.tsbuildinfo +1 -0
  11. package/{dist/utils.d.ts.map → utils.d.ts.map} +1 -1
  12. package/{dist/utils.js → utils.js} +2 -1
  13. package/utils.js.map +1 -0
  14. package/.turbo/turbo-build.log +0 -20
  15. package/.turbo/turbo-copy.log +0 -4
  16. package/dist/LICENSE.md +0 -201
  17. package/dist/README.md +0 -98
  18. package/dist/package.json +0 -80
  19. package/dist/proxy_configuration.js.map +0 -1
  20. package/dist/utils.js.map +0 -1
  21. /package/{dist/actor.d.ts.map → actor.d.ts.map} +0 -0
  22. /package/{dist/actor.js.map → actor.js.map} +0 -0
  23. /package/{dist/charging.d.ts → charging.d.ts} +0 -0
  24. /package/{dist/charging.d.ts.map → charging.d.ts.map} +0 -0
  25. /package/{dist/charging.js → charging.js} +0 -0
  26. /package/{dist/charging.js.map → charging.js.map} +0 -0
  27. /package/{dist/configuration.d.ts → configuration.d.ts} +0 -0
  28. /package/{dist/configuration.d.ts.map → configuration.d.ts.map} +0 -0
  29. /package/{dist/configuration.js → configuration.js} +0 -0
  30. /package/{dist/configuration.js.map → configuration.js.map} +0 -0
  31. /package/{dist/index.d.ts → index.d.ts} +0 -0
  32. /package/{dist/index.d.ts.map → index.d.ts.map} +0 -0
  33. /package/{dist/index.js → index.js} +0 -0
  34. /package/{dist/index.js.map → index.js.map} +0 -0
  35. /package/{dist/index.mjs → index.mjs} +0 -0
  36. /package/{dist/key_value_store.d.ts → key_value_store.d.ts} +0 -0
  37. /package/{dist/key_value_store.d.ts.map → key_value_store.d.ts.map} +0 -0
  38. /package/{dist/key_value_store.js → key_value_store.js} +0 -0
  39. /package/{dist/key_value_store.js.map → key_value_store.js.map} +0 -0
  40. /package/{dist/platform_event_manager.d.ts.map → platform_event_manager.d.ts.map} +0 -0
  41. /package/{dist/platform_event_manager.js.map → platform_event_manager.js.map} +0 -0
  42. /package/{dist/utils.d.ts → utils.d.ts} +0 -0
@@ -29,7 +29,7 @@ export interface MainOptions extends ExitOptions, InitOptions {
29
29
  }
30
30
  /**
31
31
  * Parsed representation of the Apify environment variables.
32
- * This object is returned by the {@apilink Actor.getEnv} function.
32
+ * This object is returned by the {@link Actor.getEnv} function.
33
33
  */
34
34
  export interface ApifyEnv {
35
35
  /**
@@ -185,7 +185,7 @@ export interface WebhookOptions {
185
185
  * Idempotency key enables you to ensure that a webhook will not be added multiple times in case of
186
186
  * an Actor restart or other situation that would cause the `addWebhook()` function to be called again.
187
187
  * We suggest using the Actor run ID as the idempotency key. You can get the run ID by calling
188
- * {@apilink Actor.getEnv} function.
188
+ * {@link Actor.getEnv} function.
189
189
  */
190
190
  idempotencyKey?: string;
191
191
  }
@@ -232,28 +232,28 @@ export declare const EXIT_CODES: {
232
232
  /**
233
233
  * `Actor` class serves as an alternative approach to the static helpers exported from the package. It allows to pass configuration
234
234
  * that will be used on the instance methods. Environment variables will have precedence over this configuration.
235
- * See {@apilink Configuration} for details about what can be configured and what are the default values.
235
+ * See {@link Configuration} for details about what can be configured and what are the default values.
236
236
  */
237
237
  export declare class Actor<Data extends Dictionary = Dictionary> {
238
238
  /** @internal */
239
239
  static _instance: Actor;
240
240
  /**
241
- * Configuration of this SDK instance (provided to its constructor). See {@apilink Configuration} for details.
241
+ * Configuration of this SDK instance (provided to its constructor). See {@link Configuration} for details.
242
242
  * @internal
243
243
  */
244
244
  readonly config: Configuration;
245
245
  /**
246
- * Default {@apilink ApifyClient} instance.
246
+ * Default {@link ApifyClient} instance.
247
247
  * @internal
248
248
  */
249
249
  readonly apifyClient: ApifyClient;
250
250
  /**
251
- * Default {@apilink EventManager} instance.
251
+ * Default {@link EventManager} instance.
252
252
  * @internal
253
253
  */
254
254
  readonly eventManager: EventManager;
255
255
  /**
256
- * Whether the Actor instance was initialized. This is set by calling {@apilink Actor.init}.
256
+ * Whether the Actor instance was initialized. This is set by calling {@link Actor.init}.
257
257
  */
258
258
  initialized: boolean;
259
259
  /**
@@ -284,7 +284,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
284
284
  * - When running on the Apify platform (i.e. `APIFY_IS_AT_HOME` environment variable is set),
285
285
  * it sets up a connection to listen for platform events.
286
286
  * For example, to get a notification about an imminent migration to another server.
287
- * See {@apilink Actor.events} for details.
287
+ * See {@link Actor.events} for details.
288
288
  * - It invokes the user function passed as the `userFunc` parameter.
289
289
  * - If the user function returned a promise, waits for it to resolve.
290
290
  * - If the user function throws an exception or some other error is encountered,
@@ -353,9 +353,9 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
353
353
  /**
354
354
  * Runs an Actor on the Apify platform using the current user account (determined by the `APIFY_TOKEN` environment variable).
355
355
  *
356
- * The result of the function is an {@apilink ActorRun} object that contains details about the Actor run.
356
+ * The result of the function is an {@link ActorRun} object that contains details about the Actor run.
357
357
  *
358
- * If you want to run an Actor task rather than an Actor, please use the {@apilink Actor.callTask} function instead.
358
+ * If you want to run an Actor task rather than an Actor, please use the {@link Actor.callTask} function instead.
359
359
  *
360
360
  * For more information about Actors, read the [documentation](https://docs.apify.com/actor).
361
361
  *
@@ -379,7 +379,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
379
379
  * Runs an Actor on the Apify platform using the current user account (determined by the `APIFY_TOKEN` environment variable),
380
380
  * unlike `Actor.call`, this method just starts the run without waiting for finish.
381
381
  *
382
- * The result of the function is an {@apilink ActorRun} object that contains details about the Actor run.
382
+ * The result of the function is an {@link ActorRun} object that contains details about the Actor run.
383
383
  *
384
384
  * For more information about Actors, read the
385
385
  * [documentation](https://docs.apify.com/actor).
@@ -403,7 +403,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
403
403
  /**
404
404
  * Aborts given Actor run on the Apify platform using the current user account (determined by the `APIFY_TOKEN` environment variable).
405
405
  *
406
- * The result of the function is an {@apilink ActorRun} object that contains details about the Actor run.
406
+ * The result of the function is an {@link ActorRun} object that contains details about the Actor run.
407
407
  *
408
408
  * For more information about Actors, read the
409
409
  * [documentation](https://docs.apify.com/actor).
@@ -419,11 +419,11 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
419
419
  /**
420
420
  * Runs an actor task on the Apify platform using the current user account (determined by the `APIFY_TOKEN` environment variable).
421
421
  *
422
- * The result of the function is an {@apilink ActorRun} object that contains details about the Actor run.
422
+ * The result of the function is an {@link ActorRun} object that contains details about the Actor run.
423
423
  *
424
424
  * Note that an Actor task is a saved input configuration and options for an Actor.
425
425
  * If you want to run an Actor directly rather than an Actor task, please use the
426
- * {@apilink Actor.call} function instead.
426
+ * {@link Actor.call} function instead.
427
427
  *
428
428
  * For more information about Actor tasks, read the [documentation](https://docs.apify.com/tasks).
429
429
  *
@@ -488,9 +488,9 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
488
488
  */
489
489
  setStatusMessage(statusMessage: string, options?: SetStatusMessageOptions): Promise<ClientActorRun>;
490
490
  /**
491
- * Stores an object or an array of objects to the default {@apilink Dataset} of the current Actor run.
491
+ * Stores an object or an array of objects to the default {@link Dataset} of the current Actor run.
492
492
  *
493
- * This is just a convenient shortcut for {@apilink Dataset.pushData}.
493
+ * This is just a convenient shortcut for {@link Dataset.pushData}.
494
494
  * For example, calling the following code:
495
495
  * ```js
496
496
  * await Actor.pushData({ myValue: 123 });
@@ -502,7 +502,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
502
502
  * await dataset.pushData({ myValue: 123 });
503
503
  * ```
504
504
  *
505
- * For more information, see {@apilink Actor.openDataset} and {@apilink Dataset.pushData}
505
+ * For more information, see {@link Actor.openDataset} and {@link Dataset.pushData}
506
506
  *
507
507
  * **IMPORTANT**: Make sure to use the `await` keyword when calling `pushData()`,
508
508
  * otherwise the Actor process might finish before the data are stored!
@@ -513,9 +513,9 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
513
513
  */
514
514
  pushData(item: Data | Data[]): Promise<void>;
515
515
  /**
516
- * Stores an object or an array of objects to the default {@apilink Dataset} of the current Actor run.
516
+ * Stores an object or an array of objects to the default {@link Dataset} of the current Actor run.
517
517
  *
518
- * This is just a convenient shortcut for {@apilink Dataset.pushData}.
518
+ * This is just a convenient shortcut for {@link Dataset.pushData}.
519
519
  * For example, calling the following code:
520
520
  * ```js
521
521
  * await Actor.pushData({ myValue: 123 });
@@ -527,7 +527,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
527
527
  * await dataset.pushData({ myValue: 123 });
528
528
  * ```
529
529
  *
530
- * For more information, see {@apilink Actor.openDataset} and {@apilink Dataset.pushData}
530
+ * For more information, see {@link Actor.openDataset} and {@link Dataset.pushData}
531
531
  *
532
532
  * **IMPORTANT**: Make sure to use the `await` keyword when calling `pushData()`,
533
533
  * otherwise the Actor process might finish before the data are stored!
@@ -539,13 +539,13 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
539
539
  */
540
540
  pushData(item: Data | Data[], eventName: string): Promise<ChargeResult>;
541
541
  /**
542
- * Opens a dataset and returns a promise resolving to an instance of the {@apilink Dataset} class.
542
+ * Opens a dataset and returns a promise resolving to an instance of the {@link Dataset} class.
543
543
  *
544
544
  * Datasets are used to store structured data where each object stored has the same attributes,
545
545
  * such as online store products or real estate offers.
546
546
  * The actual data is stored either on the local filesystem or in the cloud.
547
547
  *
548
- * For more details and code examples, see the {@apilink Dataset} class.
548
+ * For more details and code examples, see the {@link Dataset} class.
549
549
  *
550
550
  * @param [datasetIdOrName]
551
551
  * ID or name of the dataset to be opened. If `null` or `undefined`,
@@ -555,9 +555,9 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
555
555
  */
556
556
  openDataset(datasetIdOrName?: string | null, options?: OpenStorageOptions): Promise<Dataset<Data>>;
557
557
  /**
558
- * Gets a value from the default {@apilink KeyValueStore} associated with the current Actor run.
558
+ * Gets a value from the default {@link KeyValueStore} associated with the current Actor run.
559
559
  *
560
- * This is just a convenient shortcut for {@apilink KeyValueStore.getValue}.
560
+ * This is just a convenient shortcut for {@link KeyValueStore.getValue}.
561
561
  * For example, calling the following code:
562
562
  * ```js
563
563
  * const value = await Actor.getValue('my-key');
@@ -569,10 +569,10 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
569
569
  * const value = await store.getValue('my-key');
570
570
  * ```
571
571
  *
572
- * To store the value to the default key-value store, you can use the {@apilink Actor.setValue} function.
572
+ * To store the value to the default key-value store, you can use the {@link Actor.setValue} function.
573
573
  *
574
- * For more information, see {@apilink Actor.openKeyValueStore}
575
- * and {@apilink KeyValueStore.getValue}.
574
+ * For more information, see {@link Actor.openKeyValueStore}
575
+ * and {@link KeyValueStore.getValue}.
576
576
  *
577
577
  * @param key Unique record key.
578
578
  * @returns
@@ -584,9 +584,9 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
584
584
  */
585
585
  getValue<T = unknown>(key: string): Promise<T | null>;
586
586
  /**
587
- * Stores or deletes a value in the default {@apilink KeyValueStore} associated with the current Actor run.
587
+ * Stores or deletes a value in the default {@link KeyValueStore} associated with the current Actor run.
588
588
  *
589
- * This is just a convenient shortcut for {@apilink KeyValueStore.setValue}.
589
+ * This is just a convenient shortcut for {@link KeyValueStore.setValue}.
590
590
  * For example, calling the following code:
591
591
  * ```js
592
592
  * await Actor.setValue('OUTPUT', { foo: "bar" });
@@ -598,10 +598,10 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
598
598
  * await store.setValue('OUTPUT', { foo: "bar" });
599
599
  * ```
600
600
  *
601
- * To get a value from the default key-value store, you can use the {@apilink Actor.getValue} function.
601
+ * To get a value from the default key-value store, you can use the {@link Actor.getValue} function.
602
602
  *
603
- * For more information, see {@apilink Actor.openKeyValueStore}
604
- * and {@apilink KeyValueStore.getValue}.
603
+ * For more information, see {@link Actor.openKeyValueStore}
604
+ * and {@link KeyValueStore.getValue}.
605
605
  *
606
606
  * @param key
607
607
  * Unique record key.
@@ -616,7 +616,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
616
616
  */
617
617
  setValue<T>(key: string, value: T | null, options?: RecordOptions): Promise<void>;
618
618
  /**
619
- * Gets the Actor input value from the default {@apilink KeyValueStore} associated with the current Actor run.
619
+ * Gets the Actor input value from the default {@link KeyValueStore} associated with the current Actor run.
620
620
  *
621
621
  * This is just a convenient shortcut for [`keyValueStore.getValue('INPUT')`](core/class/KeyValueStore#getValue).
622
622
  * For example, calling the following code:
@@ -634,8 +634,8 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
634
634
  * If you need to use the input multiple times in your Actor,
635
635
  * it is far more efficient to read it once and store it locally.
636
636
  *
637
- * For more information, see {@apilink Actor.openKeyValueStore}
638
- * and {@apilink KeyValueStore.getValue}.
637
+ * For more information, see {@link Actor.openKeyValueStore}
638
+ * and {@link KeyValueStore.getValue}.
639
639
  *
640
640
  * @returns
641
641
  * Returns a promise that resolves to an object, string
@@ -646,18 +646,18 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
646
646
  */
647
647
  getInput<T = Dictionary | string | Buffer>(): Promise<T | null>;
648
648
  /**
649
- * Gets the Actor input value just like the {@apilink Actor.getInput} method,
649
+ * Gets the Actor input value just like the {@link Actor.getInput} method,
650
650
  * but throws if it is not found.
651
651
  */
652
652
  getInputOrThrow<T = Dictionary | string | Buffer>(): Promise<T>;
653
653
  /**
654
- * Opens a key-value store and returns a promise resolving to an instance of the {@apilink KeyValueStore} class.
654
+ * Opens a key-value store and returns a promise resolving to an instance of the {@link KeyValueStore} class.
655
655
  *
656
656
  * Key-value stores are used to store records or files, along with their MIME content type.
657
657
  * The records are stored and retrieved using a unique key.
658
658
  * The actual data is stored either on a local filesystem or in the Apify cloud.
659
659
  *
660
- * For more details and code examples, see the {@apilink KeyValueStore} class.
660
+ * For more details and code examples, see the {@link KeyValueStore} class.
661
661
  *
662
662
  * @param [storeIdOrName]
663
663
  * ID or name of the key-value store to be opened. If `null` or `undefined`,
@@ -668,14 +668,14 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
668
668
  openKeyValueStore(storeIdOrName?: string | null, options?: OpenStorageOptions): Promise<KeyValueStore>;
669
669
  /**
670
670
  * Opens a request queue and returns a promise resolving to an instance
671
- * of the {@apilink RequestQueue} class.
671
+ * of the {@link RequestQueue} class.
672
672
  *
673
- * {@apilink RequestQueue} represents a queue of URLs to crawl, which is stored either on local filesystem or in the cloud.
673
+ * {@link RequestQueue} represents a queue of URLs to crawl, which is stored either on local filesystem or in the cloud.
674
674
  * The queue is used for deep crawling of websites, where you start with several URLs and then
675
675
  * recursively follow links to other pages. The data structure supports both breadth-first
676
676
  * and depth-first crawling orders.
677
677
  *
678
- * For more details and code examples, see the {@apilink RequestQueue} class.
678
+ * For more details and code examples, see the {@link RequestQueue} class.
679
679
  *
680
680
  * @param [queueIdOrName]
681
681
  * ID or name of the request queue to be opened. If `null` or `undefined`,
@@ -686,13 +686,13 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
686
686
  openRequestQueue(queueIdOrName?: string | null, options?: OpenStorageOptions): Promise<RequestQueue>;
687
687
  /**
688
688
  * Creates a proxy configuration and returns a promise resolving to an instance
689
- * of the {@apilink ProxyConfiguration} class that is already initialized.
689
+ * of the {@link ProxyConfiguration} class that is already initialized.
690
690
  *
691
691
  * Configures connection to a proxy server with the provided options. Proxy servers are used to prevent target websites from blocking
692
692
  * your crawlers based on IP address rate limits or blacklists. Setting proxy configuration in your crawlers automatically configures
693
693
  * them to use the selected proxies for all connections.
694
694
  *
695
- * For more details and code examples, see the {@apilink ProxyConfiguration} class.
695
+ * For more details and code examples, see the {@link ProxyConfiguration} class.
696
696
  *
697
697
  * ```js
698
698
  *
@@ -736,11 +736,11 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
736
736
  */
737
737
  getChargingManager(): ChargingManager;
738
738
  /**
739
- * Modifies Actor env vars so parsing respects the structure of {@apilink ApifyEnv} interface.
739
+ * Modifies Actor env vars so parsing respects the structure of {@link ApifyEnv} interface.
740
740
  */
741
741
  private getModifiedActorEnvVars;
742
742
  /**
743
- * Returns a new {@apilink ApifyEnv} object which contains information parsed from all the Apify environment variables.
743
+ * Returns a new {@link ApifyEnv} object which contains information parsed from all the Apify environment variables.
744
744
  *
745
745
  * For the list of the Apify environment variables, see
746
746
  * [Actor documentation](https://docs.apify.com/actor/run#environment-variables).
@@ -799,7 +799,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
799
799
  * - When running on the Apify platform (i.e. `APIFY_IS_AT_HOME` environment variable is set),
800
800
  * it sets up a connection to listen for platform events.
801
801
  * For example, to get a notification about an imminent migration to another server.
802
- * See {@apilink Actor.events} for details.
802
+ * See {@link Actor.events} for details.
803
803
  * - It invokes the user function passed as the `userFunc` parameter.
804
804
  * - If the user function returned a promise, waits for it to resolve.
805
805
  * - If the user function throws an exception or some other error is encountered,
@@ -852,7 +852,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
852
852
  * from 25% to 100% on the platform.
853
853
  *
854
854
  * Calling `Actor.exit()` is required if you use the `Actor.init()` method, since it opens websocket connection
855
- * (see {@apilink Actor.events} for details), which needs to be terminated for the code to finish.
855
+ * (see {@link Actor.events} for details), which needs to be terminated for the code to finish.
856
856
  *
857
857
  * ```js
858
858
  * import { gotScraping } from 'got-scraping';
@@ -885,9 +885,9 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
885
885
  /**
886
886
  * Runs an Actor on the Apify platform using the current user account (determined by the `APIFY_TOKEN` environment variable).
887
887
  *
888
- * The result of the function is an {@apilink ActorRun} object that contains details about the Actor run.
888
+ * The result of the function is an {@link ActorRun} object that contains details about the Actor run.
889
889
  *
890
- * If you want to run an Actor task rather than an Actor, please use the {@apilink Actor.callTask} function instead.
890
+ * If you want to run an Actor task rather than an Actor, please use the {@link Actor.callTask} function instead.
891
891
  *
892
892
  * For more information about Actors, read the [documentation](https://docs.apify.com/actor).
893
893
  *
@@ -909,11 +909,11 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
909
909
  /**
910
910
  * Runs an Actor task on the Apify platform using the current user account (determined by the `APIFY_TOKEN` environment variable).
911
911
  *
912
- * The result of the function is an {@apilink ActorRun} object that contains details about the Actor run.
912
+ * The result of the function is an {@link ActorRun} object that contains details about the Actor run.
913
913
  *
914
914
  * Note that an Actor task is a saved input configuration and options for an Actor.
915
915
  * If you want to run an Actor directly rather than an Actor task, please use the
916
- * {@apilink Actor.call} function instead.
916
+ * {@link Actor.call} function instead.
917
917
  *
918
918
  * For more information about Actor tasks, read the [documentation](https://docs.apify.com/tasks).
919
919
  *
@@ -936,7 +936,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
936
936
  * Runs an Actor on the Apify platform using the current user account (determined by the `APIFY_TOKEN` environment variable),
937
937
  * unlike `Actor.call`, this method just starts the run without waiting for finish.
938
938
  *
939
- * The result of the function is an {@apilink ActorRun} object that contains details about the Actor run.
939
+ * The result of the function is an {@link ActorRun} object that contains details about the Actor run.
940
940
  *
941
941
  * For more information about Actors, read the
942
942
  * [documentation](https://docs.apify.com/actor).
@@ -959,7 +959,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
959
959
  /**
960
960
  * Aborts given Actor run on the Apify platform using the current user account (determined by the `APIFY_TOKEN` environment variable).
961
961
  *
962
- * The result of the function is an {@apilink ActorRun} object that contains details about the Actor run.
962
+ * The result of the function is an {@link ActorRun} object that contains details about the Actor run.
963
963
  *
964
964
  * For more information about Actors, read the
965
965
  * [documentation](https://docs.apify.com/actor).
@@ -1015,9 +1015,9 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
1015
1015
  */
1016
1016
  static setStatusMessage(statusMessage: string, options?: SetStatusMessageOptions): Promise<ClientActorRun>;
1017
1017
  /**
1018
- * Stores an object or an array of objects to the default {@apilink Dataset} of the current Actor run.
1018
+ * Stores an object or an array of objects to the default {@link Dataset} of the current Actor run.
1019
1019
  *
1020
- * This is just a convenient shortcut for {@apilink Dataset.pushData}.
1020
+ * This is just a convenient shortcut for {@link Dataset.pushData}.
1021
1021
  * For example, calling the following code:
1022
1022
  * ```js
1023
1023
  * await Actor.pushData({ myValue: 123 });
@@ -1029,7 +1029,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
1029
1029
  * await dataset.pushData({ myValue: 123 });
1030
1030
  * ```
1031
1031
  *
1032
- * For more information, see {@apilink Actor.openDataset} and {@apilink Dataset.pushData}
1032
+ * For more information, see {@link Actor.openDataset} and {@link Dataset.pushData}
1033
1033
  *
1034
1034
  * **IMPORTANT**: Make sure to use the `await` keyword when calling `pushData()`,
1035
1035
  * otherwise the Actor process might finish before the data are stored!
@@ -1039,9 +1039,9 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
1039
1039
  */
1040
1040
  static pushData<Data extends Dictionary = Dictionary>(item: Data | Data[]): Promise<void>;
1041
1041
  /**
1042
- * Stores an object or an array of objects to the default {@apilink Dataset} of the current Actor run.
1042
+ * Stores an object or an array of objects to the default {@link Dataset} of the current Actor run.
1043
1043
  *
1044
- * This is just a convenient shortcut for {@apilink Dataset.pushData}.
1044
+ * This is just a convenient shortcut for {@link Dataset.pushData}.
1045
1045
  * For example, calling the following code:
1046
1046
  * ```js
1047
1047
  * await Actor.pushData({ myValue: 123 });
@@ -1053,7 +1053,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
1053
1053
  * await dataset.pushData({ myValue: 123 });
1054
1054
  * ```
1055
1055
  *
1056
- * For more information, see {@apilink Actor.openDataset} and {@apilink Dataset.pushData}
1056
+ * For more information, see {@link Actor.openDataset} and {@link Dataset.pushData}
1057
1057
  *
1058
1058
  * **IMPORTANT**: Make sure to use the `await` keyword when calling `pushData()`,
1059
1059
  * otherwise the Actor process might finish before the data are stored!
@@ -1064,13 +1064,13 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
1064
1064
  */
1065
1065
  static pushData<Data extends Dictionary = Dictionary>(item: Data | Data[], eventName: string): Promise<ChargeResult>;
1066
1066
  /**
1067
- * Opens a dataset and returns a promise resolving to an instance of the {@apilink Dataset} class.
1067
+ * Opens a dataset and returns a promise resolving to an instance of the {@link Dataset} class.
1068
1068
  *
1069
1069
  * Datasets are used to store structured data where each object stored has the same attributes,
1070
1070
  * such as online store products or real estate offers.
1071
1071
  * The actual data is stored either on the local filesystem or in the cloud.
1072
1072
  *
1073
- * For more details and code examples, see the {@apilink Dataset} class.
1073
+ * For more details and code examples, see the {@link Dataset} class.
1074
1074
  *
1075
1075
  * @param [datasetIdOrName]
1076
1076
  * ID or name of the dataset to be opened. If `null` or `undefined`,
@@ -1079,9 +1079,9 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
1079
1079
  */
1080
1080
  static openDataset<Data extends Dictionary = Dictionary>(datasetIdOrName?: string | null, options?: OpenStorageOptions): Promise<Dataset<Data>>;
1081
1081
  /**
1082
- * Gets a value from the default {@apilink KeyValueStore} associated with the current Actor run.
1082
+ * Gets a value from the default {@link KeyValueStore} associated with the current Actor run.
1083
1083
  *
1084
- * This is just a convenient shortcut for {@apilink KeyValueStore.getValue}.
1084
+ * This is just a convenient shortcut for {@link KeyValueStore.getValue}.
1085
1085
  * For example, calling the following code:
1086
1086
  * ```js
1087
1087
  * const value = await Actor.getValue('my-key');
@@ -1093,10 +1093,10 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
1093
1093
  * const value = await store.getValue('my-key');
1094
1094
  * ```
1095
1095
  *
1096
- * To store the value to the default key-value store, you can use the {@apilink Actor.setValue} function.
1096
+ * To store the value to the default key-value store, you can use the {@link Actor.setValue} function.
1097
1097
  *
1098
- * For more information, see {@apilink Actor.openKeyValueStore}
1099
- * and {@apilink KeyValueStore.getValue}.
1098
+ * For more information, see {@link Actor.openKeyValueStore}
1099
+ * and {@link KeyValueStore.getValue}.
1100
1100
  *
1101
1101
  * @param key Unique record key.
1102
1102
  * @returns
@@ -1107,9 +1107,9 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
1107
1107
  */
1108
1108
  static getValue<T = unknown>(key: string): Promise<T | null>;
1109
1109
  /**
1110
- * Stores or deletes a value in the default {@apilink KeyValueStore} associated with the current Actor run.
1110
+ * Stores or deletes a value in the default {@link KeyValueStore} associated with the current Actor run.
1111
1111
  *
1112
- * This is just a convenient shortcut for {@apilink KeyValueStore.setValue}.
1112
+ * This is just a convenient shortcut for {@link KeyValueStore.setValue}.
1113
1113
  * For example, calling the following code:
1114
1114
  * ```js
1115
1115
  * await Actor.setValue('OUTPUT', { foo: "bar" });
@@ -1121,10 +1121,10 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
1121
1121
  * await store.setValue('OUTPUT', { foo: "bar" });
1122
1122
  * ```
1123
1123
  *
1124
- * To get a value from the default key-value store, you can use the {@apilink Actor.getValue} function.
1124
+ * To get a value from the default key-value store, you can use the {@link Actor.getValue} function.
1125
1125
  *
1126
- * For more information, see {@apilink Actor.openKeyValueStore}
1127
- * and {@apilink KeyValueStore.getValue}.
1126
+ * For more information, see {@link Actor.openKeyValueStore}
1127
+ * and {@link KeyValueStore.getValue}.
1128
1128
  *
1129
1129
  * @param key
1130
1130
  * Unique record key.
@@ -1138,9 +1138,9 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
1138
1138
  */
1139
1139
  static setValue<T>(key: string, value: T | null, options?: RecordOptions): Promise<void>;
1140
1140
  /**
1141
- * Gets the Actor input value from the default {@apilink KeyValueStore} associated with the current Actor run.
1141
+ * Gets the Actor input value from the default {@link KeyValueStore} associated with the current Actor run.
1142
1142
  *
1143
- * This is just a convenient shortcut for {@apilink KeyValueStore.getValue | `keyValueStore.getValue('INPUT')`}.
1143
+ * This is just a convenient shortcut for {@link KeyValueStore.getValue | `keyValueStore.getValue('INPUT')`}.
1144
1144
  * For example, calling the following code:
1145
1145
  * ```js
1146
1146
  * const input = await Actor.getInput();
@@ -1156,7 +1156,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
1156
1156
  * If you need to use the input multiple times in your Actor,
1157
1157
  * it is far more efficient to read it once and store it locally.
1158
1158
  *
1159
- * For more information, see {@apilink Actor.openKeyValueStore} and {@apilink KeyValueStore.getValue}.
1159
+ * For more information, see {@link Actor.openKeyValueStore} and {@link KeyValueStore.getValue}.
1160
1160
  *
1161
1161
  * @returns
1162
1162
  * Returns a promise that resolves to an object, string
@@ -1166,18 +1166,18 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
1166
1166
  */
1167
1167
  static getInput<T = Dictionary | string | Buffer>(): Promise<T | null>;
1168
1168
  /**
1169
- * Gets the Actor input value just like the {@apilink Actor.getInput} method,
1169
+ * Gets the Actor input value just like the {@link Actor.getInput} method,
1170
1170
  * but throws if it is not found.
1171
1171
  */
1172
1172
  static getInputOrThrow<T = Dictionary | string | Buffer>(): Promise<T>;
1173
1173
  /**
1174
- * Opens a key-value store and returns a promise resolving to an instance of the {@apilink KeyValueStore} class.
1174
+ * Opens a key-value store and returns a promise resolving to an instance of the {@link KeyValueStore} class.
1175
1175
  *
1176
1176
  * Key-value stores are used to store records or files, along with their MIME content type.
1177
1177
  * The records are stored and retrieved using a unique key.
1178
1178
  * The actual data is stored either on a local filesystem or in the Apify cloud.
1179
1179
  *
1180
- * For more details and code examples, see the {@apilink KeyValueStore} class.
1180
+ * For more details and code examples, see the {@link KeyValueStore} class.
1181
1181
  *
1182
1182
  * @param [storeIdOrName]
1183
1183
  * ID or name of the key-value store to be opened. If `null` or `undefined`,
@@ -1187,14 +1187,14 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
1187
1187
  static openKeyValueStore(storeIdOrName?: string | null, options?: OpenStorageOptions): Promise<KeyValueStore>;
1188
1188
  /**
1189
1189
  * Opens a request queue and returns a promise resolving to an instance
1190
- * of the {@apilink RequestQueue} class.
1190
+ * of the {@link RequestQueue} class.
1191
1191
  *
1192
- * {@apilink RequestQueue} represents a queue of URLs to crawl, which is stored either on local filesystem or in the cloud.
1192
+ * {@link RequestQueue} represents a queue of URLs to crawl, which is stored either on local filesystem or in the cloud.
1193
1193
  * The queue is used for deep crawling of websites, where you start with several URLs and then
1194
1194
  * recursively follow links to other pages. The data structure supports both breadth-first
1195
1195
  * and depth-first crawling orders.
1196
1196
  *
1197
- * For more details and code examples, see the {@apilink RequestQueue} class.
1197
+ * For more details and code examples, see the {@link RequestQueue} class.
1198
1198
  *
1199
1199
  * @param [queueIdOrName]
1200
1200
  * ID or name of the request queue to be opened. If `null` or `undefined`,
@@ -1204,13 +1204,13 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
1204
1204
  static openRequestQueue(queueIdOrName?: string | null, options?: OpenStorageOptions): Promise<RequestQueue>;
1205
1205
  /**
1206
1206
  * Creates a proxy configuration and returns a promise resolving to an instance
1207
- * of the {@apilink ProxyConfiguration} class that is already initialized.
1207
+ * of the {@link ProxyConfiguration} class that is already initialized.
1208
1208
  *
1209
1209
  * Configures connection to a proxy server with the provided options. Proxy servers are used to prevent target websites from blocking
1210
1210
  * your crawlers based on IP address rate limits or blacklists. Setting proxy configuration in your crawlers automatically configures
1211
1211
  * them to use the selected proxies for all connections.
1212
1212
  *
1213
- * For more details and code examples, see the {@apilink ProxyConfiguration} class.
1213
+ * For more details and code examples, see the {@link ProxyConfiguration} class.
1214
1214
  *
1215
1215
  * ```js
1216
1216
  *
@@ -1251,7 +1251,7 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
1251
1251
  */
1252
1252
  static getChargingManager(): ChargingManager;
1253
1253
  /**
1254
- * Returns a new {@apilink ApifyEnv} object which contains information parsed from all the Apify environment variables.
1254
+ * Returns a new {@link ApifyEnv} object which contains information parsed from all the Apify environment variables.
1255
1255
  *
1256
1256
  * For the list of the Apify environment variables, see
1257
1257
  * [Actor documentation](https://docs.apify.com/actor/run#environment-variables).
@@ -1270,9 +1270,9 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
1270
1270
  * Returns `true` when code is running on Apify platform and `false` otherwise (for example locally).
1271
1271
  */
1272
1272
  static isAtHome(): boolean;
1273
- /** Default {@apilink ApifyClient} instance. */
1273
+ /** Default {@link ApifyClient} instance. */
1274
1274
  static get apifyClient(): ApifyClient;
1275
- /** Default {@apilink Configuration} instance. */
1275
+ /** Default {@link Configuration} instance. */
1276
1276
  static get config(): Configuration;
1277
1277
  /** @internal */
1278
1278
  static getDefaultInstance(): Actor;