Skip to content

fix(replays): Show the correct Replay config option name maskFn #6988

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 19, 2023
Merged

fix(replays): Show the correct Replay config option name maskFn #6988

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2420523
fix(replays): Show the correct Replay config option name `maskFn`
ryan953 May 19, 2023
c5f1031
style(lint): Auto commit lint changes
getsantry[bot] May 19, 2023
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
6 changes: 3 additions & 3 deletions src/platforms/javascript/common/session-replay/privacy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,12 @@ The following options can be configured as options to the integration, in `new R
| key | type | default | description |
| ------------- | ------------------------ | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| mask | string[] | `.sentry-mask, [data-sentry-mask]` | Mask all elements that match the given DOM selectors. See [Masking](#masking) section for an example. Note that any configured selectors will be in _addition_ to the defaults. |
| maskAllText | boolean | `true` | Mask _all_ text content. Will pass text content through `maskTextFn` before sending to server. |
| maskAllInputs | boolean | `true` | Mask values of `<input>` elements. Passes input values through `maskTextFn` before sending to server. |
| maskAllText | boolean | `true` | Mask _all_ text content. Will pass text content through `maskFn` before sending to server. |
| maskAllInputs | boolean | `true` | Mask values of `<input>` elements. Passes input values through `maskFn` before sending to server. |
| block | string[] | `.sentry-block, [data-sentry-block]` | Redact all elements that match the DOM selector(s). See [Blocking](#blocking) section for an example. Note that any configured selectors will be in _addition_ to the defaults. |
| blockAllMedia | boolean | `true` | Block _all_ media elements (`img`, `svg`, `video`, `object`, `picture`, `embed`, `map`, `audio`). |
| ignore | string[] | `.sentry-ignore, [data-sentry-ignore]` | Ignores all events on the matching input fields. See [Ignoring](#ignoring) above for an example. |
| maskTextFn | (text: string) => string | `(text) => '*'.repeat(text.length)` | Function to customize how text content is masked before sending to server. By default, masks text with `*`. |
| maskFn | (text: string) => string | `(text) => '*'.repeat(text.length)` | Function to customize how text content is masked before sending to server. By default, masks text with `*`. |
| unblock | string[] | `.sentry-unblock, [data-sentry-unblock]` | Don't redact any elements that match the DOM selectors. Used to unblock specific media elements that are blocked with `blockAllMedia`. This doesn't affect sensitive elements such as `password`. |
| unmask | string[] | `.sentry-unmask, [data-sentry-unmask]` | Unmask all elements that match the given DOM selectors. Used to unmask specific elements that are masked with `maskAllText`. |

Expand Down