search

cloudinary / cloudinary_npm

Cloudinary NPM for node.js integration
629 stars 323 forks source link

Typescript error on search API #636

Closed Bilboramix closed 9 months ago

Bilboramix commented 1 year ago

Describe the bug in a sentence or two.

Typescript is showing a type error when using v2.api.search() : The first parameter of the function is defined as a string.

The doc should be more explicit about what type to use with the function. It also show a .execute() chain call that lead to the error execute is not a function

Issue Type

Documentation - Inconsistency between the docs and behaviour Incorrect Types - For typescript users who are having problems with our d.ts files

Error screenshots

image

Doc suggestion :

Change image

To image

Add a little reminder to say that this syntax is not valid : https://github.com/adentranter/adentranter.com/blob/1d167feb91d370a111adca7d4fbbf7b81cf8c5b0/src/utils/cachedImages.ts#L8

Regards, Bill.

tommyg-cld commented 1 year ago

@Bilboramix thx for raising this and apologies for the delay - so this is a known issue that we hope to address it soon. We will keep you posted.

victorli-cloudinary commented 9 months ago

Hi @Bilboramix , just wanted to update you that we've added a fix so that searches can be executed without a query, which is consistent with the example in the documentation you pointed out, that wasn't previously working. Thanks for bringing this to our attention! I believe the change will be live early next week.