apify-client
Version:
Apify API client for JavaScript
60 lines • 2.33 kB
TypeScript
import { ACTOR_JOB_STATUSES } from '@apify/consts';
import type { ApiClientOptionsWithOptionalResourcePath } from '../base/api_client';
import { ResourceCollectionClient } from '../base/resource_collection_client';
import type { PaginatedIterator, PaginationOptions } from '../utils';
import type { ActorRunListItem } from './actor';
/**
* Client for managing the collection of Actor runs.
*
* Provides methods to list Actor runs across all Actors or for a specific Actor.
* To access an individual run, use the `run()` method on the main ApifyClient.
*
* @example
* ```javascript
* const client = new ApifyClient({ token: 'my-token' });
*
* // List all runs
* const runsClient = client.runs();
* const { items } = await runsClient.list();
*
* // List runs for a specific Actor
* const actorRunsClient = client.actor('my-actor-id').runs();
* const { items: actorRuns } = await actorRunsClient.list();
* ```
*
* @see https://docs.apify.com/platform/actors/running/runs-and-builds
*/
export declare class RunCollectionClient extends ResourceCollectionClient {
/**
* @hidden
*/
constructor(options: ApiClientOptionsWithOptionalResourcePath);
/**
* Lists all Actor runs.
*
* 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>;
}
export interface RunCollectionListOptions extends PaginationOptions {
desc?: boolean;
status?: (typeof ACTOR_JOB_STATUSES)[keyof typeof ACTOR_JOB_STATUSES] | (typeof ACTOR_JOB_STATUSES)[keyof typeof ACTOR_JOB_STATUSES][];
startedBefore?: Date | string;
startedAfter?: Date | string;
}
//# sourceMappingURL=run_collection.d.ts.map