docs(nuxt): Add docs for Pinia plugin #11638
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
Bundle ReportChanges will increase total bundle size by 198 bytes (0.0%) ⬆️. This is within the configured threshold ✅ Detailed changes
|
onurtemizkan
approved these changes
Oct 23, 2024
coolguyzone
reviewed
Oct 23, 2024
|
|
||
| ### `stateTransformer` (Function) | ||
|
|
||
| This is used to remove sensitive information from Pinia state. The first parameter passed to the function is the Pinia state. We attach all state changes by default. If you don't want to attach state changes to events being sent to Sentry, use `return null`. Note, that if you choose not to send state to Sentry, your errors might not have the latest version attached. |
There was a problem hiding this comment.
Suggested change
| This is used to remove sensitive information from Pinia state. The first parameter passed to the function is the Pinia state. We attach all state changes by default. If you don't want to attach state changes to events being sent to Sentry, use `return null`. Note, that if you choose not to send state to Sentry, your errors might not have the latest version attached. | |
| This is used to remove sensitive information from a Pinia state. The first parameter passed to the function is the Pinia state. We attach all state changes by default. If you don't want to attach state changes to events being sent to Sentry, use `return null`. Note, that if you choose not to send state to Sentry, your errors might not have the latest version attached: |
coolguyzone
reviewed
Oct 23, 2024
|
|
||
| ### `attachPiniaState` (Boolean) | ||
|
|
||
| This is used to attach Pinia state to Sentry events. By default, this is set to `true`. If you don't want to attach Pinia state to events being sent to Sentry, set this to `false`. |
There was a problem hiding this comment.
Suggested change
| This is used to attach Pinia state to Sentry events. By default, this is set to `true`. If you don't want to attach Pinia state to events being sent to Sentry, set this to `false`. | |
| This is used to attach Pinia state to Sentry events. By default, this is set to `true`. If you don't want to attach Pinia state to events being sent to Sentry, set this to `false`: |
coolguyzone
reviewed
Oct 23, 2024
|
|
||
| ### `addBreadcrumbs` (Boolean) | ||
|
|
||
| This is used to add breadcrumbs to Sentry events. By default, this is set to `true`. If you don't want to add breadcrumbs to events being sent to Sentry, set this to `false`. |
There was a problem hiding this comment.
Suggested change
| This is used to add breadcrumbs to Sentry events. By default, this is set to `true`. If you don't want to add breadcrumbs to events being sent to Sentry, set this to `false`. | |
| This is used to add breadcrumbs to Sentry events. By default, this is set to `true`. If you don't want to add breadcrumbs to events being sent to Sentry, set this to `false`: |
coolguyzone
reviewed
Oct 23, 2024
|
|
||
| ### `actionTransformer` (Function) | ||
|
|
||
| This can be used to remove sensitive information from Pinia actions. The first parameter passed to the function is the Pinia action name. We send all actions by default, if you don't want an action name sent to Sentry, use `return null`. |
There was a problem hiding this comment.
Suggested change
| This can be used to remove sensitive information from Pinia actions. The first parameter passed to the function is the Pinia action name. We send all actions by default, if you don't want an action name sent to Sentry, use `return null`. | |
| This can be used to remove sensitive information from Pinia actions. The first parameter passed to the function is the Pinia action name. We send all actions by default, if you don't want an action name sent to Sentry, use `return null`: |
coolguyzone
reviewed
Oct 23, 2024
| description: "Learn about enabling Sentry's Pinia plugin in Nuxt." | ||
| --- | ||
|
|
||
| To capture Pinia state data, add `trackPinia` to your client-side Sentry configuration: |
There was a problem hiding this comment.
Suggested change
| To capture Pinia state data, add `trackPinia` to your client-side Sentry configuration: | |
| To capture [Pinia](https://pinia.vuejs.org/) state data, add `trackPinia` to your client-side Sentry configuration: |
coolguyzone
approved these changes
Oct 23, 2024
s1gr1d
force-pushed
the
sig/pinia-nuxt
branch
from
4be9894 to
7470b55
Compare
s1gr1d
added a commit
that referenced
this pull request
Oct 30, 2024
6 tasks
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DESCRIBE YOUR PR
Documents enabling
trackPiniain Nuxt. PR: getsentry/sentry-javascript#14047Vue docs for Pinia: #11516
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: