Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(core-concepts): add info about using detached: true in store subscriptions inside plugins #1781

Closed
wants to merge 1 commit into from
Closed

docs(core-concepts): add info about using detached: true in store subscriptions inside plugins #1781

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions packages/docs/core-concepts/plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,19 @@ pinia.use(({ store }) => {
})
```

Because `$subscribe` and `$onAction` are bound to components lifecycle, you will lose them after a component that they were first called in is destroyed. In most cases, you want to keep plugin subscriptions for whole lifetime of your app. To do that use `detached: true` option:

```ts
pinia.use(({ store }) => {
store.$subscribe(() => {
// react to store changes
}, { detached: true })
store.$onAction(() => {
// react to store actions
}, true)
})
```

## Adding new options

It is possible to create new options when defining stores to later on consume them from plugins. For example, you could create a `debounce` option that allows you to debounce any action:
Expand Down