Merge pull request #4184 from reduxjs/empty-combineslices

allow initialising combined slice reducer with no static slices
reduxjs · Feb 11, 2024 · 242a016 · 242a016
2 parents 80b7656 + a548b41
commit 242a016
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 21 deletions.
diff --git a/docs/api/combineSlices.mdx b/docs/api/combineSlices.mdx
@@ -86,17 +86,6 @@ However, typing will not be able to account for this. It's best to ensure that a
 
 :::
 
-:::warning
-
-Like [`combineReducers`](https://redux.js.org/api/combinereducers), `combineSlices` requires at least one reducer at initialisation.
-
-```ts no-transpile
-// will throw an error
-const rootReducer = combineSlices()
-```
-
-:::
-
 ## Return Value
 
 `combineSlices` returns a reducer function, with attached methods.

diff --git a/packages/toolkit/src/combineSlices.ts b/packages/toolkit/src/combineSlices.ts
@@ -359,15 +359,15 @@ const original = (state: any) => {
   return state[ORIGINAL_STATE]
 }
 
-export function combineSlices<
-  Slices extends [
-    AnySliceLike | ReducerMap,
-    ...Array<AnySliceLike | ReducerMap>,
-  ],
->(...slices: Slices): CombinedSliceReducer<Id<InitialState<Slices>>> {
+const noopReducer: Reducer<Record<string, any>> = (state = {}) => state
+
+export function combineSlices<Slices extends Array<AnySliceLike | ReducerMap>>(
+  ...slices: Slices
+): CombinedSliceReducer<Id<InitialState<Slices>>> {
   const reducerMap = Object.fromEntries<Reducer>(getReducers(slices))
 
-  const getReducer = () => combineReducers(reducerMap)
+  const getReducer = () =>
+    Object.keys(reducerMap).length ? combineReducers(reducerMap) : noopReducer
 
   let reducer = getReducer()
 

diff --git a/packages/toolkit/src/tests/combineSlices.test-d.ts b/packages/toolkit/src/tests/combineSlices.test-d.ts
@@ -33,6 +33,19 @@ describe('type tests', () => {
     }>()
   })
 
+  test('combineSlices allows passing no initial reducers', () => {
+    const rootReducer = combineSlices()
+
+    expectTypeOf(rootReducer(undefined, { type: '' })).toEqualTypeOf<{}>()
+
+    const declaredLazy =
+      combineSlices().withLazyLoadedSlices<WithSlice<typeof numberSlice>>()
+
+    expectTypeOf(declaredLazy(undefined, { type: '' })).toEqualTypeOf<{
+      number?: number
+    }>()
+  })
+
   test('withLazyLoadedSlices adds partial to state', () => {
     const rootReducer = combineSlices(stringSlice).withLazyLoadedSlices<
       WithSlice<typeof numberSlice> & WithSlice<typeof exampleApi>
@@ -199,8 +212,8 @@ describe('type tests', () => {
       number: number
     }>()
 
-    expectTypeOf(withNumber(undefined, { type: '' }).number).toMatchTypeOf<
-      number
-    >()
+    expectTypeOf(
+      withNumber(undefined, { type: '' }).number,
+    ).toMatchTypeOf<number>()
   })
 })
diff --git a/packages/toolkit/src/tests/combineSlices.test.ts b/packages/toolkit/src/tests/combineSlices.test.ts
@@ -64,6 +64,16 @@ describe('combineSlices', () => {
       api: api.reducer.getInitialState(),
     })
   })
+  it('allows passing no initial reducers', () => {
+    const combinedReducer = combineSlices()
+
+    const result = combinedReducer(undefined, dummyAction())
+
+    expect(result).toEqual({})
+
+    // no-op if we have no reducers yet
+    expect(combinedReducer(result, dummyAction())).toBe(result)
+  })
   describe('injects', () => {
     beforeEach(() => {
       vi.stubEnv('NODE_ENV', 'development')