Type Alias HighlightOptions

HighlightOptions: CommonOptions & {
    consoleMethodsToRecord?: ConsoleMethods[];
    disableBackgroundRecording?: boolean;
    disableConsoleRecording?: boolean;
    disableNetworkRecording?: boolean;
    disableSessionRecording?: boolean;
    enableCanvasRecording?: boolean;
    enablePerformanceRecording?: boolean;
    enablePromisePatch?: boolean;
    enableSegmentIntegration?: boolean;
    environment?: "development" | "staging" | "production" | string;
    inlineImages?: boolean;
    inlineStylesheet?: boolean;
    inlineVideos?: boolean;
    integrations?: IntegrationOptions;
    isCrossOriginIframe?: boolean;
    manualStart?: boolean;
    networkRecording?: boolean | NetworkRecordingOptions;
    otel?: OtelOptions;
    otlpEndpoint?: string;
    privacySetting?: PrivacySettingOption;
    recordCrossOriginIframe?: boolean;
    reportConsoleErrors?: boolean;
    samplingStrategy?: SamplingStrategy;
    sendMode?: "webworker" | "local";
    sessionCookie?: true;
    sessionShortcut?: SessionShortcutOptions;
    storageMode?: "sessionStorage" | "localStorage";
    tracingOrigins?: boolean | (string | RegExp)[];
}

Type declaration

OptionalconsoleMethodsToRecord?: ConsoleMethods[]
Specifies which console methods to record. The value here will be ignored if disabledConsoleRecording is true.
Default
```
All console methods.
```
Example
```
consoleMethodsToRecord: ['log', 'info', 'error']
```
OptionaldisableBackgroundRecording?: boolean
If set, Highlight will not record when your app is not visible (in the background). By default, Highlight will record in the background.
Default
```
false
```
OptionaldisableConsoleRecording?: boolean
Specifies whether Highlight will record console messages.
Default
```
false
```
OptionaldisableNetworkRecording?: boolean
This disables recording network requests. The data includes the URLs, the size of the request, and how long the request took.
Default
```
false
```
Deprecated
Use networkRecording instead.
OptionaldisableSessionRecording?: boolean
Specifies whether Highlight will record user session replays. Unless you are using Highlight only for error monitoring, you do not want to set this to true.
Default
```
false
```
OptionalenableCanvasRecording?: boolean
Specifies whether to record canvas elements or not.
Default
```
false
```
OptionalenablePerformanceRecording?: boolean
Specifies whether to record performance metrics (e.g. FPS, device memory).
Default
```
true
```
OptionalenablePromisePatch?: boolean
Specifies whether window.Promise should be patched to record the stack trace of promise rejections.
Default
```
true
```
OptionalenableSegmentIntegration?: boolean
Optionalenvironment?: "development" | "staging" | "production" | string
Specifies the environment your application is running in. This is useful to distinguish whether your session was recorded on localhost or in production.
Default
```
'production'
```
OptionalinlineImages?: boolean
Specifies whether to inline images into the recording. This means that images that are local to the client (eg. client-generated blob: urls) will be serialized into the recording and will be valid on replay. This will also use canvas snapshotting to inline
Default
```
false
```
OptionalinlineStylesheet?: boolean
Specifies whether to inline stylesheets into the recording. This means that stylesheets that are local to the client (eg. client-generated blob: urls) will be serialized into the recording and will be valid on replay. Only enable this if you are running into issues with client-local stylesheets. May negatively affect performance.
Default
```
true
```
OptionalinlineVideos?: boolean
Specifies whether to inline
Default
```
false
```
Optionalintegrations?: IntegrationOptions
OptionalisCrossOriginIframe?: boolean
Deprecated: this setting is now inferred automatically. Passing this option does nothing.

Deprecated
OptionalmanualStart?: boolean
Specifies if Highlight should not automatically start recording when the app starts. This should be used with H.start() and H.stop() if you want to control when Highlight records.
Default
```
false
```
OptionalnetworkRecording?: boolean | NetworkRecordingOptions
Specifies how and what Highlight records from network requests and responses.
Optionalotel?: OtelOptions
OTLP options for OpenTelemetry tracing. Instrumentations are enabled by default.
OptionalotlpEndpoint?: string
OTLP endpoint for OpenTelemetry tracing.
OptionalprivacySetting?: PrivacySettingOption
Specifies how much data Highlight should redact during recording. strict - Highlight will redact all text data on the page. default - Highlight will redact text data on the page that is associated with personal identifiable data. none - Highlight will not redact any text data on the page. // Redacted text will be randomized. Instead of seeing "Hello World" in a recording, you will see "1fds1 j59a0".

See
https://docs.highlight.run/docs/privacy for more information.
OptionalrecordCrossOriginIframe?: boolean
Enables recording of cross-origin iframes. Should be set in both the parent window and in the cross-origin iframe.
Default
```
false
```
OptionalreportConsoleErrors?: boolean
Specifies whether Highlight will report console.error invocations as Highlight Errors.
Default
```
false
```
OptionalsamplingStrategy?: SamplingStrategy
Configure the recording sampling options, eg. how frequently we record canvas updates.
OptionalsendMode?: "webworker" | "local"
By default, data is serialized and send by the Web Worker. Set to local to force sending from the main js thread. Only use local for custom environments where Web Workers are not available (ie. Figma plugins).
OptionalsessionCookie?: true
By default, session data is stored in the sessionStorage of the browser. Set to true to store session data in a cookie instead. This can help with compliance for cookie-consent regulation.
OptionalsessionShortcut?: SessionShortcutOptions
Specifies the keyboard shortcut to open the current session in Highlight.

See
https://docs.highlight.run/session-shortcut for more information.
OptionalstorageMode?: "sessionStorage" | "localStorage"
Set to sessionStorage to bypass all window.localStorage usage. This can help with compliance for cookie-consent regulation. Using sessionStorage will cause app close+reopens to start a new highlight session, as the session ID will not persist.
OptionaltracingOrigins?: boolean | (string | RegExp)[]
Specifies where the backend of the app lives. If specified, Highlight will attach the X-Highlight-Request header to outgoing requests whose destination URLs match a substring or regexp from this list, so that backend errors can be linked back to the session. If 'true' is specified, all requests to the current domain will be matched.
Example
```
tracingOrigins: ['localhost', /^//, 'backend.myapp.com']
```

Type Alias HighlightOptions

Type declaration

OptionalconsoleMethodsToRecord?: ConsoleMethods[]

Default

Example

OptionaldisableBackgroundRecording?: boolean

Default

OptionaldisableConsoleRecording?: boolean

Default

OptionaldisableNetworkRecording?: boolean

Default

Deprecated

OptionaldisableSessionRecording?: boolean

Default

OptionalenableCanvasRecording?: boolean

Default

OptionalenablePerformanceRecording?: boolean

Default

OptionalenablePromisePatch?: boolean

Default

OptionalenableSegmentIntegration?: boolean

Optionalenvironment?: "development" | "staging" | "production" | string

Default

OptionalinlineImages?: boolean

Default

OptionalinlineStylesheet?: boolean

Default

OptionalinlineVideos?: boolean

Default

Optionalintegrations?: IntegrationOptions

OptionalisCrossOriginIframe?: boolean

Deprecated

OptionalmanualStart?: boolean

Default

OptionalnetworkRecording?: boolean | NetworkRecordingOptions

Optionalotel?: OtelOptions

OptionalotlpEndpoint?: string

OptionalprivacySetting?: PrivacySettingOption

See

OptionalrecordCrossOriginIframe?: boolean

Default

OptionalreportConsoleErrors?: boolean

Default

OptionalsamplingStrategy?: SamplingStrategy

OptionalsendMode?: "webworker" | "local"

OptionalsessionCookie?: true

OptionalsessionShortcut?: SessionShortcutOptions

See

OptionalstorageMode?: "sessionStorage" | "localStorage"

OptionaltracingOrigins?: boolean | (string | RegExp)[]

Example

Settings

`Optional`consoleMethodsToRecord?: ConsoleMethods[]

`Optional`disableBackgroundRecording?: boolean

`Optional`disableConsoleRecording?: boolean

`Optional`disableNetworkRecording?: boolean

`Optional`disableSessionRecording?: boolean

`Optional`enableCanvasRecording?: boolean

`Optional`enablePerformanceRecording?: boolean

`Optional`enablePromisePatch?: boolean

`Optional`enableSegmentIntegration?: boolean

`Optional`environment?: "development" | "staging" | "production" | string

`Optional`inlineImages?: boolean

`Optional`inlineStylesheet?: boolean

`Optional`inlineVideos?: boolean

`Optional`integrations?: IntegrationOptions

`Optional`isCrossOriginIframe?: boolean

`Optional`manualStart?: boolean

`Optional`networkRecording?: boolean | NetworkRecordingOptions

`Optional`otel?: OtelOptions

`Optional`otlpEndpoint?: string

`Optional`privacySetting?: PrivacySettingOption

`Optional`recordCrossOriginIframe?: boolean

`Optional`reportConsoleErrors?: boolean

`Optional`samplingStrategy?: SamplingStrategy

`Optional`sendMode?: "webworker" | "local"

`Optional`sessionCookie?: true

`Optional`sessionShortcut?: SessionShortcutOptions

`Optional`storageMode?: "sessionStorage" | "localStorage"

`Optional`tracingOrigins?: boolean | (string | RegExp)[]