Skip to content

docs(nuxt): Add docs for Pinia plugin #11638

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
s1gr1d merged 2 commits into from
Oct 24, 2024
Merged

docs(nuxt): Add docs for Pinia plugin #11638

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b0a4c6f
docs(nuxt): Add docs for Pinia plugin
s1gr1d Oct 23, 2024
7470b55
review comments
s1gr1d Oct 24, 2024
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
Prev Previous commit
review comments
  • Loading branch information
@s1gr1d
s1gr1d committed Oct 24, 2024
commit 7470b5574a6bd82610064e6a53638fede2900291
10 changes: 5 additions & 5 deletions docs/platforms/javascript/guides/nuxt/features/pinia.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Pinia
description: "Learn about enabling Sentry's Pinia plugin in Nuxt."
---

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:

```javascript {3} {filename:sentry.client.config.ts}
Sentry.init({
Expand Down Expand Up @@ -37,7 +37,7 @@ While we try our best to filter out Personally Identifiable Information (PII) su

### `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`.
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`:

```javascript {2} {filename:sentry.client.config.ts}
trackPinia: {
Expand All @@ -47,7 +47,7 @@ trackPinia: {

### `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`.
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`:

```javascript {2} {filename:sentry.client.config.ts}
trackPinia: {
Expand All @@ -57,7 +57,7 @@ trackPinia: {

### `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`.
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`:

```javascript {2-9} {filename:sentry.client.config.ts}
trackPinia: {
Expand All @@ -74,7 +74,7 @@ trackPinia: {

### `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.
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:

```javascript {2-23} {filename:sentry.client.config.ts}
trackPinia: {
Expand Down