docs: add state freezing in dev mode

ngrx · Nov 17, 2024 · e14e53d · e14e53d
1 parent 57ad5c5
commit e14e53d
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/projects/ngrx.io/content/guide/signals/signal-state.md b/projects/ngrx.io/content/guide/signals/signal-state.md
@@ -86,7 +86,7 @@ patchState(
 
 <div class="alert is-critical">
 
-Updaters passed to the `patchState` function must perform state updates in an immutable manner.
+The state is frozen during development mode. This means all changes via `patchState` must be immutable. If a mutable change occurs — whether through `patchState`, a component, a service, or any other entity with access to the state — an error will be thrown.
 
 </div>
 

diff --git a/projects/ngrx.io/content/guide/signals/signal-store/index.md b/projects/ngrx.io/content/guide/signals/signal-store/index.md
@@ -217,7 +217,7 @@ export const BooksStore = signalStore(
 
 <div class="alert is-helpful">
 
-The state of the SignalStore is updated using the `patchState` function.
+The state of the SignalStore is frozen in development mode, which means any mutable change will throw an error. `patchState` is the function to update the state.
 For more details on the `patchState` function, refer to the [Updating State](/guide/signals/signal-state#updating-state) guide.
 
 </div>
-Original file line number
+Diff line change
@@ Expand Up / @@ -86,7 +86,7 @@ patchState( @@
     <div class="alert is-critical">
-    Updaters passed to the `patchState` function must perform state updates in an immutable manner.
+    The state is frozen during development mode. This means all changes via `patchState` must be immutable. If a mutable change occurs — whether through `patchState`, a component, a service, or any other entity with access to the state — an error will be thrown.
     </div>
@@ Expand Down @@