Bug Capture’s Options object

Learn about the different parameters of the Options object

Options are set by calling window.birdeatsbug.setOptions(options: Partial<SDKOptions>), which takes an object containing a partial of all options as parameter. The snippet on the installation page already contains a call to the function. setOptions needs to be called at least once at page load within the snippet to pass publicAppId, but can be called at any time after with a new subset of options. One call of setOptions can set one or many options. All properties not explicitly set use the previous value, or fall back to the default value.

The Options object

publicAppId

Is the only mandatory option property without default value. Can be generated in the workspace settings. Without a valid publicAppId, uploading sessions is not possible.

instantReplay

Boolean which toggles the instant replay feature on or off. It is false (turned off) by default.

recordVideo

If enabled, the screen is recorded using video instead of a DOM based screen reconstruction. This is helpful in web apps that contain elements that can’t be (correctly) recorded with DOM recording, like Canvas. recordVideo is disabled by default, because:

• Recording video is more resource intensive and results in larger files.
• Not all browsers have the required capability, getDisplayMedia. E.g. mobile browsers currently do not support it. At this time, video recording is also not available on desktop Safari, albeit for other reasons.
• Screen recording using video is interrupted by page navigation. Hence video recording is most suitable for single page applications. When recordVideo is true and a user starts a screen recording using a browser that does not support getDisplayMedia, the SDK falls back to DOM recording, as if recordVideo was not enabled.

user.email

Attaches the email address to the session. If the email input field is not hidden on the preview screen, the user can change this prefilled value before uploading a session.

integrations

Integrations allow SDK to integrate with other popular client-side widgets/tools:

ui

UI options allow to customize the look, displayed copy, and screen flow. See the Customizations page for the default flow.

hooks

Hook functions allow to define custom behavior within specific parts of the SDK lifecycle:

recordedEventTypes

The recordedEventTypes object allows to define, which technical data is recorded by the SDK:

The dom key is a special case:

• When set to false, DOM mutation recording is disabled.
• When an object is passed, it allows to override the rrweb options which SDK passes by default. The passed object must be a Partial. See [DOM recording documentation](/docs/bug-capture/references/dom-recording) for additional details about DOM recording.