Merge pull request #8169 from getsentry/ryan953/replay-maskFn-docs

ryan953 · web-flow · commit 92847c6549e7 · 2023-05-23T00:27:34.000-07:00
fix(replays): Show the correct Replay config option name `maskFn`
diff --git a/packages/replay/README.md b/packages/replay/README.md
@@ -195,17 +195,17 @@ The following options can be configured as options to the integration, in `new R
 
 The following options can be configured as options to the integration, in `new Replay({})`:
 
-| key              | type                     | default                                 | description                                                                                                                                                                                         |
-| ---------------- | ------------------------ | -----------------------------------     | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| 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 `maskInputFn` before sending to server.                                                                                               |
-| blockAllMedia    | boolean                  | `true`                                  | Block _all_ media elements (`img, svg, video, object, picture, embed, map, audio`)
-| 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 `*`.                                                                                         |
-| block            | Array<string>            | `.sentry-block, [data-sentry-block]`    | Redact any elements that match the DOM selectors. See [privacy](#blocking) section for an example.                                                                                                                                                     |
-| unblock          | Array<string>            | `.sentry-unblock, [data-sentry-unblock]`| Do not redact any elements that match the DOM selectors. Useful when using `blockAllMedia`. See [privacy](#blocking) section for an example.                                                                                                                                                     |
-| mask             | Array<string>            | `.sentry-mask, [data-sentry-mask]`      | Mask all elements that match the given DOM selectors. See [privacy](#masking) section for an example.                                                                                                                                                        |
-| unmask           | Array<string>            | `.sentry-unmask, [data-sentry-unmask]`  | Unmask all elements that match the given DOM selectors. Useful when using `maskAllText`. See [privacy](#masking) section for an example.                                                                                                                                                        |
-| ignore           | Array<string>            | `.sentry-ignore, [data-sentry-ignore]`  | Ignores all events on the matching input fields. See [privacy](#ignoring) section for an example.                                                                                                                                                     |
+| key              | type                     | default                                 | description                                                                                                                                  |
+| ---------------- | ------------------------ | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
+| 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 `maskInputFn` before sending to server.                                       |
+| blockAllMedia    | boolean                  | `true`                                  | Block _all_ media elements (`img, svg, video, object, picture, embed, map, audio`)                                                           |
+| 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 `*`.                                  |
+| block            | Array<string>            | `.sentry-block, [data-sentry-block]`    | Redact any elements that match the DOM selectors. See [privacy](#blocking) section for an example.                                           |
+| unblock          | Array<string>            | `.sentry-unblock, [data-sentry-unblock]`| Do not redact any elements that match the DOM selectors. Useful when using `blockAllMedia`. See [privacy](#blocking) section for an example. |
+| mask             | Array<string>            | `.sentry-mask, [data-sentry-mask]`      | Mask all elements that match the given DOM selectors. See [privacy](#masking) section for an example.                                        |
+| unmask           | Array<string>            | `.sentry-unmask, [data-sentry-unmask]`  | Unmask all elements that match the given DOM selectors. Useful when using `maskAllText`. See [privacy](#masking) section for an example.     |
+| ignore           | Array<string>            | `.sentry-ignore, [data-sentry-ignore]`  | Ignores all events on the matching input fields. See [privacy](#ignoring) section for an example.                                            |
 
 #### Deprecated options
 In order to streamline our privacy options, the following have been deprecated in favor for the respective options above.
diff --git a/packages/replay/src/types.ts b/packages/replay/src/types.ts
@@ -348,7 +348,7 @@ export interface ReplayIntegrationPrivacyOptions {
   /**
    * A callback function to customize how your text is masked.
    */
-  maskFn?: Pick<RecordingOptions, 'maskTextFn'>;
+  maskFn?: (s: string) => string;
 }
 
 // These are optional for ReplayPluginOptions because the plugin sets default values

Original file line number	Diff line number	Diff line change
`@@ -348,7 +348,7 @@ export interface ReplayIntegrationPrivacyOptions {`
`348`	`348`	`/**`
`349`	`349`	`* A callback function to customize how your text is masked.`
`350`	`350`	`*/`
`351`		`- maskFn?: Pick<RecordingOptions, 'maskTextFn'>;`
	`351`	`+ maskFn?: (s: string) => string;`
`352`	`352`	`}`
`353`	`353`
`354`	`354`	`// These are optional for ReplayPluginOptions because the plugin sets default values`