Skip to content

Commit

Permalink
docs: note about state in setup stores
Browse files Browse the repository at this point in the history
See #2324
  • Loading branch information
posva committed Jul 25, 2023
1 parent b560467 commit c57a17f
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions packages/docs/core-concepts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ In _Setup Stores_:
- `computed()`s become `getters`
- `function()`s become `actions`

Note 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.

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](../cookbook/composables.md).

Setup stores are also able to rely on globally _provided_ properties like the Router or the Route. Any property [provided at the App level](https://vuejs.org/api/application.html#app-provide) can be accessed from the store using `inject()`, just like in components:
Expand Down

0 comments on commit c57a17f

Please sign in to comment.