Mismatch between API reference documentation and actual code : Progress Kinvey

Redirect Notice

As of April 12th, you must go to Progress SupportLink to create new support cases or to access existing cases. Please, bookmark the SupportLink URL and use the new portal to contact the support team.

How can we help you today?

Start a new topic

Mismatch between API reference documentation and actual code

Kiril Okun

started a topic about 3 years ago

API reference documentation for Datastore states find method returns Observable.

find(query: Query, options: Object): Observable

Find all entities in the collection.

But the code in kinvey-js/sdk/lib/datastore/networkstore.d.ts shows that it returns type any:

find(query?: Query, options?: any): any;

Am I looking at the wrong thing? If now this is a major problem if SDK documentation is this inacturate.

1 Comment

Martin Apostolov

said about 3 years ago

Hi Kiril,

You are correct. There is a discrepancy in the documentation and the typescript definition. the "find" method does return an Observable.

I have logged this to be fixed.

Regards

Martin Apostolov

Comments to this discussion are now closed! However, you can continue the conversation here: Datastore.find return type in documentation is incorrect