From dbbe723d4e90570ec9be63ea6d7946a5547a8abf Mon Sep 17 00:00:00 2001 From: Josef Prochazka Date: Fri, 28 Nov 2025 13:34:21 +0100 Subject: [PATCH] Mark unused options as deprecated. Remove validation of unused options. Do not pass unused options to the API. --- src/resource_clients/actor_collection.ts | 1 + .../actor_env_var_collection.ts | 20 +++++++----------- .../actor_version_collection.ts | 21 +++++++------------ 3 files changed, 17 insertions(+), 25 deletions(-) diff --git a/src/resource_clients/actor_collection.ts b/src/resource_clients/actor_collection.ts index 870a883a..0027fbac 100644 --- a/src/resource_clients/actor_collection.ts +++ b/src/resource_clients/actor_collection.ts @@ -65,6 +65,7 @@ export enum ActorListSortBy { export interface ActorCollectionListOptions extends PaginationOptions { my?: boolean; + desc?: boolean; sortBy?: ActorListSortBy; } diff --git a/src/resource_clients/actor_env_var_collection.ts b/src/resource_clients/actor_env_var_collection.ts index 89e7d2b7..e7b48149 100644 --- a/src/resource_clients/actor_env_var_collection.ts +++ b/src/resource_clients/actor_env_var_collection.ts @@ -22,28 +22,20 @@ export class ActorEnvVarCollectionClient extends ResourceCollectionClient { * 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); + * const paginatedList = await client.list(); *``` * * 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)) {...} + * for await (const singleItem of client.list()) {...} * ``` */ list( - options: ActorEnvVarCollectionListOptions = {}, + _options: ActorEnvVarCollectionListOptions = {}, ): Promise & AsyncIterable { - ow( - options, - ow.object.exactShape({ - limit: ow.optional.number, - offset: ow.optional.number, - desc: ow.optional.boolean, - }), - ); - return this._listPaginated(options); + return this._listPaginated(); } /** @@ -55,6 +47,10 @@ export class ActorEnvVarCollectionClient extends ResourceCollectionClient { } } +/** + * @deprecated No options are used in the current API implementation. + * https://github.com/apify/apify-client-js/issues/799 + */ export interface ActorEnvVarCollectionListOptions extends PaginationOptions { desc?: boolean; } diff --git a/src/resource_clients/actor_version_collection.ts b/src/resource_clients/actor_version_collection.ts index 160b1daf..cc4a34de 100644 --- a/src/resource_clients/actor_version_collection.ts +++ b/src/resource_clients/actor_version_collection.ts @@ -22,29 +22,20 @@ export class ActorVersionCollectionClient extends ResourceCollectionClient { * 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); + * const paginatedList = await client.list(); *``` * * 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)) {...} + * for await (const singleItem of client.list()) {...} * ``` */ list( - options: ActorVersionCollectionListOptions = {}, + _options: ActorVersionCollectionListOptions = {}, ): Promise & AsyncIterable { - ow( - options, - ow.object.exactShape({ - limit: ow.optional.number, - offset: ow.optional.number, - desc: ow.optional.boolean, - }), - ); - - return this._listPaginated(options); + return this._listPaginated(); } /** @@ -57,6 +48,10 @@ export class ActorVersionCollectionClient extends ResourceCollectionClient { } } +/** + * @deprecated No options are used in the current API implementation. + * https://github.com/apify/apify-client-js/issues/799 + */ export interface ActorVersionCollectionListOptions extends PaginationOptions { desc?: boolean; }