Skip to content

Commit

Permalink
docs: note about readonly
Browse files Browse the repository at this point in the history
Close ##2701
  • Loading branch information
posva committed Jun 24, 2024
1 parent 165efa8 commit 2c01fc0
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion packages/docs/cookbook/composables.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ export const useAuthStore = defineStore('auth', {
})
```

In [Setup Stores](#setup-stores), you need to use a helper named `skipHydrate()` on any state property that shouldn't be picked up from the initial state. Differently from option stores, setup stores cannot just _skip calling `state()`_, so we mark properties that cannot be hydrated with `skipHydrate()`. Note that this only applies to writable reactive properties:
In [Setup Stores](#setup-stores), you need to use a helper named `skipHydrate()` on any state property that shouldn't be picked up from the initial state. Differently from option stores, setup stores cannot just _skip calling `state()`_, so we mark properties that cannot be hydrated with `skipHydrate()`. Note that this only applies to state properties:

```ts
import { defineStore, skipHydrate } from 'pinia'
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/core-concepts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ In _Setup Stores_:
- `computed()`s become `getters`
- `function()`s become `actions`

Note that you **must** return **all state properties** in setup stores for Pinia to pick them up as state. In other words, you cannot have _private_ state properties in stores. Not returning all state properties can break [SSR](../cookbook/composables.md), devtools, and other plugins.
Note that you **must** return **all state properties** in setup stores for Pinia to pick them up as state. In other words, you cannot have [_private_ state properties in stores](https://masteringpinia.com/blog/how-to-create-private-state-in-stores). Not returning all state properties or **making them readonly** will break [SSR](../cookbook/composables.md), devtools, and other plugins.

Setup stores bring a lot more flexibility than [Option Stores](#option-stores) as you can create watchers within a store and freely use any [composable](https://vuejs.org/guide/reusability/composables.html#composables). However, keep in mind that using composables will get more complex when using SSR.

Expand Down

0 comments on commit 2c01fc0

Please sign in to comment.