Skip to content

Commit d014385

Browse files
Add tsDoc to mobile replay integration
1 parent 8f61ad1 commit d014385

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

src/js/integrations/mobilereplay.ts

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,22 @@ type MobileReplayIntegration = IntegrationFnResult & {
3030
};
3131

3232
/**
33-
* MobileReplay Integration let's you change default options.
33+
* The Mobile Replay Integration, let's you adjust the default mobile replay options.
34+
* To be passed to `Sentry.init` with `replaysOnErrorSampleRate` or `replaysSessionSampleRate`.
35+
*
36+
* ```javascript
37+
* Sentry.init({
38+
* _experiments: {
39+
* replaysOnErrorSampleRate: 1.0,
40+
* replaysSessionSampleRate: 1.0,
41+
* },
42+
* integrations: [mobileReplayIntegration({
43+
* // Adjust the default options
44+
* })],
45+
* });
46+
* ```
47+
*
48+
* @experimental
3449
*/
3550
export const mobileReplayIntegration = (initOptions: MobileReplayOptions = defaultOptions): MobileReplayIntegration => {
3651
if (isExpoGo()) {

0 commit comments

Comments
 (0)