From: Alex Liu <dsa1314@gmail.com>
Date: Mon, 15 May 2023 13:39:28 +0000 (+0800)
Subject: docs: update `$state` JSDoc to reflect internal patching (#2199)
X-Git-Tag: @pinia/nuxt@0.4.11~21
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d710cb8ee4c947322f56668f54eea00be7ebbfd9;p=thirdparty%2Fvuejs%2Fpinia.git

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 4907fc6c..568695d8 100644
--- 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>