Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/resource_clients/actor_collection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,22 +43,22 @@ export class ActorCollectionClient extends ResourceCollectionClient {
/**
* Lists all Actors.
*
* @param options - Pagination options.
* @returns A paginated iterator of Actors.
* @see https://docs.apify.com/api/v2/acts-get
*
* Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
* items in a single API call is limited.
* ```javascript
* const paginatedList = await client.list(options);
*```
* ```
*
* Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
* retrieved.
*
* ```javascript
* for await (const singleItem of client.list(options)) {...}
* ```
*
* @param options - Pagination options.
* @returns A paginated iterator of Actors.
* @see https://docs.apify.com/api/v2/acts-get
*/
list(options: ActorCollectionListOptions = {}): PaginatedIterator<ActorCollectionListItem> {
ow(
Expand Down
10 changes: 5 additions & 5 deletions src/resource_clients/actor_env_var_collection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,22 +45,22 @@ export class ActorEnvVarCollectionClient extends ResourceCollectionClient {
/**
* Lists all environment variables of this Actor version.
*
* @param options - Pagination options.
* @returns A paginated iterator of environment variables.
* @see https://docs.apify.com/api/v2/act-version-env-vars-get
*
* Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
* items in a single API call is limited.
* ```javascript
* const paginatedList = await client.list(options);
*```
* ```
*
* Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
* retrieved.
*
* ```javascript
* for await (const singleItem of client.list(options)) {...}
* ```
*
* @param options - Pagination options.
* @returns A paginated iterator of environment variables.
* @see https://docs.apify.com/api/v2/act-version-env-vars-get
*/
list(
options: ActorEnvVarCollectionListOptions = {},
Expand Down
10 changes: 5 additions & 5 deletions src/resource_clients/actor_version_collection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,22 +43,22 @@ export class ActorVersionCollectionClient extends ResourceCollectionClient {
/**
* Lists all Actor versions.
*
* @param options - Pagination options.
* @returns A paginated iterator of Actor versions.
* @see https://docs.apify.com/api/v2/act-versions-get
*
* Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
* items in a single API call is limited.
* ```javascript
* const paginatedList = await client.list(options);
*```
* ```
*
* Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
* retrieved.
*
* ```javascript
* for await (const singleItem of client.list(options)) {...}
* ```
*
* @param options - Pagination options.
* @returns A paginated iterator of Actor versions.
* @see https://docs.apify.com/api/v2/act-versions-get
*/
list(
options: ActorVersionCollectionListOptions = {},
Expand Down
10 changes: 5 additions & 5 deletions src/resource_clients/build_collection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,22 +40,22 @@ export class BuildCollectionClient extends ResourceCollectionClient {
/**
* Lists all Actor builds.
*
* @param options - Pagination and sorting options.
* @returns A paginated iterator of Actor builds.
* @see https://docs.apify.com/api/v2/actor-builds-get
*
* Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
* items in a single API call is limited.
* ```javascript
* const paginatedList = await client.list(options);
*```
* ```
*
* Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
* retrieved.
*
* ```javascript
* for await (const singleItem of client.list(options)) {...}
* ```
*
* @param options - Pagination and sorting options.
* @returns A paginated iterator of Actor builds.
* @see https://docs.apify.com/api/v2/actor-builds-get
*/
list(options: BuildCollectionClientListOptions = {}): PaginatedIterator<BuildCollectionClientListItem> {
ow(
Expand Down
10 changes: 5 additions & 5 deletions src/resource_clients/dataset_collection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,22 +39,22 @@ export class DatasetCollectionClient extends ResourceCollectionClient {
/**
* Lists all Datasets.
*
* @param options - Pagination options.
* @returns A paginated iterator of Datasets.
* @see https://docs.apify.com/api/v2/datasets-get
*
* Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
* items in a single API call is limited.
* ```javascript
* const paginatedList = await client.list(options);
*```
* ```
*
* Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
* retrieved.
*
* ```javascript
* for await (const singleItem of client.list(options)) {...}
* ```
*
* @param options - Pagination options.
* @returns A paginated iterator of Datasets.
* @see https://docs.apify.com/api/v2/datasets-get
*/
list(options: DatasetCollectionClientListOptions = {}): PaginatedIterator<Dataset> {
ow(
Expand Down
10 changes: 5 additions & 5 deletions src/resource_clients/key_value_store_collection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,22 +39,22 @@ export class KeyValueStoreCollectionClient extends ResourceCollectionClient {
/**
* Lists all Key-value stores.
*
* @param options - Pagination options.
* @returns A paginated iterator of Key-value stores.
* @see https://docs.apify.com/api/v2/key-value-stores-get
*
* Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
* items in a single API call is limited.
* ```javascript
* const paginatedList = await client.list(options);
*```
* ```
*
* Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
* retrieved.
*
* ```javascript
* for await (const singleItem of client.list(options)) {...}
* ```
*
* @param options - Pagination options.
* @returns A paginated iterator of Key-value stores.
* @see https://docs.apify.com/api/v2/key-value-stores-get
*/
list(
options: KeyValueStoreCollectionClientListOptions = {},
Expand Down
10 changes: 5 additions & 5 deletions src/resource_clients/request_queue_collection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,22 +39,22 @@ export class RequestQueueCollectionClient extends ResourceCollectionClient {
/**
* Lists all Request queues.
*
* @param options - Pagination options.
* @returns A paginated iterator of Request queues.
* @see https://docs.apify.com/api/v2/request-queues-get
*
* Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
* items in a single API call is limited.
* ```javascript
* const paginatedList = await client.list(options);
*```
* ```
*
* Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
* retrieved.
*
* ```javascript
* for await (const singleItem of client.list(options)) {...}
* ```
*
* @param options - Pagination options.
* @returns A paginated iterator of Request queues.
* @see https://docs.apify.com/api/v2/request-queues-get
*/
list(
options: RequestQueueCollectionListOptions = {},
Expand Down
10 changes: 5 additions & 5 deletions src/resource_clients/run_collection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,22 +42,22 @@ export class RunCollectionClient extends ResourceCollectionClient {
/**
* Lists all Actor runs.
*
* @param options - Pagination and filtering options.
* @returns A paginated iterator of Actor runs.
* @see https://docs.apify.com/api/v2/actor-runs-get
*
* Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
* items in a single API call is limited.
* ```javascript
* const paginatedList = await client.list(options);
*```
* ```
*
* Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
* retrieved.
*
* ```javascript
* for await (const singleItem of client.list(options)) {...}
* ```
*
* @param options - Pagination and filtering options.
* @returns A paginated iterator of Actor runs.
* @see https://docs.apify.com/api/v2/actor-runs-get
*/
list(options: RunCollectionListOptions = {}): PaginatedIterator<ActorRunListItem> {
ow(
Expand Down
10 changes: 5 additions & 5 deletions src/resource_clients/schedule_collection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,22 +43,22 @@ export class ScheduleCollectionClient extends ResourceCollectionClient {
/**
* Lists all schedules.
*
* @param options - Pagination and sorting options.
* @returns A paginated iterator of schedules.
* @see https://docs.apify.com/api/v2/schedules-get
*
* Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
* items in a single API call is limited.
* ```javascript
* const paginatedList = await client.list(options);
*```
* ```
*
* Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
* retrieved.
*
* ```javascript
* for await (const singleItem of client.list(options)) {...}
* ```
*
* @param options - Pagination and sorting options.
* @returns A paginated iterator of schedules.
* @see https://docs.apify.com/api/v2/schedules-get
*/
list(options: ScheduleCollectionListOptions = {}): PaginatedIterator<Schedule> {
ow(
Expand Down
10 changes: 5 additions & 5 deletions src/resource_clients/store_collection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,22 +39,22 @@ export class StoreCollectionClient extends ResourceCollectionClient {
/**
* Lists Actors from the Apify Store.
*
* @param options - Search and pagination options.
* @returns A paginated iterator of store Actors.
* @see https://docs.apify.com/api/v2/store-actors-get
*
* Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
* items in a single API call is limited.
* ```javascript
* const paginatedList = await client.list(options);
*```
* ```
*
* Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
* retrieved.
*
* ```javascript
* for await (const singleItem of client.list(options)) {...}
* ```
*
* @param options - Search and pagination options.
* @returns A paginated iterator of store Actors.
* @see https://docs.apify.com/api/v2/store-actors-get
*/
list(options: StoreCollectionListOptions = {}): PaginatedIterator<ActorStoreList> {
ow(
Expand Down
10 changes: 5 additions & 5 deletions src/resource_clients/task_collection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,22 +43,22 @@ export class TaskCollectionClient extends ResourceCollectionClient {
/**
* Lists all Tasks.
*
* @param options - Pagination and sorting options.
* @returns A paginated iterator of tasks.
* @see https://docs.apify.com/api/v2/actor-tasks-get
*
* Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
* items in a single API call is limited.
* ```javascript
* const paginatedList = await client.list(options);
*```
* ```
*
* Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
* retrieved.
*
* ```javascript
* for await (const singleItem of client.list(options)) {...}
* ```
*
* @param options - Pagination and sorting options.
* @returns A paginated iterator of tasks.
* @see https://docs.apify.com/api/v2/actor-tasks-get
*/
list(options: TaskCollectionListOptions = {}): PaginatedIterator<TaskList> {
ow(
Expand Down
10 changes: 5 additions & 5 deletions src/resource_clients/webhook_collection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,22 +42,22 @@ export class WebhookCollectionClient extends ResourceCollectionClient {
/**
* Lists all Webhooks.
*
* @param options - Pagination and sorting options.
* @returns A paginated iterator of webhooks.
* @see https://docs.apify.com/api/v2/webhooks-get
*
* Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
* items in a single API call is limited.
* ```javascript
* const paginatedList = await client.list(options);
*```
* ```
*
* Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
* retrieved.
*
* ```javascript
* for await (const singleItem of client.list(options)) {...}
* ```
*
* @param options - Pagination and sorting options.
* @returns A paginated iterator of webhooks.
* @see https://docs.apify.com/api/v2/webhooks-get
*/

list(
Expand Down
10 changes: 5 additions & 5 deletions src/resource_clients/webhook_dispatch_collection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,22 +37,22 @@ export class WebhookDispatchCollectionClient extends ResourceCollectionClient {
/**
* Lists all webhook dispatches.
*
* @param options - Pagination and sorting options.
* @returns A paginated iterator of webhook dispatches.
* @see https://docs.apify.com/api/v2/webhook-dispatches-get
*
* Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
* items in a single API call is limited.
* ```javascript
* const paginatedList = await client.list(options);
*```
* ```
*
* Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
* retrieved.
*
* ```javascript
* for await (const singleItem of client.list(options)) {...}
* ```
*
* @param options - Pagination and sorting options.
* @returns A paginated iterator of webhook dispatches.
* @see https://docs.apify.com/api/v2/webhook-dispatches-get
*/
list(options: WebhookDispatchCollectionListOptions = {}): PaginatedIterator<WebhookDispatch> {
ow(
Expand Down