chore: Add JDoc type declaration for client.getStackClient()

cozy · Sep 22, 2022 · 928529d · 928529d
1 parent 2447efe
commit 928529d
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 3 deletions.
diff --git a/packages/cozy-client/src/CozyClient.js b/packages/cozy-client/src/CozyClient.js
@@ -1632,6 +1632,11 @@ instantiation of the client.`
     return this.getStackClient()
   }
 
+  /**
+   * Retrieve the CozyStackClient instance used by CozyClient
+   *
+   * @returns {CozyStackClient} - CozyStackClient instance
+   */
   getStackClient() {
     if (!this.stackClient) {
       this.createClient()

diff --git a/packages/cozy-client/types/CozyClient.d.ts b/packages/cozy-client/types/CozyClient.d.ts
@@ -297,7 +297,7 @@ declare class CozyClient {
      * @returns {DocumentCollection} Collection corresponding to the doctype
      */
     collection(doctype: string): DocumentCollection;
-    fetch(method: any, path: any, body: any, options?: {}): any;
+    fetch(method: any, path: any, body: any, options?: {}): Promise<object>;
     all(doctype: any): QueryDefinition;
     find(doctype: any, selector?: any): QueryDefinition;
     get(doctype: any, id: any): QueryDefinition;
@@ -660,8 +660,13 @@ declare class CozyClient {
     createClient(): void;
     stackClient: any;
     client: any;
-    getClient(): any;
-    getStackClient(): any;
+    getClient(): CozyStackClient;
+    /**
+     * Retrieve the CozyStackClient instance used by CozyClient
+     *
+     * @returns {CozyStackClient} - CozyStackClient instance
+     */
+    getStackClient(): CozyStackClient;
     reducer(): (state: {
         documents: {};
         queries: {};
@@ -733,6 +738,7 @@ import { OpenURLCallback } from "./types";
 import { SessionCode } from "./types";
 import { PKCECodes } from "./types";
 import { ReduxStore } from "./types";
+import CozyStackClient from "cozy-stack-client";
 import { CozyClient as SnapshotClient } from "./testing/snapshots";
 import { OldCozyClient } from "./types";
 import { NodeEnvironment } from "./types";