0
# Error Dismissal
1

2
Functions for clearing and dismissing errors from the React Error Overlay interface.
3

4
## Capabilities
5

6
### Dismiss Runtime Errors
7

8
Clears all currently displayed runtime errors from the overlay.
9

10
```javascript { .api }
11
/**
12
 * Dismisses all currently displayed runtime errors from the overlay
13
 * Clears the error list and hides the overlay if no build errors remain
14
 */
15
function dismissRuntimeErrors(): void;
16
```
17

18
**Usage Examples:**
19

20
```javascript
21
import { 
22
  dismissRuntimeErrors, 
23
  reportRuntimeError 
24
} from "react-error-overlay";
25

26
// Report some errors
27
reportRuntimeError(new Error('First error'));
28
reportRuntimeError(new Error('Second error'));
29

30
// Later, clear all runtime errors
31
dismissRuntimeErrors();
32
// Overlay will be hidden if no build errors are present
33
```
34

35
### Dismiss Build Error
36

37
Clears the currently displayed build/compilation error from the overlay.
38

39
```javascript { .api }
40
/**
41
 * Dismisses the currently displayed build error from the overlay
42
 * Clears the build error and hides the overlay if no runtime errors remain
43
 */
44
function dismissBuildError(): void;
45
```
46

47
**Usage Examples:**
48

49
```javascript
50
import { 
51
  dismissBuildError, 
52
  reportBuildError 
53
} from "react-error-overlay";
54

55
// Report a build error
56
reportBuildError(`
57
TypeScript error in /src/App.tsx(10,5):
58
Property 'foo' does not exist on type 'Props'.
59
`);
60

61
// Later, clear the build error (e.g., after fixing the issue)
62
dismissBuildError();
63
// Overlay will be hidden if no runtime errors are present
64
```
65

66
## Combined Error Management
67

68
Both dismissal functions work independently, allowing selective clearing of different error types:
69

70
```javascript
71
import { 
72
  reportBuildError,
73
  reportRuntimeError,
74
  dismissBuildError,
75
  dismissRuntimeErrors
76
} from "react-error-overlay";
77

78
// Report both types of errors
79
reportBuildError('Build failed: Missing semicolon');
80
reportRuntimeError(new Error('Runtime error occurred'));
81

82
// Clear only runtime errors (build error remains)
83
dismissRuntimeErrors();
84

85
// Clear only build error (runtime errors remain)
86
dismissBuildError();
87
```
88

89
## Automatic Dismissal
90

91
Errors are automatically dismissed in certain scenarios:
92

93
- **New Build Errors**: Reporting a new build error automatically dismisses the previous build error
94
- **Overlay Updates**: The overlay automatically hides when no errors remain after dismissal
95
- **Error Deduplication**: Identical errors don't create new overlay entries
96

97
```javascript
98
// Automatic dismissal example
99
reportBuildError('First build error');
100
// Overlay shows first error
101

102
reportBuildError('Second build error');  
103
// First error automatically dismissed, second error shown
104

105
dismissBuildError();
106
// Overlay completely hidden if no runtime errors exist
107
```