@@ -7,16 +7,16 @@ import type {
77
88export type RecordOptions = CommonOptions & {
99 /**
10- * Specifies where the backend of the app lives. If specified, Highlight will attach the
11- * X-Highlight-Request header to outgoing requests whose destination URLs match a substring
10+ * Specifies where the backend of the app lives. If specified, the SDK will attach the
11+ * traceparent header to outgoing requests whose destination URLs match a substring
1212 * or regexp from this list, so that backend errors can be linked back to the session.
1313 * If 'true' is specified, all requests to the current domain will be matched.
1414 * @example tracingOrigins: ['localhost', /^\//, 'backend.myapp.com']
1515 */
1616 tracingOrigins ?: boolean | ( string | RegExp ) [ ]
1717 /**
18- * If set, Highlight will not record when your app is not visible (in the background).
19- * By default, Highlight will record in the background.
18+ * If set, the SDK will not record when your app is not visible (in the background).
19+ * By default, the SDK will record in the background.
2020 * @default false
2121 */
2222 disableBackgroundRecording ?: boolean
@@ -28,12 +28,12 @@ export type RecordOptions = CommonOptions & {
2828 */
2929 environment ?: 'development' | 'staging' | 'production' | string
3030 /**
31- * Specifies how much data Highlight should redact during recording.
32- * strict - Highlight will redact all text data on the page.
33- * default - Highlight will redact text data on the page that is associated with personal identifiable data .
34- * none - Highlight will not redact any text data on the page.
31+ * Specifies how much data the SDK should redact during recording.
32+ * strict - the SDK will redact all text data, input fields, images and videos on the page.
33+ * default - the SDK will redact text data on the page that resembles PII (based on regex patterns) .
34+ * none - the SDK will not redact any text data on the page.
3535 * // Redacted text will be randomized. Instead of seeing "Hello World" in a recording, you will see "1fds1 j59a0".
36- * @see {@link https://docs.highlight.run /docs/privacy } for more information.
36+ * @see {@link https://launchdarkly.com /docs/sdk/features/session-replay-config# privacy } for more information.
3737 */
3838 privacySetting ?: PrivacySettingOption
3939
@@ -84,8 +84,8 @@ export type RecordOptions = CommonOptions & {
8484 recordCrossOriginIframe ?: boolean
8585 integrations ?: IntegrationOptions
8686 /**
87- * Specifies the keyboard shortcut to open the current session in Highlight .
88- * @see {@link https://docs.highlight.run/ session-shortcut } for more information.
87+ * Specifies the keyboard shortcut to open the current session replay .
88+ * @see {@link https://launchdarkly.com/docs/sdk/features/ session-replay-config#retrieve-session-urls-on-the-client } for more information.
8989 */
9090 sessionShortcut ?: SessionShortcutOptions
9191 /**
0 commit comments