ensure it's only possible to pass all or none of the hooks

Author: ben.durrant

packages/toolkit/src/query/createApi.ts

@@ -219,7 +219,11 @@ export type CreateApi<Modules extends ModuleName> = {
  * const MyContext = React.createContext<ReactReduxContextValue>(null as any);
  * const customCreateApi = buildCreateApi(
  *   coreModule(),
- *   reactHooksModule({ useDispatch: createDispatchHook(MyContext) })
+ *   reactHooksModule({
+ *     useDispatch: createDispatchHook(MyContext),
+ *     useSelector: createSelectorHook(MyContext),
+ *     useStore: createStoreHook(MyContext)
+ *   })
  * );
  * ```
  *

packages/toolkit/src/query/react/module.ts

@@ -9,6 +9,7 @@ import type {
 } from '@reduxjs/toolkit/dist/query/endpointDefinitions'
 import type { Api, Module } from '../apiTypes'
 import { capitalize } from '../utils'
+import type { AllOrNone } from '../tsHelpers'
 import { safeAssign } from '../tsHelpers'
 import type { BaseQueryFn } from '@reduxjs/toolkit/dist/query/baseQueryTypes'
 
@@ -69,23 +70,26 @@ declare module '@reduxjs/toolkit/dist/query/apiTypes' {
 
 type RR = typeof import('react-redux')
 
-export interface ReactHooksModuleOptions {
-  /**
-   * The version of the `batchedUpdates` function to be used
-   */
-  batch?: RR['batch']
+type ReactHooks = {
   /**
    * The version of the `useDispatch` hook to be used
    */
-  useDispatch?: RR['useDispatch']
+  useDispatch: RR['useDispatch']
   /**
    * The version of the `useSelector` hook to be used
    */
-  useSelector?: RR['useSelector']
+  useSelector: RR['useSelector']
   /**
    * The version of the `useStore` hook to be used
    */
-  useStore?: RR['useStore']
+  useStore: RR['useStore']
+}
+
+export type ReactHooksModuleOptions = AllOrNone<ReactHooks> & {
+  /**
+   * The version of the `batchedUpdates` function to be used
+   */
+  batch?: RR['batch']
   /**
    * Enables performing asynchronous tasks immediately within a render.
    *
@@ -115,7 +119,11 @@ export interface ReactHooksModuleOptions {
  * const MyContext = React.createContext<ReactReduxContextValue>(null as any);
  * const customCreateApi = buildCreateApi(
  *   coreModule(),
- *   reactHooksModule({ useDispatch: createDispatchHook(MyContext) })
+ *   reactHooksModule({
+ *     useDispatch: createDispatchHook(MyContext),
+ *     useSelector: createSelectorHook(MyContext),
+ *     useStore: createStoreHook(MyContext)
+ *   })
  * );
  * ```
  *

packages/toolkit/src/query/tsHelpers.ts

@@ -2,13 +2,14 @@ export type Id<T> = { [K in keyof T]: T[K] } & {}
 export type WithRequiredProp<T, K extends keyof T> = Omit<T, K> &
   Required<Pick<T, K>>
 export type Override<T1, T2> = T2 extends any ? Omit<T1, keyof T2> & T2 : never
+export type AllOrNone<T> = T | { [K in keyof T]?: never }
 export function assertCast<T>(v: any): asserts v is T {}
 
 export function safeAssign<T extends object>(
   target: T,
   ...args: Array<Partial<NoInfer<T>>>
-) {
-  Object.assign(target, ...args)
+): T {
+  return Object.assign(target, ...args)
 }
 
 /**