Skip to content

Commit 7af162c

Browse files
committed
Update README
1 parent bbe8f28 commit 7af162c

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,35 @@ dependencies {
2828

2929
RxJava 2.1.0+
3030

31+
# API
32+
33+
Start collecting information about RxJava's execution to provide a more meaningful StackTrace in case of crash
34+
<b>Beware:</b> Any crash-reporting handler should be set up <i>before</i> calling this method
35+
```java
36+
void enableRxJava2AssemblyTracking()
37+
```
38+
39+
Start collecting filtered information about RxJava's execution to provide a more meaningful StackTrace in case of crash
40+
<b>Beware:</b> Any crash-reporting handler should be set up <i>before</i> calling this method
41+
42+
```java
43+
void enableRxJava2AssemblyTracking(@Nullable String[] basePackageNames)
44+
```
45+
46+
Disable the collection of more information about RxJava's execution
47+
Information collected before calling this method will still be reported
48+
49+
```java
50+
void disableRxJava2AssemblyTracking()
51+
```
52+
53+
54+
Obtain a copy of the original Throwable with an extended StackTrace
55+
56+
```java
57+
@Nullable Throwable getEnhancedStackTrace(Throwable originalException)
58+
```
59+
3160
# Features
3261

3362
- [StackTrace generation](#stacktrace-generation)

0 commit comments

Comments
 (0)