Skip to content

Commit

Permalink
🏷️ Add typings for app hang functionality (#2479)
Browse files Browse the repository at this point in the history
Co-authored-by: Manoel Aranda Neto <[email protected]>
  • Loading branch information
sandergo90 and marandaneto authored Sep 22, 2022
1 parent a9273a0 commit 8848f4d
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 6 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

### Fixes

- Add typings for app hang functionality ([#2479](https://github.com/getsentry/sentry-react-native/pull/2479))
- Update warm/cold start span ops ([#2487](https://github.com/getsentry/sentry-react-native/pull/2487))

## 4.4.0
Expand Down
35 changes: 29 additions & 6 deletions src/js/options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ export interface BaseReactNativeOptions {
* When enabled, certain personally identifiable information (PII) is added by active integrations.
*
* @default false
* */
*/
sendDefaultPii?: boolean;

/**
Expand All @@ -73,7 +73,7 @@ export interface BaseReactNativeOptions {
* https://docs.sentry.io/platforms/apple/guides/ios/configuration/out-of-memory/
*
* @default true
* */
*/
enableOutOfMemoryTracking?: boolean;

/**
Expand All @@ -88,16 +88,39 @@ export interface BaseReactNativeOptions {
* Read more at https://docs.sentry.io/platforms/react-native/troubleshooting/#unhandled-promise-rejections
*
* When disabled, this option will not disable unhandled rejection tracking. Set `onunhandledrejection: false` on the `ReactNativeErrorHandlers` integration instead.
*
* @default true
*/
patchGlobalPromise?: boolean;

/**
* The max cache items for capping the number of envelopes.
*
* @default 30
*/
* The max cache items for capping the number of envelopes.
*
* @default 30
*/
maxCacheItems?: number;

/**
* When enabled, the SDK tracks when the application stops responding for a specific amount of
* time defined by the `appHangTimeoutInterval` option.
*
* iOS only
*
* @default true
*/
enableAppHangTracking?: boolean;

/**
* The minimum amount of time an app should be unresponsive to be classified as an App Hanging.
* The actual amount may be a little longer.
* Avoid using values lower than 100ms, which may cause a lot of app hangs events being transmitted.
* Value should be in seconds.
*
* iOS only
*
* @default 2
*/
appHangsTimeoutInterval?: number;
}

/**
Expand Down

0 comments on commit 8848f4d

Please sign in to comment.