fix: ApiOptions intellisense (#9)

ssukienn · Mar 26, 2024 · 30a5448 · 30a5448
1 parent 5f33848
commit 30a5448
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 5 deletions.
diff --git a/lib/api-specification.spec.ts b/lib/api-specification.spec.ts
@@ -7,8 +7,13 @@ const bindTrailArgs = (fn: Function, ...bound_args: any[]) => {
   };
 };
 
-import { ApiExtraModels, ApiOperation, ApiResponse } from "@nestjs/swagger";
-import { ApiSpecification } from "./api-specification";
+import {
+  ApiExtraModels,
+  ApiOperation,
+  ApiQueryOptions,
+  ApiResponse,
+} from "@nestjs/swagger";
+import { ApiOptions, ApiSpecification } from "./api-specification";
 
 // Mock specific decorator factory to return their params instead of decorator itself
 jest.mock("@nestjs/swagger", () => ({
@@ -323,3 +328,11 @@ describe("ApiSpecification", () => {
     });
   });
 });
+
+describe("ApiOptions", () => {
+  it("intellisense should work", () => {
+    const options: ApiOptions = {
+      apiQueryOptions: (apiDecorator) => [],
+    };
+  });
+});
diff --git a/lib/api-specification.ts b/lib/api-specification.ts
@@ -108,10 +108,10 @@ type ApiDecoratorFactories = {
     : never]: NestJsSwaggerMethods[K];
 };
 
-type OrderSuffix = `${number}` | "";
-
 export type ApiOptions = {
-  [K in keyof ApiDecoratorFactories as `${Uncapitalize<K>}Options${string}`]?: (
+  [K in keyof ApiDecoratorFactories as `${Uncapitalize<K>}Options${
+    | number
+    | ""}`]?: (
     apiDecorator: ApiDecoratorFactories[K] & { brand: K },
   ) =>
     | ReturnType<ApiDecoratorFactories[K] & { brand: K }>