Merge pull request #4035 from reduxjs/create-app-slice

Rename "createSliceWithThunks" and "createThunkSlice" to "createAppSlice"
reduxjs · Jan 3, 2024 · ed8282e · ed8282e
2 parents f3748d9 + 0b9fdcc
commit ed8282e
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 10 deletions.
diff --git a/docs/api/createSlice.mdx b/docs/api/createSlice.mdx
@@ -251,13 +251,12 @@ Instead, import `buildCreateSlice` and `asyncThunkCreator`, and create your own
 ```ts
 import { buildCreateSlice, asyncThunkCreator } from '@reduxjs/toolkit'
 
-// name is up to you
-export const createSliceWithThunks = buildCreateSlice({
+export const createAppSlice = buildCreateSlice({
   creators: { asyncThunk: asyncThunkCreator },
 })
 ```
 
-Then import this `createSlice` as needed instead of the exported version from RTK.
+Then import this `createAppSlice` as needed instead of the exported version from RTK.
 
 :::
 

diff --git a/docs/usage/migrating-rtk-2.md b/docs/usage/migrating-rtk-2.md
@@ -657,11 +657,11 @@ In practice, we hope these are reasonable tradeoffs. Creating thunks inside of `
 Here's what the new callback syntax looks like:
 
 ```ts
-const createSliceWithThunks = buildCreateSlice({
+const createAppSlice = buildCreateSlice({
   creators: { asyncThunk: asyncThunkCreator },
 })
 
-const todosSlice = createSliceWithThunks({
+const todosSlice = createAppSlice({
   name: 'todos',
   initialState: {
     loading: false,

diff --git a/packages/toolkit/src/tests/createSlice.test.ts b/packages/toolkit/src/tests/createSlice.test.ts
@@ -590,7 +590,7 @@ describe('createSlice', () => {
         '"Cannot use `create.asyncThunk` in the built-in `createSlice`. Use `buildCreateSlice({ creators: { asyncThunk: asyncThunkCreator } })` to create a customised version of `createSlice`."'
       )
     })
-    const createThunkSlice = buildCreateSlice({
+    const createAppSlice = buildCreateSlice({
       creators: { asyncThunk: asyncThunkCreator },
     })
     function pending(state: any[], action: any) {
@@ -607,7 +607,7 @@ describe('createSlice', () => {
     }
 
     test('successful thunk', async () => {
-      const slice = createThunkSlice({
+      const slice = createAppSlice({
         name: 'test',
         initialState: [] as any[],
         reducers: (create) => ({
@@ -650,7 +650,7 @@ describe('createSlice', () => {
     })
 
     test('rejected thunk', async () => {
-      const slice = createThunkSlice({
+      const slice = createAppSlice({
         name: 'test',
         initialState: [] as any[],
         reducers: (create) => ({
@@ -694,7 +694,7 @@ describe('createSlice', () => {
     })
 
     test('with options', async () => {
-      const slice = createThunkSlice({
+      const slice = createAppSlice({
         name: 'test',
         initialState: [] as any[],
         reducers: (create) => ({
@@ -743,7 +743,7 @@ describe('createSlice', () => {
     })
 
     test('has caseReducers for the asyncThunk', async () => {
-      const slice = createThunkSlice({
+      const slice = createAppSlice({
         name: 'test',
         initialState: [],
         reducers: (create) => ({