fix: Fix jsdocs in queryAll

cozy · Mar 17, 2023 · cd44d0f · cd44d0f
1 parent 541ab7c
commit cd44d0f
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/docs/api/cozy-client/classes/CozyClient.md b/docs/api/cozy-client/classes/CozyClient.md
@@ -1310,7 +1310,7 @@ executes its query when mounted if no fetch policy has been indicated.
 
 ### queryAll
 
-▸ **queryAll**(`queryDefinition`, `options?`): `Promise`<`any`>
+▸ **queryAll**(`queryDefinition`, `options?`): `Promise`<`CozyClientDocument`\[]>
 
 Will fetch all documents for a `queryDefinition`, automatically fetching more
 documents if the total of documents is superior to the pagination limit. Can
@@ -1325,7 +1325,7 @@ result in a lot of network requests.
 
 *Returns*
 
-`Promise`<`any`>
+`Promise`<`CozyClientDocument`\[]>
 
 All documents matching the query
 

diff --git a/packages/cozy-client/src/CozyClient.js b/packages/cozy-client/src/CozyClient.js
@@ -994,7 +994,7 @@ client.query(Q('io.cozy.bills'))`)
    *
    * @param  {QueryDefinition} queryDefinition - Definition to be executed
    * @param {QueryOptions} [options] - Options
-   * @returns {Promise<QueryResult>} All documents matching the query
+   * @returns {Promise<CozyClientDocument[]>} All documents matching the query
    */
   async queryAll(queryDefinition, options = {}) {
     const queryId =

diff --git a/packages/cozy-client/types/CozyClient.d.ts b/packages/cozy-client/types/CozyClient.d.ts
@@ -426,9 +426,9 @@ declare class CozyClient {
      *
      * @param  {QueryDefinition} queryDefinition - Definition to be executed
      * @param {QueryOptions} [options] - Options
-     * @returns {Promise<QueryResult>} All documents matching the query
+     * @returns {Promise<CozyClientDocument[]>} All documents matching the query
      */
-    queryAll(queryDefinition: QueryDefinition, options?: QueryOptions): Promise<QueryResult>;
+    queryAll(queryDefinition: QueryDefinition, options?: QueryOptions): Promise<CozyClientDocument[]>;
     watchQuery(...args: any[]): ObservableQuery;
     makeObservableQuery(queryDefinition: any, options?: {}): ObservableQuery;
     /**