@genesislcap/foundation-errors 14.302.0 → 14.302.1-alpha-945e484.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (54) hide show
  1. package/dist/dts/banner/error-banner-launcher.d.ts.map +1 -1
  2. package/dist/dts/dialog/error-dialog-launcher.d.ts.map +1 -1
  3. package/dist/dts/error-launcher.d.ts.map +1 -1
  4. package/dist/dts/error-util.d.ts.map +1 -1
  5. package/dist/dts/notification/notification-launcher.d.ts.map +1 -1
  6. package/dist/dts/snackbar/snackbar-launcher.d.ts.map +1 -1
  7. package/dist/dts/tsdoc-metadata.json +1 -1
  8. package/dist/foundation-errors.api.json +230 -141
  9. package/docs/api/foundation-errors.confirmingaction.md +60 -4
  10. package/docs/api/foundation-errors.dismissingaction.md +62 -4
  11. package/docs/api/foundation-errors.errorbanner.md +64 -4
  12. package/docs/api/foundation-errors.errorbannerbuilder.md +59 -5
  13. package/docs/api/foundation-errors.errorbannerbuilder.withconfirmingaction.md +33 -3
  14. package/docs/api/foundation-errors.errorbannerbuilder.withdismissingaction.md +33 -3
  15. package/docs/api/foundation-errors.errorboundaryevent.md +31 -3
  16. package/docs/api/foundation-errors.errorbuilder.md +143 -11
  17. package/docs/api/foundation-errors.errorbuilder.withalert.md +33 -3
  18. package/docs/api/foundation-errors.errorbuilder.withbanner.md +33 -3
  19. package/docs/api/foundation-errors.errorbuilder.withdialog.md +33 -3
  20. package/docs/api/foundation-errors.errorbuilder.witherrordetails.md +33 -3
  21. package/docs/api/foundation-errors.errorbuilder.withloglevel.md +31 -3
  22. package/docs/api/foundation-errors.errorbuilder.withnotification.md +33 -3
  23. package/docs/api/foundation-errors.errorbuilder.withsnackbar.md +33 -3
  24. package/docs/api/foundation-errors.errorbuilder.withtitle.md +33 -3
  25. package/docs/api/foundation-errors.errordialog.md +64 -4
  26. package/docs/api/foundation-errors.errordialogbuilder.md +59 -5
  27. package/docs/api/foundation-errors.errordialogbuilder.withconfirmingaction.md +33 -3
  28. package/docs/api/foundation-errors.errordialogbuilder.withdismissingaction.md +33 -3
  29. package/docs/api/foundation-errors.errornotification.md +106 -6
  30. package/docs/api/foundation-errors.errorstructure.md +102 -6
  31. package/docs/api/foundation-errors.geterrorbanneranchor.md +43 -1
  32. package/docs/api/foundation-errors.geterrorbannerbuilder.md +5 -1
  33. package/docs/api/foundation-errors.geterrorbuilder.md +5 -1
  34. package/docs/api/foundation-errors.geterrorcontainer.md +59 -1
  35. package/docs/api/foundation-errors.geterrordetails.md +44 -1
  36. package/docs/api/foundation-errors.geterrordialogbuilder.md +5 -1
  37. package/docs/api/foundation-errors.getloglevel.md +44 -1
  38. package/docs/api/foundation-errors.getnotificationbuilder.md +5 -1
  39. package/docs/api/foundation-errors.getsnackbarbuilder.md +5 -1
  40. package/docs/api/foundation-errors.md +360 -40
  41. package/docs/api/foundation-errors.notificationbuilder.md +87 -7
  42. package/docs/api/foundation-errors.notificationbuilder.withautoclose.md +33 -3
  43. package/docs/api/foundation-errors.notificationbuilder.withclosetimeout.md +33 -3
  44. package/docs/api/foundation-errors.notificationbuilder.withposition.md +33 -3
  45. package/docs/api/foundation-errors.notificationbuilder.withtype.md +33 -3
  46. package/docs/api/foundation-errors.showbanner.md +73 -1
  47. package/docs/api/foundation-errors.showerror.md +75 -1
  48. package/docs/api/foundation-errors.snackbar.md +64 -4
  49. package/docs/api/foundation-errors.snackbarbuilder.md +59 -5
  50. package/docs/api/foundation-errors.snackbarbuilder.withconfirmingaction.md +33 -3
  51. package/docs/api/foundation-errors.snackbarbuilder.withtype.md +33 -3
  52. package/docs/api/index.md +21 -3
  53. package/docs/api-report.md.api.md +202 -0
  54. package/package.json +11 -11
@@ -14,9 +14,39 @@ withNotification(notification: ErrorNotification): ErrorBuilder;
14
14
 
15
15
  ## Parameters
16
16
 
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | notification | [ErrorNotification](./foundation-errors.errornotification.md) | [ErrorNotification](./foundation-errors.errornotification.md) |
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ notification
36
+
37
+
38
+ </td><td>
39
+
40
+ [ErrorNotification](./foundation-errors.errornotification.md)
41
+
42
+
43
+ </td><td>
44
+
45
+ [ErrorNotification](./foundation-errors.errornotification.md)
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
20
50
 
21
51
  **Returns:**
22
52
 
@@ -14,9 +14,39 @@ withSnackbar(snackbar: Snackbar): ErrorBuilder;
14
14
 
15
15
  ## Parameters
16
16
 
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | snackbar | [Snackbar](./foundation-errors.snackbar.md) | [Snackbar](./foundation-errors.snackbar.md) |
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ snackbar
36
+
37
+
38
+ </td><td>
39
+
40
+ [Snackbar](./foundation-errors.snackbar.md)
41
+
42
+
43
+ </td><td>
44
+
45
+ [Snackbar](./foundation-errors.snackbar.md)
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
20
50
 
21
51
  **Returns:**
22
52
 
@@ -14,9 +14,39 @@ withTitle(title: string): ErrorBuilder;
14
14
 
15
15
  ## Parameters
16
16
 
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | title | string | string |
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ title
36
+
37
+
38
+ </td><td>
39
+
40
+ string
41
+
42
+
43
+ </td><td>
44
+
45
+ string
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
20
50
 
21
51
  **Returns:**
22
52
 
@@ -14,8 +14,68 @@ export interface ErrorDialog
14
14
 
15
15
  ## Properties
16
16
 
17
- | Property | Modifiers | Type | Description |
18
- | --- | --- | --- | --- |
19
- | [confirmingActions?](./foundation-errors.errordialog.confirmingactions.md) | <code>readonly</code> | Array&lt;[ConfirmingAction](./foundation-errors.confirmingaction.md)<!-- -->&gt; | _(Optional)_ |
20
- | [dismissingAction?](./foundation-errors.errordialog.dismissingaction.md) | <code>readonly</code> | [DismissingAction](./foundation-errors.dismissingaction.md) | _(Optional)_ |
17
+ <table><thead><tr><th>
18
+
19
+ Property
20
+
21
+
22
+ </th><th>
23
+
24
+ Modifiers
25
+
26
+
27
+ </th><th>
28
+
29
+ Type
30
+
31
+
32
+ </th><th>
33
+
34
+ Description
35
+
36
+
37
+ </th></tr></thead>
38
+ <tbody><tr><td>
39
+
40
+ [confirmingActions?](./foundation-errors.errordialog.confirmingactions.md)
41
+
42
+
43
+ </td><td>
44
+
45
+ `readonly`
46
+
47
+
48
+ </td><td>
49
+
50
+ Array&lt;[ConfirmingAction](./foundation-errors.confirmingaction.md)<!-- -->&gt;
51
+
52
+
53
+ </td><td>
54
+
55
+ _(Optional)_
56
+
57
+
58
+ </td></tr>
59
+ <tr><td>
60
+
61
+ [dismissingAction?](./foundation-errors.errordialog.dismissingaction.md)
62
+
63
+
64
+ </td><td>
65
+
66
+ `readonly`
67
+
68
+
69
+ </td><td>
70
+
71
+ [DismissingAction](./foundation-errors.dismissingaction.md)
72
+
73
+
74
+ </td><td>
75
+
76
+ _(Optional)_
77
+
78
+
79
+ </td></tr>
80
+ </tbody></table>
21
81
 
@@ -14,9 +14,63 @@ export declare class ErrorDialogBuilder
14
14
 
15
15
  ## Methods
16
16
 
17
- | Method | Modifiers | Description |
18
- | --- | --- | --- |
19
- | [build()](./foundation-errors.errordialogbuilder.build.md) | | Build ErrorDialog |
20
- | [withConfirmingAction(confirmingAction)](./foundation-errors.errordialogbuilder.withconfirmingaction.md) | | Add confirming action to ErrorDialog |
21
- | [withDismissingAction(dismissingAction)](./foundation-errors.errordialogbuilder.withdismissingaction.md) | | Add dismissing action to ErrorDialog |
17
+ <table><thead><tr><th>
18
+
19
+ Method
20
+
21
+
22
+ </th><th>
23
+
24
+ Modifiers
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ [build()](./foundation-errors.errordialogbuilder.build.md)
36
+
37
+
38
+ </td><td>
39
+
40
+
41
+ </td><td>
42
+
43
+ Build ErrorDialog
44
+
45
+
46
+ </td></tr>
47
+ <tr><td>
48
+
49
+ [withConfirmingAction(confirmingAction)](./foundation-errors.errordialogbuilder.withconfirmingaction.md)
50
+
51
+
52
+ </td><td>
53
+
54
+
55
+ </td><td>
56
+
57
+ Add confirming action to ErrorDialog
58
+
59
+
60
+ </td></tr>
61
+ <tr><td>
62
+
63
+ [withDismissingAction(dismissingAction)](./foundation-errors.errordialogbuilder.withdismissingaction.md)
64
+
65
+
66
+ </td><td>
67
+
68
+
69
+ </td><td>
70
+
71
+ Add dismissing action to ErrorDialog
72
+
73
+
74
+ </td></tr>
75
+ </tbody></table>
22
76
 
@@ -14,9 +14,39 @@ withConfirmingAction(confirmingAction: ConfirmingAction): ErrorDialogBuilder;
14
14
 
15
15
  ## Parameters
16
16
 
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | confirmingAction | [ConfirmingAction](./foundation-errors.confirmingaction.md) | [ConfirmingAction](./foundation-errors.confirmingaction.md) |
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ confirmingAction
36
+
37
+
38
+ </td><td>
39
+
40
+ [ConfirmingAction](./foundation-errors.confirmingaction.md)
41
+
42
+
43
+ </td><td>
44
+
45
+ [ConfirmingAction](./foundation-errors.confirmingaction.md)
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
20
50
 
21
51
  **Returns:**
22
52
 
@@ -14,9 +14,39 @@ withDismissingAction(dismissingAction: DismissingAction): ErrorDialogBuilder;
14
14
 
15
15
  ## Parameters
16
16
 
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | dismissingAction | [DismissingAction](./foundation-errors.dismissingaction.md) | [DismissingAction](./foundation-errors.dismissingaction.md) |
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ dismissingAction
36
+
37
+
38
+ </td><td>
39
+
40
+ [DismissingAction](./foundation-errors.dismissingaction.md)
41
+
42
+
43
+ </td><td>
44
+
45
+ [DismissingAction](./foundation-errors.dismissingaction.md)
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
20
50
 
21
51
  **Returns:**
22
52
 
@@ -14,10 +14,110 @@ export interface ErrorNotification
14
14
 
15
15
  ## Properties
16
16
 
17
- | Property | Modifiers | Type | Description |
18
- | --- | --- | --- | --- |
19
- | [autoClose?](./foundation-errors.errornotification.autoclose.md) | <code>readonly</code> | boolean | _(Optional)_ |
20
- | [closeTimeout?](./foundation-errors.errornotification.closetimeout.md) | <code>readonly</code> | number | _(Optional)_ |
21
- | [position?](./foundation-errors.errornotification.position.md) | <code>readonly</code> | [ErrorNotificationPosition](./foundation-errors.errornotificationposition.md) | _(Optional)_ |
22
- | [type?](./foundation-errors.errornotification.type.md) | <code>readonly</code> | [ErrorNotificationType](./foundation-errors.errornotificationtype.md) | _(Optional)_ |
17
+ <table><thead><tr><th>
18
+
19
+ Property
20
+
21
+
22
+ </th><th>
23
+
24
+ Modifiers
25
+
26
+
27
+ </th><th>
28
+
29
+ Type
30
+
31
+
32
+ </th><th>
33
+
34
+ Description
35
+
36
+
37
+ </th></tr></thead>
38
+ <tbody><tr><td>
39
+
40
+ [autoClose?](./foundation-errors.errornotification.autoclose.md)
41
+
42
+
43
+ </td><td>
44
+
45
+ `readonly`
46
+
47
+
48
+ </td><td>
49
+
50
+ boolean
51
+
52
+
53
+ </td><td>
54
+
55
+ _(Optional)_
56
+
57
+
58
+ </td></tr>
59
+ <tr><td>
60
+
61
+ [closeTimeout?](./foundation-errors.errornotification.closetimeout.md)
62
+
63
+
64
+ </td><td>
65
+
66
+ `readonly`
67
+
68
+
69
+ </td><td>
70
+
71
+ number
72
+
73
+
74
+ </td><td>
75
+
76
+ _(Optional)_
77
+
78
+
79
+ </td></tr>
80
+ <tr><td>
81
+
82
+ [position?](./foundation-errors.errornotification.position.md)
83
+
84
+
85
+ </td><td>
86
+
87
+ `readonly`
88
+
89
+
90
+ </td><td>
91
+
92
+ [ErrorNotificationPosition](./foundation-errors.errornotificationposition.md)
93
+
94
+
95
+ </td><td>
96
+
97
+ _(Optional)_
98
+
99
+
100
+ </td></tr>
101
+ <tr><td>
102
+
103
+ [type?](./foundation-errors.errornotification.type.md)
104
+
105
+
106
+ </td><td>
107
+
108
+ `readonly`
109
+
110
+
111
+ </td><td>
112
+
113
+ [ErrorNotificationType](./foundation-errors.errornotificationtype.md)
114
+
115
+
116
+ </td><td>
117
+
118
+ _(Optional)_
119
+
120
+
121
+ </td></tr>
122
+ </tbody></table>
23
123
 
@@ -14,10 +14,106 @@ export interface ErrorStructure
14
14
 
15
15
  ## Properties
16
16
 
17
- | Property | Modifiers | Type | Description |
18
- | --- | --- | --- | --- |
19
- | [config?](./foundation-errors.errorstructure.config.md) | <code>readonly</code> | { readonly logLevel?: LogLevel; readonly alert?: boolean; readonly notification?: [ErrorNotification](./foundation-errors.errornotification.md)<!-- -->; readonly banner?: [ErrorBanner](./foundation-errors.errorbanner.md)<!-- -->; readonly snackbar?: [Snackbar](./foundation-errors.snackbar.md)<!-- -->; readonly dialog?: [ErrorDialog](./foundation-errors.errordialog.md)<!-- -->; } | _(Optional)_ |
20
- | [errorDetails](./foundation-errors.errorstructure.errordetails.md) | <code>readonly</code> | string | |
21
- | [logLevel?](./foundation-errors.errorstructure.loglevel.md) | <code>readonly</code> | LogLevel | _(Optional)_ |
22
- | [title](./foundation-errors.errorstructure.title.md) | <code>readonly</code> | string | |
17
+ <table><thead><tr><th>
18
+
19
+ Property
20
+
21
+
22
+ </th><th>
23
+
24
+ Modifiers
25
+
26
+
27
+ </th><th>
28
+
29
+ Type
30
+
31
+
32
+ </th><th>
33
+
34
+ Description
35
+
36
+
37
+ </th></tr></thead>
38
+ <tbody><tr><td>
39
+
40
+ [config?](./foundation-errors.errorstructure.config.md)
41
+
42
+
43
+ </td><td>
44
+
45
+ `readonly`
46
+
47
+
48
+ </td><td>
49
+
50
+ { readonly logLevel?: LogLevel; readonly alert?: boolean; readonly notification?: [ErrorNotification](./foundation-errors.errornotification.md)<!-- -->; readonly banner?: [ErrorBanner](./foundation-errors.errorbanner.md)<!-- -->; readonly snackbar?: [Snackbar](./foundation-errors.snackbar.md)<!-- -->; readonly dialog?: [ErrorDialog](./foundation-errors.errordialog.md)<!-- -->; }
51
+
52
+
53
+ </td><td>
54
+
55
+ _(Optional)_
56
+
57
+
58
+ </td></tr>
59
+ <tr><td>
60
+
61
+ [errorDetails](./foundation-errors.errorstructure.errordetails.md)
62
+
63
+
64
+ </td><td>
65
+
66
+ `readonly`
67
+
68
+
69
+ </td><td>
70
+
71
+ string
72
+
73
+
74
+ </td><td>
75
+
76
+
77
+ </td></tr>
78
+ <tr><td>
79
+
80
+ [logLevel?](./foundation-errors.errorstructure.loglevel.md)
81
+
82
+
83
+ </td><td>
84
+
85
+ `readonly`
86
+
87
+
88
+ </td><td>
89
+
90
+ LogLevel
91
+
92
+
93
+ </td><td>
94
+
95
+ _(Optional)_
96
+
97
+
98
+ </td></tr>
99
+ <tr><td>
100
+
101
+ [title](./foundation-errors.errorstructure.title.md)
102
+
103
+
104
+ </td><td>
105
+
106
+ `readonly`
107
+
108
+
109
+ </td><td>
110
+
111
+ string
112
+
113
+
114
+ </td><td>
115
+
116
+
117
+ </td></tr>
118
+ </tbody></table>
23
119
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [getErrorBannerAnchor](./foundation-errors.geterrorbanneranchor.md)
4
4
 
5
- ## getErrorBannerAnchor variable
5
+ ## getErrorBannerAnchor() function
6
6
 
7
7
  Get the error banner anchor to attach the banner to
8
8
 
@@ -11,3 +11,45 @@ Get the error banner anchor to attach the banner to
11
11
  ```typescript
12
12
  getErrorBannerAnchor: (element: any) => HTMLElement | null
13
13
  ```
14
+
15
+ ## Parameters
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ element
36
+
37
+
38
+ </td><td>
39
+
40
+ any
41
+
42
+
43
+ </td><td>
44
+
45
+ The element to start searching from
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
50
+
51
+ **Returns:**
52
+
53
+ HTMLElement \| null
54
+
55
+
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [getErrorBannerBuilder](./foundation-errors.geterrorbannerbuilder.md)
4
4
 
5
- ## getErrorBannerBuilder variable
5
+ ## getErrorBannerBuilder() function
6
6
 
7
7
  Get error banner builder instance
8
8
 
@@ -11,3 +11,7 @@ Get error banner builder instance
11
11
  ```typescript
12
12
  getErrorBannerBuilder: () => ErrorBannerBuilder
13
13
  ```
14
+ **Returns:**
15
+
16
+ [ErrorBannerBuilder](./foundation-errors.errorbannerbuilder.md)
17
+
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [getErrorBuilder](./foundation-errors.geterrorbuilder.md)
4
4
 
5
- ## getErrorBuilder variable
5
+ ## getErrorBuilder() function
6
6
 
7
7
  Returns a new ErrorBuilder instance
8
8
 
@@ -11,3 +11,7 @@ Returns a new ErrorBuilder instance
11
11
  ```typescript
12
12
  getErrorBuilder: () => ErrorBuilder
13
13
  ```
14
+ **Returns:**
15
+
16
+ [ErrorBuilder](./foundation-errors.errorbuilder.md)
17
+