docs(signals): clarify that signal type can only be an object literal.

Closes ngrx#4316
rainerhahnekamp · May 12, 2024 · 8794352 · 8794352
1 parent 22a3adf
commit 8794352
Show file tree

Hide file tree

Showing 2 changed files with 4 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
@@ -19,7 +19,9 @@ const userState = signalState<UserState>({
 });
 ```
 
-As a result, it returns an extended version of a signal that possesses all the capabilities of a read-only signal.
+The state's type must be a record/object literal. Add arrays or primitive values to properties.
+
+`signalState` returns an extended version of a signal that possesses all the capabilities of a read-only signal.
 
 ```ts
 import { computed, effect } from '@angular/core';

diff --git a/projects/ngrx.io/content/guide/signals/signal-store/index.md b/projects/ngrx.io/content/guide/signals/signal-store/index.md
@@ -11,7 +11,7 @@ Through the combination of store features, the SignalStore gains state, computed
 Based on the utilized features, the `signalStore` function returns an injectable service that can be provided and injected where needed.
 
 The `withState` feature is used to add state properties to the SignalStore.
-This feature accepts initial state as an input argument.
+This feature accepts initial state as an input argument. As with `signalState`, the state's type must be a record/object literal.
 
 <code-example header="books.store.ts">