fix types

Kinto · Apr 3, 2023 · a355cbe · a355cbe
1 parent 91190c2
commit a355cbe
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 4 deletions.
diff --git a/src/http/base.ts b/src/http/base.ts
@@ -538,6 +538,26 @@ export default class KintoClientBase {
    * JSON.
    * @return {Promise<Object, Error>}
    */
+  async execute<T>(
+    request: KintoRequest,
+    options: {
+      raw: true;
+      stringify?: boolean;
+      retry?: number;
+      query?: { [key: string]: string };
+      fields?: string[];
+    }
+  ): Promise<HttpResponse<T>>;
+  async execute<T>(
+    request: KintoRequest,
+    options?: {
+      raw?: false;
+      stringify?: boolean;
+      retry?: number;
+      query?: { [key: string]: string };
+      fields?: string[];
+    }
+  ): Promise<T>;
   async execute<T>(
     request: KintoRequest,
     options: {
@@ -992,6 +1012,6 @@ export default class KintoClientBase {
         { data: { password } },
         { method: "PUT" }
       )
-    ) as Promise<KintoResponse<{ password: string }>>;
+    );
   }
 }
diff --git a/src/http/collection.ts b/src/http/collection.ts
@@ -147,7 +147,7 @@ export default class Collection {
       raw: true,
       retry: this._getRetry(options),
     });
-    return parseInt(headers.get("Total-Records"), 10);
+    return parseInt(headers.get("Total-Records")!, 10);
   }
 
   /**

diff --git a/src/types.ts b/src/types.ts
@@ -12,7 +12,7 @@ export type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD";
 export interface KintoRequest {
   method?: HttpMethod;
   path: string;
-  headers: HeadersInit;
+  headers: Record<string, unknown>;
   body?: any;
 }
 

diff --git a/src/utils.ts b/src/utils.ts
@@ -69,7 +69,7 @@ export function filterObject<T extends { [key: string]: any }>(
  * @param  {Array}  list     The collection to filter.
  * @return {Array}
  */
-export function filterObjects<T>(
+export function filterObjects<T extends { [key: string]: any }>(
   filters: { [key: string]: any },
   list: T[]
 ): T[] {

diff --git a/test/http/api_test.ts b/test/http/api_test.ts
@@ -755,6 +755,7 @@ describe("KintoClient", () => {
         sinon.assert.calledWithMatch(
           executeStub,
           { path: `${path}?_sort=-last_modified`, headers: {} },
+          //@ts-ignore Limitation of the Parameters type for overloaded functions
           { raw: true }
         );
       });
@@ -765,6 +766,7 @@ describe("KintoClient", () => {
         sinon.assert.calledWithMatch(
           executeStub,
           { path: `${path}?_sort=title`, headers: {} },
+          //@ts-ignore Limitation of the Parameters type for overloaded functions
           { raw: true }
         );
       });
@@ -839,6 +841,7 @@ describe("KintoClient", () => {
         sinon.assert.calledWithMatch(
           executeStub,
           { path: `${path}?${expectedQS}`, headers: {} },
+          //@ts-ignore Limitation of the Parameters type for overloaded functions
           { raw: true }
         );
       });
@@ -850,6 +853,7 @@ describe("KintoClient", () => {
         sinon.assert.calledWithMatch(
           executeStub,
           { path: `${path}?${expectedQS}`, headers: {} },
+          //@ts-ignore Limitation of the Parameters type for overloaded functions
           { raw: true }
         );
       });
@@ -874,6 +878,7 @@ describe("KintoClient", () => {
         sinon.assert.calledWithMatch(
           executeStub,
           { path: `${path}?${expectedQS}`, headers: {} },
+          //@ts-ignore Limitation of the Parameters type for overloaded functions
           { raw: true }
         );
       });

diff --git a/test/http/bucket_test.ts b/test/http/bucket_test.ts
@@ -188,6 +188,7 @@ describe("Bucket", () => {
       sinon.assert.calledWithMatch(
         executeStub,
         { method: "HEAD", path: "/buckets/blog/collections", headers: {} },
+        //@ts-ignore Limitation of the Parameters type for overloaded functions
         { raw: true }
       );
     });
@@ -558,6 +559,7 @@ describe("Bucket", () => {
       sinon.assert.calledWithMatch(
         executeStub,
         { method: "HEAD", path: "/buckets/blog/groups", headers: {} },
+        //@ts-ignore Limitation of the Parameters type for overloaded functions
         { raw: true }
       );
     });

diff --git a/test/http/collection_test.ts b/test/http/collection_test.ts
@@ -51,6 +51,7 @@ describe("HTTP Collection", () => {
           path: "/buckets/blog/collections/posts/records",
           headers: {},
         },
+        //@ts-ignore Limitation of the Parameters type for overloaded functions
         { raw: true }
       );
     });
@@ -705,6 +706,7 @@ describe("HTTP Collection", () => {
           path: "/buckets/blog/collections/posts/records",
           headers: {},
         },
+        //@ts-ignore Limitation of the Parameters type for overloaded functions
         { raw: true }
       );
     });