docs: update `$state` JSDoc to reflect internal patching (#2199)

Co-authored-by: Eduardo San Martin Morote <posva@users.noreply.github.com>

diff --git a/packages/pinia/src/types.ts b/packages/pinia/src/types.ts
index 4907fc6ce5c5491532db38860fa790f015ada45b..568695d870430d87d22cd0b424c06fd16f50349e 100644 (file)
--- a/packages/pinia/src/types.ts
+++ b/packages/pinia/src/types.ts
@@ -321,7 +321,7 @@ export interface _StoreWithState<
   A /* extends ActionsTree */
 > extends StoreProperties<Id> {
   /**
-   * State of the Store. Setting it will replace the whole state.
+   * State of the Store. Setting it will internally call `$patch()` to update the state.
    */
   $state: UnwrapRef<S> & PiniaCustomStateProperties<S>