Disambiguate delete by query method singature types

#187 (comment)
typesense · Jan 4, 2024 · ba1e283 · ba1e283
1 parent 6369b2d
commit ba1e283
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 37 deletions.
diff --git a/dist/typesense.js b/dist/typesense.js
diff --git a/dist/typesense.js.map b/dist/typesense.js.map
diff --git a/lib/Typesense/Documents.d.ts b/lib/Typesense/Documents.d.ts
@@ -170,7 +170,7 @@ export interface WriteableDocuments<T> {
     create(document: T, options: DocumentWriteParameters): Promise<T>;
     upsert(document: T, options: DocumentWriteParameters): Promise<T>;
     update(document: T, options: DocumentWriteParameters): Promise<T>;
-    delete(idOrQuery: string | DeleteQuery): Promise<DeleteResponse> | Promise<T>;
+    delete(query: DeleteQuery): Promise<DeleteResponse>;
     import(documents: T[] | string, options: DocumentWriteParameters): Promise<string | ImportResponse[]>;
     export(options: DocumentsExportParameters): Promise<string>;
 }
@@ -184,8 +184,7 @@ export default class Documents<T extends DocumentSchema = object> extends Search
     upsert(document: T, options?: DocumentWriteParameters): Promise<T>;
     update(document: T, options: UpdateByFilterParameters): Promise<UpdateByFilterResponse>;
     update(document: T, options: DocumentWriteParameters): Promise<T>;
-    delete(idOrQuery: DeleteQuery): Promise<DeleteResponse>;
-    delete(idOrQuery: string): Promise<T>;
+    delete(query?: DeleteQuery): Promise<DeleteResponse>;
     createMany(documents: T[], options?: DocumentImportParameters): Promise<ImportResponse[]>;
     /**
      * Import a set of documents in a batch.

diff --git a/lib/Typesense/Documents.js b/lib/Typesense/Documents.js
diff --git a/lib/Typesense/Documents.js.map b/lib/Typesense/Documents.js.map
diff --git a/src/Typesense/Documents.ts b/src/Typesense/Documents.ts
@@ -199,7 +199,7 @@ export interface WriteableDocuments<T> {
   create(document: T, options: DocumentWriteParameters): Promise<T>;
   upsert(document: T, options: DocumentWriteParameters): Promise<T>;
   update(document: T, options: DocumentWriteParameters): Promise<T>;
-  delete(idOrQuery: string | DeleteQuery): Promise<DeleteResponse> | Promise<T>;
+  delete(query: DeleteQuery): Promise<DeleteResponse>;
   import(
     documents: T[] | string,
     options: DocumentWriteParameters,
@@ -264,19 +264,10 @@ export default class Documents<T extends DocumentSchema = object>
     }
   }
 
-  async delete(idOrQuery: DeleteQuery): Promise<DeleteResponse>;
-  async delete(idOrQuery: string): Promise<T>;
   async delete(
-    idOrQuery: string | DeleteQuery = {} as DeleteQuery,
-  ): Promise<DeleteResponse | T> {
-    if (typeof idOrQuery === "string") {
-      return this.apiCall.delete<T>(this.endpointPath(idOrQuery), idOrQuery);
-    } else {
-      return this.apiCall.delete<DeleteResponse>(
-        this.endpointPath(),
-        idOrQuery,
-      );
-    }
+    query: DeleteQuery = {} as DeleteQuery,
+  ): Promise<DeleteResponse> {
+    return this.apiCall.delete<DeleteResponse>(this.endpointPath(), query);
   }
 
   async createMany(documents: T[], options: DocumentImportParameters = {}) {