Skip to content

docs: add docs for the new error option for subscribeAction method #1746

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

Merged
merged 2 commits into from
May 9, 2020
Merged

docs: add docs for the new error option for subscribeAction method #1746

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e91f41
docs: add docs for the new `error` option for `subscribeAction` method
kiaking May 8, 2020
c2ad79e
docs: fix typos
kiaking May 9, 2020
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
15 changes: 14 additions & 1 deletion docs/api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,20 @@ const store = new Vuex.Store({ ...options })
})
```

Most commonly used in plugins. [Details](../guide/plugins.md)
> New in 3.4.0

Since 3.4.0, `subscribeAction` can also specify an `error` handler to catch an error thrown when an action is dispatched. The function will receive an `error` object as the third argument.

``` js
store.subscribeAction({
error: (action, state, error) => {
console.log(`error action ${action.type}`)
console.error(error)
}
})
```

The `subscribeAction` method is most commonly used in plugins. [Details](../guide/plugins.md)

### registerModule

Expand Down