strongly type endpoint name

reduxjs · Apr 6, 2024 · 9c30ca8 · 9c30ca8
1 parent fd52689
commit 9c30ca8
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 4 deletions.
diff --git a/packages/toolkit/src/query/core/buildInitiate.ts b/packages/toolkit/src/query/core/buildInitiate.ts
@@ -29,6 +29,7 @@ declare module './module' {
     Definition extends QueryDefinition<any, any, any, any, any>,
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     Definitions extends EndpointDefinitions,
+    EndpointName extends PropertyKey = string,
   > {
     initiate: StartQueryActionCreator<Definition>
   }
@@ -37,6 +38,7 @@ declare module './module' {
     Definition extends MutationDefinition<any, any, any, any, any>,
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     Definitions extends EndpointDefinitions,
+    EndpointName extends PropertyKey = string,
   > {
     initiate: StartMutationActionCreator<Definition>
   }

diff --git a/packages/toolkit/src/query/core/buildSelectors.ts b/packages/toolkit/src/query/core/buildSelectors.ts
@@ -53,6 +53,7 @@ declare module './module' {
   export interface ApiEndpointQuery<
     Definition extends QueryDefinition<any, any, any, any, any>,
     Definitions extends EndpointDefinitions,
+    EndpointName extends PropertyKey = string,
   > {
     select: QueryResultSelectorFactory<
       Definition,
@@ -67,6 +68,7 @@ declare module './module' {
   export interface ApiEndpointMutation<
     Definition extends MutationDefinition<any, any, any, any, any>,
     Definitions extends EndpointDefinitions,
+    EndpointName extends PropertyKey = string,
   > {
     select: MutationResultSelectorFactory<
       Definition,

diff --git a/packages/toolkit/src/query/core/buildThunks.ts b/packages/toolkit/src/query/core/buildThunks.ts
@@ -52,12 +52,14 @@ declare module './module' {
     Definition extends QueryDefinition<any, any, any, any, any>,
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     Definitions extends EndpointDefinitions,
+    EndpointName extends PropertyKey = string,
   > extends Matchers<QueryThunk, Definition> {}
 
   export interface ApiEndpointMutation<
     Definition extends MutationDefinition<any, any, any, any, any>,
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     Definitions extends EndpointDefinitions,
+    EndpointName extends PropertyKey = string,
   > extends Matchers<MutationThunk, Definition> {}
 }
 

diff --git a/packages/toolkit/src/query/core/module.ts b/packages/toolkit/src/query/core/module.ts
@@ -379,9 +379,9 @@ declare module '../apiTypes' {
           any,
           any
         >
-          ? ApiEndpointQuery<Definitions[K], Definitions>
+          ? ApiEndpointQuery<Definitions[K], Definitions, K>
           : Definitions[K] extends MutationDefinition<any, any, any, any, any>
-            ? ApiEndpointMutation<Definitions[K], Definitions>
+            ? ApiEndpointMutation<Definitions[K], Definitions, K>
             : never
       }
     }
@@ -393,8 +393,9 @@ export interface ApiEndpointQuery<
   Definition extends QueryDefinition<any, any, any, any, any>,
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   Definitions extends EndpointDefinitions,
+  EndpointName extends PropertyKey = string,
 > {
-  name: string
+  name: EndpointName
   /**
    * All of these are `undefined` at runtime, purely to be used in TypeScript declarations!
    */
@@ -407,8 +408,9 @@ export interface ApiEndpointMutation<
   Definition extends MutationDefinition<any, any, any, any, any>,
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   Definitions extends EndpointDefinitions,
+  EndpointName extends PropertyKey = string,
 > {
-  name: string
+  name: EndpointName
   /**
    * All of these are `undefined` at runtime, purely to be used in TypeScript declarations!
    */

diff --git a/packages/toolkit/src/query/tests/createApi.test-d.ts b/packages/toolkit/src/query/tests/createApi.test-d.ts
@@ -51,6 +51,26 @@ describe('type tests', () => {
       tagTypes: ['typeA', 'typeB'],
     })
 
+    test('strongly typed name property', () => {
+      const injectedApi = api.injectEndpoints({
+        endpoints: (build) => ({
+          getPost: build.query({
+            query: () => 'From',
+          }),
+          updatePost: build.mutation({
+            query: () => 'From',
+          }),
+        }),
+      })
+
+      expectTypeOf(
+        injectedApi.endpoints.getPost.name,
+      ).toEqualTypeOf<'getPost'>()
+      expectTypeOf(
+        injectedApi.endpoints.updatePost.name,
+      ).toEqualTypeOf<'updatePost'>()
+    })
+
     test('query: query & transformResponse types', () => {
       api.injectEndpoints({
         endpoints: (build) => ({