Merge pull request #4225 from k-yle/satisfies

suggest using the `satisfies` operator for `initialState`

Author: EskiMojo14

docs/api/autoBatchEnhancer.mdx

@@ -27,7 +27,7 @@ interface CounterState {
 
 const counterSlice = createSlice({
   name: 'counter',
-  initialState: { value: 0 } as CounterState,
+  initialState: { value: 0 } satisfies CounterState as CounterState,
   reducers: {
     incrementBatched: {
       // Batched, low-priority

docs/api/createAsyncThunk.mdx

@@ -39,14 +39,14 @@ const fetchUserById = createAsyncThunk(
 )
 
 interface UsersState {
-  entities: []
+  entities: User[]
   loading: 'idle' | 'pending' | 'succeeded' | 'failed'
 }
 
 const initialState = {
   entities: [],
   loading: 'idle',
-} as UsersState
+} satisfies UserState as UsersState
 
 // Then, handle actions in your reducers:
 const usersSlice = createSlice({
@@ -699,7 +699,7 @@ interface UsersState {
 const initialState = {
   entities: {},
   error: null,
-} as UsersState
+} satisfies UsersState as UsersState
 
 const usersSlice = createSlice({
   name: 'users',

docs/api/createReducer.mdx

@@ -52,7 +52,7 @@ const increment = createAction('counter/increment')
 const decrement = createAction('counter/decrement')
 const incrementByAmount = createAction<number>('counter/incrementByAmount')
 
-const initialState = { value: 0 } as CounterState
+const initialState = { value: 0 } satisfies CounterState as CounterState
 
 const counterReducer = createReducer(initialState, (builder) => {
   builder

docs/api/createSlice.mdx

@@ -25,7 +25,7 @@ interface CounterState {
   value: number
 }
 
-const initialState = { value: 0 } as CounterState
+const initialState = { value: 0 } satisfies CounterState as CounterState
 
 const counterSlice = createSlice({
   name: 'counter',
@@ -158,7 +158,7 @@ const todosSlice = createSlice({
   initialState: {
     loading: false,
     todos: [],
-  } as TodoState,
+  } satisfies TodoState as TodoState,
   reducers: (create) => ({
     deleteTodo: create.reducer<number>((state, action) => {
       state.todos.splice(action.payload, 1)
@@ -513,7 +513,7 @@ interface CounterState {
 
 const counterSlice = createSlice({
   name: 'counter',
-  initialState: { value: 0 } as CounterState,
+  initialState: { value: 0 } satisfies CounterState as CounterState,
   reducers: {
     // omitted
   },
@@ -542,7 +542,7 @@ interface CounterState {
 
 const counterSlice = createSlice({
   name: 'counter',
-  initialState: { value: 0 } as CounterState,
+  initialState: { value: 0 } satisfies CounterState as CounterState,
   reducers: {
     // omitted
   },
@@ -608,7 +608,7 @@ const decrementBy = createAction<number>('decrementBy')
 
 const counter = createSlice({
   name: 'counter',
-  initialState: 0 as number,
+  initialState: 0 satisfies number as number,
   reducers: {
     increment: (state) => state + 1,
     decrement: (state) => state - 1,

docs/api/matching-utilities.mdx

@@ -181,7 +181,7 @@ interface ExampleState {
 const initialState = {
   isSpecial: false,
   isInteresting: false,
-} as ExampleState
+} satisfies ExampleState as ExampleState
 
 export const isSpecialAndInterestingThunk = createAsyncThunk(
   'isSpecialAndInterestingThunk',

docs/api/otherExports.mdx

@@ -66,7 +66,7 @@ interface Todo {
 }
 const addTodo = createAction<Todo>('addTodo')
 
-const initialState = [] as Todo[]
+const initialState = [] satisfies Todo[] as Todo[]
 
 const todosReducer = createReducer(initialState, (builder) => {
   builder.addCase(addTodo, (state, action) => {

docs/tutorials/typescript.md

@@ -149,7 +149,7 @@ In some cases, [TypeScript may unnecessarily tighten the type of the initial sta
 // Workaround: cast state instead of declaring variable type
 const initialState = {
   value: 0,
-} as CounterState
+} satisfies CounterState as CounterState
 ```
 
 ### Use Typed Hooks in Components

docs/usage/usage-with-typescript.md

@@ -273,7 +273,7 @@ createSlice({
 
 You might have noticed that it is not a good idea to pass your `SliceState` type as a generic to `createSlice`. This is due to the fact that in almost all cases, follow-up generic parameters to `createSlice` need to be inferred, and TypeScript cannot mix explicit declaration and inference of generic types within the same "generic block".
 
-The standard approach is to declare an interface or type for your state, create an initial state value that uses that type, and pass the initial state value to `createSlice`. You can also use the construct `initialState: myInitialState as SliceState`.
+The standard approach is to declare an interface or type for your state, create an initial state value that uses that type, and pass the initial state value to `createSlice`. You can also use the construct `initialState: myInitialState satisfies SliceState as SliceState`.
 
 ```ts {1,4,8,15}
 type SliceState = { state: 'loading' } | { state: 'finished'; data: string }
@@ -290,7 +290,7 @@ createSlice({
 // Or, cast the initial state as necessary
 createSlice({
   name: 'test2',
-  initialState: { state: 'loading' } as SliceState,
+  initialState: { state: 'loading' } satisfies SliceState as SliceState,
   reducers: {},
 })
 ```
@@ -368,14 +368,14 @@ const fetchUserById = createAsyncThunk(
 )
 
 interface UsersState {
-  entities: []
+  entities: User[]
   loading: 'idle' | 'pending' | 'succeeded' | 'failed'
 }
 
 const initialState = {
   entities: [],
   loading: 'idle',
-} as UsersState
+} satisfies UsersState as UsersState
 
 const usersSlice = createSlice({
   name: 'users',

docs/virtual/matchers/index.ts

@@ -37,7 +37,7 @@ export interface ExampleState {
 export const initialState = {
   isSpecial: false,
   isInteresting: false,
-} as ExampleState
+} satisfies ExampleState as ExampleState
 
 export const isSpecialAndInterestingThunk = createAsyncThunk(
   'isSpecialAndInterestingThunk',

yarn.lock

@@ -23637,11 +23637,11 @@ __metadata:
   linkType: hard
 
 "prettier@npm:^2.1.1":
-  version: 2.3.1
-  resolution: "prettier@npm:2.3.1"
+  version: 2.8.8
+  resolution: "prettier@npm:2.8.8"
   bin:
     prettier: bin-prettier.js
-  checksum: 10/dae97c14da795b789f89c84f83f86003a10482b572d1fc365b54fea81277721795da1a6a44599a655d1131ff2ea8467bae0c5ecd9def15dca67b7fe740fe2e0e
+  checksum: 10/00cdb6ab0281f98306cd1847425c24cbaaa48a5ff03633945ab4c701901b8e96ad558eb0777364ffc312f437af9b5a07d0f45346266e8245beaf6247b9c62b24
   languageName: node
   linkType: hard