Merge pull request #258 from tharropoulos/string-unions

fix(types): improve type safety for query params
typesense · Jan 23, 2025 · a81a0a9 · a81a0a9
2 parents 1939f03 + 0531afb
commit a81a0a9
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/src/Typesense/Documents.ts b/src/Typesense/Documents.ts
@@ -87,7 +87,8 @@ export const arrayableParams: ArraybleParams = {
 
 export interface SearchParams {
   // From https://typesense.org/docs/latest/api/documents.html#arguments
-  q?: string;
+  // eslint-disable-next-line @typescript-eslint/ban-types -- Can't use `object` here, it needs to intersect with `{}`
+  q?: "*" | (string & {});
   query_by?: string | string[];
   query_by_weights?: string | number[];
   prefix?: string | boolean | boolean[]; // default: true

diff --git a/src/Typesense/Operations.ts b/src/Typesense/Operations.ts
@@ -6,8 +6,9 @@ export default class Operations {
   constructor(private apiCall: ApiCall) {}
 
   async perform(
-    operationName: "vote" | "snapshot" | "cache/clear" | string,
-    queryParameters: Record<string, any> = {}
+    // eslint-disable-next-line @typescript-eslint/ban-types -- Can't use `object` here, it needs to intersect with `{}`
+    operationName: "vote" | "snapshot" | "cache/clear" | (string & {}),
+    queryParameters: Record<string, any> = {},
   ): Promise<any> {
     return this.apiCall.post(
       `${RESOURCEPATH}/${operationName}`,