@genesislcap/foundation-errors 9.0.1-alpha-b5c5eb7.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.
- package/README.md +5 -0
- package/dist/1.0.0.remoteEntry.js +1 -0
- package/dist/145.145.25912f2c12344fb25e16.js +2 -0
- package/dist/145.e7ed8da0367f1288ec24cf6472d1f047.js.map +1 -0
- package/dist/191.191.da8a5884febca6f1a439.js +2 -0
- package/dist/191.efd2fea1a42a47cddbf6e6ab15fbf2bb.js.map +1 -0
- package/dist/366.366.82702b77300a9353fc87.js +2 -0
- package/dist/366.a181180b871f72ff9f4ad3e3f3ea3734.js.map +1 -0
- package/dist/755.62d9698f4e62142b980949b517fded3f.js.map +1 -0
- package/dist/755.755.f8db61516204a76477a8.js +2 -0
- package/dist/dashboard.json +1 -0
- package/dist/dts/banner/error-banner-builder.d.ts +10 -0
- package/dist/dts/banner/error-banner-builder.d.ts.map +1 -0
- package/dist/dts/banner/index.d.ts +2 -0
- package/dist/dts/banner/index.d.ts.map +1 -0
- package/dist/dts/dialog/error-dialog-builder.d.ts +10 -0
- package/dist/dts/dialog/error-dialog-builder.d.ts.map +1 -0
- package/dist/dts/dialog/error-dialog-launcher.d.ts +10 -0
- package/dist/dts/dialog/error-dialog-launcher.d.ts.map +1 -0
- package/dist/dts/dialog/index.d.ts +3 -0
- package/dist/dts/dialog/index.d.ts.map +1 -0
- package/dist/dts/error-builder.d.ts +23 -0
- package/dist/dts/error-builder.d.ts.map +1 -0
- package/dist/dts/error-launcher.d.ts +10 -0
- package/dist/dts/error-launcher.d.ts.map +1 -0
- package/dist/dts/error-util.d.ts +25 -0
- package/dist/dts/error-util.d.ts.map +1 -0
- package/dist/dts/index.d.ts +9 -0
- package/dist/dts/index.d.ts.map +1 -0
- package/dist/dts/index.federated.d.ts +1 -0
- package/dist/dts/index.federated.d.ts.map +1 -0
- package/dist/dts/logger.d.ts +2 -0
- package/dist/dts/logger.d.ts.map +1 -0
- package/dist/dts/notification/index.d.ts +3 -0
- package/dist/dts/notification/index.d.ts.map +1 -0
- package/dist/dts/notification/notification-builder.d.ts +12 -0
- package/dist/dts/notification/notification-builder.d.ts.map +1 -0
- package/dist/dts/notification/notification-launcher.d.ts +10 -0
- package/dist/dts/notification/notification-launcher.d.ts.map +1 -0
- package/dist/dts/snackbar/index.d.ts +3 -0
- package/dist/dts/snackbar/index.d.ts.map +1 -0
- package/dist/dts/snackbar/snackbar-builder.d.ts +27 -0
- package/dist/dts/snackbar/snackbar-builder.d.ts.map +1 -0
- package/dist/dts/snackbar/snackbar-launcher.d.ts +10 -0
- package/dist/dts/snackbar/snackbar-launcher.d.ts.map +1 -0
- package/dist/dts/tsdoc-metadata.json +11 -0
- package/dist/dts/types.d.ts +52 -0
- package/dist/dts/types.d.ts.map +1 -0
- package/dist/esm/banner/error-banner-builder.js +25 -0
- package/dist/esm/banner/error-banner-builder.js.map +1 -0
- package/dist/esm/banner/index.js +2 -0
- package/dist/esm/banner/index.js.map +1 -0
- package/dist/esm/dialog/error-dialog-builder.js +25 -0
- package/dist/esm/dialog/error-dialog-builder.js.map +1 -0
- package/dist/esm/dialog/error-dialog-launcher.js +17 -0
- package/dist/esm/dialog/error-dialog-launcher.js.map +1 -0
- package/dist/esm/dialog/index.js +3 -0
- package/dist/esm/dialog/index.js.map +1 -0
- package/dist/esm/error-builder.js +74 -0
- package/dist/esm/error-builder.js.map +1 -0
- package/dist/esm/error-launcher.js +34 -0
- package/dist/esm/error-launcher.js.map +1 -0
- package/dist/esm/error-util.js +43 -0
- package/dist/esm/error-util.js.map +1 -0
- package/dist/esm/index.federated.js +2 -0
- package/dist/esm/index.federated.js.map +1 -0
- package/dist/esm/index.js +9 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/logger.js +3 -0
- package/dist/esm/logger.js.map +1 -0
- package/dist/esm/notification/index.js +3 -0
- package/dist/esm/notification/index.js.map +1 -0
- package/dist/esm/notification/notification-builder.js +29 -0
- package/dist/esm/notification/notification-builder.js.map +1 -0
- package/dist/esm/notification/notification-launcher.js +40 -0
- package/dist/esm/notification/notification-launcher.js.map +1 -0
- package/dist/esm/snackbar/index.js +3 -0
- package/dist/esm/snackbar/index.js.map +1 -0
- package/dist/esm/snackbar/snackbar-builder.js +42 -0
- package/dist/esm/snackbar/snackbar-builder.js.map +1 -0
- package/dist/esm/snackbar/snackbar-launcher.js +16 -0
- package/dist/esm/snackbar/snackbar-launcher.js.map +1 -0
- package/dist/esm/types.js +5 -0
- package/dist/esm/types.js.map +1 -0
- package/dist/favicon.ico +0 -0
- package/dist/foundation-errors.api.json +2483 -0
- package/dist/foundation-errors.d.ts +205 -0
- package/dist/foundation-errors.iife.min.js +1 -0
- package/dist/foundation-errors.js +1240 -0
- package/dist/foundation-errors.min.js +1 -0
- package/dist/foundationErrors.3332a181471a7c01e0521b713cbe35e9.js.map +1 -0
- package/dist/index.ejs +23 -0
- package/dist/index.html +10 -0
- package/dist/info.ejs +13 -0
- package/dist/info.html +14 -0
- package/dist/main.5ba41fdd245152fbed9605c3b9e25cee.js.map +1 -0
- package/dist/main.729daae38fba054a7206.js +2 -0
- package/dist/npm.consola.713.6bcc5abc1500250af5f5.js +2 -0
- package/dist/npm.consola.de429dd64b8dd7d3424e047e422d6ee1.js.map +1 -0
- package/dist/npm.microsoft.127.821cbcff47e0a34e88c9.js +3 -0
- package/dist/npm.microsoft.127.821cbcff47e0a34e88c9.js.LICENSE.txt +14 -0
- package/dist/npm.microsoft.4ae729aafa2e074df718ae9a73d16fa1.js.map +1 -0
- package/dist/remoteEntry.js +2 -0
- package/dist/serve.json +3 -0
- package/docs/api/foundation-errors.confirmingaction.action.md +11 -0
- package/docs/api/foundation-errors.confirmingaction.label.md +11 -0
- package/docs/api/foundation-errors.confirmingaction.md +19 -0
- package/docs/api/foundation-errors.dismissingaction.action.md +11 -0
- package/docs/api/foundation-errors.dismissingaction.label.md +11 -0
- package/docs/api/foundation-errors.dismissingaction.md +19 -0
- package/docs/api/foundation-errors.errorbanner.confirmingactions.md +11 -0
- package/docs/api/foundation-errors.errorbanner.dismissingaction.md +11 -0
- package/docs/api/foundation-errors.errorbanner.md +19 -0
- package/docs/api/foundation-errors.errorbannerbuilder.build.md +15 -0
- package/docs/api/foundation-errors.errorbannerbuilder.md +20 -0
- package/docs/api/foundation-errors.errorbannerbuilder.withconfirmingaction.md +22 -0
- package/docs/api/foundation-errors.errorbannerbuilder.withdismissingaction.md +22 -0
- package/docs/api/foundation-errors.errorboundaryevent.md +18 -0
- package/docs/api/foundation-errors.errorbuilder.build.md +15 -0
- package/docs/api/foundation-errors.errorbuilder.md +26 -0
- package/docs/api/foundation-errors.errorbuilder.withalert.md +22 -0
- package/docs/api/foundation-errors.errorbuilder.withbanner.md +22 -0
- package/docs/api/foundation-errors.errorbuilder.withdialog.md +22 -0
- package/docs/api/foundation-errors.errorbuilder.witherrordetails.md +22 -0
- package/docs/api/foundation-errors.errorbuilder.withloglevel.md +22 -0
- package/docs/api/foundation-errors.errorbuilder.withnotification.md +22 -0
- package/docs/api/foundation-errors.errorbuilder.withsnackbar.md +22 -0
- package/docs/api/foundation-errors.errorbuilder.withtitle.md +22 -0
- package/docs/api/foundation-errors.errordialog.confirmingactions.md +11 -0
- package/docs/api/foundation-errors.errordialog.dismissingaction.md +11 -0
- package/docs/api/foundation-errors.errordialog.md +19 -0
- package/docs/api/foundation-errors.errordialogbuilder.build.md +15 -0
- package/docs/api/foundation-errors.errordialogbuilder.md +20 -0
- package/docs/api/foundation-errors.errordialogbuilder.withconfirmingaction.md +22 -0
- package/docs/api/foundation-errors.errordialogbuilder.withdismissingaction.md +22 -0
- package/docs/api/foundation-errors.errordialogelement.md +15 -0
- package/docs/api/foundation-errors.errorelement.md +15 -0
- package/docs/api/foundation-errors.errornotification.autoclose.md +11 -0
- package/docs/api/foundation-errors.errornotification.closetimeout.md +11 -0
- package/docs/api/foundation-errors.errornotification.md +20 -0
- package/docs/api/foundation-errors.errornotification.type.md +11 -0
- package/docs/api/foundation-errors.errorstructure.config.md +18 -0
- package/docs/api/foundation-errors.errorstructure.errordetails.md +11 -0
- package/docs/api/foundation-errors.errorstructure.loglevel.md +11 -0
- package/docs/api/foundation-errors.errorstructure.md +21 -0
- package/docs/api/foundation-errors.errorstructure.title.md +11 -0
- package/docs/api/foundation-errors.geterrorbannerbuilder.md +11 -0
- package/docs/api/foundation-errors.geterrorbuilder.md +11 -0
- package/docs/api/foundation-errors.geterrorcontainer.md +13 -0
- package/docs/api/foundation-errors.geterrordetails.md +13 -0
- package/docs/api/foundation-errors.geterrordialogbuilder.md +11 -0
- package/docs/api/foundation-errors.getloglevel.md +13 -0
- package/docs/api/foundation-errors.getnotificationbuilder.md +11 -0
- package/docs/api/foundation-errors.getsnackbarbuilder.md +11 -0
- package/docs/api/foundation-errors.md +58 -0
- package/docs/api/foundation-errors.notificationbuilder.build.md +15 -0
- package/docs/api/foundation-errors.notificationbuilder.md +21 -0
- package/docs/api/foundation-errors.notificationbuilder.withautoclose.md +22 -0
- package/docs/api/foundation-errors.notificationbuilder.withclosetimeout.md +22 -0
- package/docs/api/foundation-errors.notificationbuilder.withtype.md +22 -0
- package/docs/api/foundation-errors.showdialog.md +13 -0
- package/docs/api/foundation-errors.showerror.md +13 -0
- package/docs/api/foundation-errors.shownotification.md +13 -0
- package/docs/api/foundation-errors.showsnackbar.md +13 -0
- package/docs/api/foundation-errors.snackbar.confirmingactions.md +11 -0
- package/docs/api/foundation-errors.snackbar.md +19 -0
- package/docs/api/foundation-errors.snackbar.type.md +11 -0
- package/docs/api/foundation-errors.snackbarbuilder.build.md +19 -0
- package/docs/api/foundation-errors.snackbarbuilder.md +20 -0
- package/docs/api/foundation-errors.snackbarbuilder.withconfirmingaction.md +25 -0
- package/docs/api/foundation-errors.snackbarbuilder.withtype.md +25 -0
- package/docs/api/index.md +12 -0
- package/docs/api-report.md +193 -0
- package/jsdom.setup.ts +1 -0
- package/license.txt +46 -0
- package/package.json +101 -0
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [ErrorElement](./foundation-errors.errorelement.md)
|
|
4
|
+
|
|
5
|
+
## ErrorElement type
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
export type ErrorElement = HTMLElement & {
|
|
11
|
+
error: ErrorStructure;
|
|
12
|
+
};
|
|
13
|
+
```
|
|
14
|
+
**References:** [ErrorStructure](./foundation-errors.errorstructure.md)
|
|
15
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [ErrorNotification](./foundation-errors.errornotification.md) > [autoClose](./foundation-errors.errornotification.autoclose.md)
|
|
4
|
+
|
|
5
|
+
## ErrorNotification.autoClose property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly autoClose?: boolean;
|
|
11
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [ErrorNotification](./foundation-errors.errornotification.md) > [closeTimeout](./foundation-errors.errornotification.closetimeout.md)
|
|
4
|
+
|
|
5
|
+
## ErrorNotification.closeTimeout property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly closeTimeout?: number;
|
|
11
|
+
```
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [ErrorNotification](./foundation-errors.errornotification.md)
|
|
4
|
+
|
|
5
|
+
## ErrorNotification interface
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
export interface ErrorNotification
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
| Property | Modifiers | Type | Description |
|
|
16
|
+
| --- | --- | --- | --- |
|
|
17
|
+
| [autoClose?](./foundation-errors.errornotification.autoclose.md) | <code>readonly</code> | boolean | _(Optional)_ |
|
|
18
|
+
| [closeTimeout?](./foundation-errors.errornotification.closetimeout.md) | <code>readonly</code> | number | _(Optional)_ |
|
|
19
|
+
| [type?](./foundation-errors.errornotification.type.md) | <code>readonly</code> | 'warning' \| 'success' \| '' | _(Optional)_ |
|
|
20
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [ErrorNotification](./foundation-errors.errornotification.md) > [type](./foundation-errors.errornotification.type.md)
|
|
4
|
+
|
|
5
|
+
## ErrorNotification.type property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly type?: 'warning' | 'success' | '';
|
|
11
|
+
```
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [ErrorStructure](./foundation-errors.errorstructure.md) > [config](./foundation-errors.errorstructure.config.md)
|
|
4
|
+
|
|
5
|
+
## ErrorStructure.config property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly config?: {
|
|
11
|
+
readonly logLevel?: LogLevel;
|
|
12
|
+
readonly alert?: boolean;
|
|
13
|
+
readonly notification?: ErrorNotification;
|
|
14
|
+
readonly banner?: ErrorBanner;
|
|
15
|
+
readonly snackbar?: Snackbar;
|
|
16
|
+
readonly dialog?: ErrorDialog;
|
|
17
|
+
};
|
|
18
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [ErrorStructure](./foundation-errors.errorstructure.md) > [errorDetails](./foundation-errors.errorstructure.errordetails.md)
|
|
4
|
+
|
|
5
|
+
## ErrorStructure.errorDetails property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly errorDetails: string;
|
|
11
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [ErrorStructure](./foundation-errors.errorstructure.md) > [logLevel](./foundation-errors.errorstructure.loglevel.md)
|
|
4
|
+
|
|
5
|
+
## ErrorStructure.logLevel property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly logLevel?: LogLevel;
|
|
11
|
+
```
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [ErrorStructure](./foundation-errors.errorstructure.md)
|
|
4
|
+
|
|
5
|
+
## ErrorStructure interface
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
export interface ErrorStructure
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
| Property | Modifiers | Type | Description |
|
|
16
|
+
| --- | --- | --- | --- |
|
|
17
|
+
| [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)_ |
|
|
18
|
+
| [errorDetails](./foundation-errors.errorstructure.errordetails.md) | <code>readonly</code> | string | |
|
|
19
|
+
| [logLevel?](./foundation-errors.errorstructure.loglevel.md) | <code>readonly</code> | LogLevel | _(Optional)_ |
|
|
20
|
+
| [title](./foundation-errors.errorstructure.title.md) | <code>readonly</code> | string | |
|
|
21
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [ErrorStructure](./foundation-errors.errorstructure.md) > [title](./foundation-errors.errorstructure.title.md)
|
|
4
|
+
|
|
5
|
+
## ErrorStructure.title property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly title: string;
|
|
11
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [getErrorBannerBuilder](./foundation-errors.geterrorbannerbuilder.md)
|
|
4
|
+
|
|
5
|
+
## getErrorBannerBuilder variable
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
getErrorBannerBuilder: () => ErrorBannerBuilder
|
|
11
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [getErrorBuilder](./foundation-errors.geterrorbuilder.md)
|
|
4
|
+
|
|
5
|
+
## getErrorBuilder variable
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
getErrorBuilder: () => ErrorBuilder
|
|
11
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [getErrorContainer](./foundation-errors.geterrorcontainer.md)
|
|
4
|
+
|
|
5
|
+
## getErrorContainer variable
|
|
6
|
+
|
|
7
|
+
Get/Create the error container in the DOM
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
getErrorContainer: (id: string, tagName: String) => HTMLElement
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [getErrorDetails](./foundation-errors.geterrordetails.md)
|
|
4
|
+
|
|
5
|
+
## getErrorDetails variable
|
|
6
|
+
|
|
7
|
+
Retrieves the error details from an ErrorStructure object
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
getErrorDetails: (details: ErrorStructure) => string
|
|
13
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [getErrorDialogBuilder](./foundation-errors.geterrordialogbuilder.md)
|
|
4
|
+
|
|
5
|
+
## getErrorDialogBuilder variable
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
getErrorDialogBuilder: () => ErrorDialogBuilder
|
|
11
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [getLoglevel](./foundation-errors.getloglevel.md)
|
|
4
|
+
|
|
5
|
+
## getLoglevel variable
|
|
6
|
+
|
|
7
|
+
Retrieves the log level from an ErrorStructure object
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
getLoglevel: (details: ErrorStructure) => LogLevel
|
|
13
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [getNotificationBuilder](./foundation-errors.getnotificationbuilder.md)
|
|
4
|
+
|
|
5
|
+
## getNotificationBuilder variable
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
getNotificationBuilder: () => NotificationBuilder
|
|
11
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [getSnackbarBuilder](./foundation-errors.getsnackbarbuilder.md)
|
|
4
|
+
|
|
5
|
+
## getSnackbarBuilder variable
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
getSnackbarBuilder: () => SnackbarBuilder
|
|
11
|
+
```
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md)
|
|
4
|
+
|
|
5
|
+
## foundation-errors package
|
|
6
|
+
|
|
7
|
+
## Classes
|
|
8
|
+
|
|
9
|
+
| Class | Description |
|
|
10
|
+
| --- | --- |
|
|
11
|
+
| [ErrorBannerBuilder](./foundation-errors.errorbannerbuilder.md) | |
|
|
12
|
+
| [ErrorBuilder](./foundation-errors.errorbuilder.md) | |
|
|
13
|
+
| [ErrorDialogBuilder](./foundation-errors.errordialogbuilder.md) | |
|
|
14
|
+
| [NotificationBuilder](./foundation-errors.notificationbuilder.md) | |
|
|
15
|
+
| [SnackbarBuilder](./foundation-errors.snackbarbuilder.md) | |
|
|
16
|
+
|
|
17
|
+
## Enumerations
|
|
18
|
+
|
|
19
|
+
| Enumeration | Description |
|
|
20
|
+
| --- | --- |
|
|
21
|
+
| [ErrorBoundaryEvent](./foundation-errors.errorboundaryevent.md) | |
|
|
22
|
+
|
|
23
|
+
## Interfaces
|
|
24
|
+
|
|
25
|
+
| Interface | Description |
|
|
26
|
+
| --- | --- |
|
|
27
|
+
| [ConfirmingAction](./foundation-errors.confirmingaction.md) | |
|
|
28
|
+
| [DismissingAction](./foundation-errors.dismissingaction.md) | |
|
|
29
|
+
| [ErrorBanner](./foundation-errors.errorbanner.md) | |
|
|
30
|
+
| [ErrorDialog](./foundation-errors.errordialog.md) | |
|
|
31
|
+
| [ErrorNotification](./foundation-errors.errornotification.md) | |
|
|
32
|
+
| [ErrorStructure](./foundation-errors.errorstructure.md) | |
|
|
33
|
+
| [Snackbar](./foundation-errors.snackbar.md) | |
|
|
34
|
+
|
|
35
|
+
## Variables
|
|
36
|
+
|
|
37
|
+
| Variable | Description |
|
|
38
|
+
| --- | --- |
|
|
39
|
+
| [getErrorBannerBuilder](./foundation-errors.geterrorbannerbuilder.md) | |
|
|
40
|
+
| [getErrorBuilder](./foundation-errors.geterrorbuilder.md) | |
|
|
41
|
+
| [getErrorContainer](./foundation-errors.geterrorcontainer.md) | Get/Create the error container in the DOM |
|
|
42
|
+
| [getErrorDetails](./foundation-errors.geterrordetails.md) | Retrieves the error details from an ErrorStructure object |
|
|
43
|
+
| [getErrorDialogBuilder](./foundation-errors.geterrordialogbuilder.md) | |
|
|
44
|
+
| [getLoglevel](./foundation-errors.getloglevel.md) | Retrieves the log level from an ErrorStructure object |
|
|
45
|
+
| [getNotificationBuilder](./foundation-errors.getnotificationbuilder.md) | |
|
|
46
|
+
| [getSnackbarBuilder](./foundation-errors.getsnackbarbuilder.md) | |
|
|
47
|
+
| [showDialog](./foundation-errors.showdialog.md) | Shows the error dialog |
|
|
48
|
+
| [showError](./foundation-errors.showerror.md) | Shows the error in the appropriate component |
|
|
49
|
+
| [showNotification](./foundation-errors.shownotification.md) | Shows the error notification |
|
|
50
|
+
| [showSnackbar](./foundation-errors.showsnackbar.md) | Shows the snackbar |
|
|
51
|
+
|
|
52
|
+
## Type Aliases
|
|
53
|
+
|
|
54
|
+
| Type Alias | Description |
|
|
55
|
+
| --- | --- |
|
|
56
|
+
| [ErrorDialogElement](./foundation-errors.errordialogelement.md) | |
|
|
57
|
+
| [ErrorElement](./foundation-errors.errorelement.md) | |
|
|
58
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [NotificationBuilder](./foundation-errors.notificationbuilder.md) > [build](./foundation-errors.notificationbuilder.build.md)
|
|
4
|
+
|
|
5
|
+
## NotificationBuilder.build() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
build(): ErrorNotification;
|
|
11
|
+
```
|
|
12
|
+
**Returns:**
|
|
13
|
+
|
|
14
|
+
[ErrorNotification](./foundation-errors.errornotification.md)
|
|
15
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [NotificationBuilder](./foundation-errors.notificationbuilder.md)
|
|
4
|
+
|
|
5
|
+
## NotificationBuilder class
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
export declare class NotificationBuilder
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Methods
|
|
14
|
+
|
|
15
|
+
| Method | Modifiers | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| [build()](./foundation-errors.notificationbuilder.build.md) | | |
|
|
18
|
+
| [withAutoClose(autoClose)](./foundation-errors.notificationbuilder.withautoclose.md) | | |
|
|
19
|
+
| [withCloseTimeout(closeTimeout)](./foundation-errors.notificationbuilder.withclosetimeout.md) | | |
|
|
20
|
+
| [withType(type)](./foundation-errors.notificationbuilder.withtype.md) | | |
|
|
21
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [NotificationBuilder](./foundation-errors.notificationbuilder.md) > [withAutoClose](./foundation-errors.notificationbuilder.withautoclose.md)
|
|
4
|
+
|
|
5
|
+
## NotificationBuilder.withAutoClose() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
withAutoClose(autoClose: boolean): NotificationBuilder;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| autoClose | boolean | |
|
|
18
|
+
|
|
19
|
+
**Returns:**
|
|
20
|
+
|
|
21
|
+
[NotificationBuilder](./foundation-errors.notificationbuilder.md)
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [NotificationBuilder](./foundation-errors.notificationbuilder.md) > [withCloseTimeout](./foundation-errors.notificationbuilder.withclosetimeout.md)
|
|
4
|
+
|
|
5
|
+
## NotificationBuilder.withCloseTimeout() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
withCloseTimeout(closeTimeout: number): NotificationBuilder;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| closeTimeout | number | |
|
|
18
|
+
|
|
19
|
+
**Returns:**
|
|
20
|
+
|
|
21
|
+
[NotificationBuilder](./foundation-errors.notificationbuilder.md)
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [NotificationBuilder](./foundation-errors.notificationbuilder.md) > [withType](./foundation-errors.notificationbuilder.withtype.md)
|
|
4
|
+
|
|
5
|
+
## NotificationBuilder.withType() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
withType(type: 'warning' | 'success' | ''): NotificationBuilder;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| type | 'warning' \| 'success' \| '' | |
|
|
18
|
+
|
|
19
|
+
**Returns:**
|
|
20
|
+
|
|
21
|
+
[NotificationBuilder](./foundation-errors.notificationbuilder.md)
|
|
22
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [showDialog](./foundation-errors.showdialog.md)
|
|
4
|
+
|
|
5
|
+
## showDialog variable
|
|
6
|
+
|
|
7
|
+
Shows the error dialog
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
showDialog: (error: ErrorStructure, tagName: String) => void
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [showError](./foundation-errors.showerror.md)
|
|
4
|
+
|
|
5
|
+
## showError variable
|
|
6
|
+
|
|
7
|
+
Shows the error in the appropriate component
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
showError: (error: ErrorStructure, tagName: String) => void
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [showNotification](./foundation-errors.shownotification.md)
|
|
4
|
+
|
|
5
|
+
## showNotification variable
|
|
6
|
+
|
|
7
|
+
Shows the error notification
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
showNotification: (error: ErrorStructure, tagName: String) => void
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [showSnackbar](./foundation-errors.showsnackbar.md)
|
|
4
|
+
|
|
5
|
+
## showSnackbar variable
|
|
6
|
+
|
|
7
|
+
Shows the snackbar
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
showSnackbar: (error: ErrorStructure, tagName: String) => void
|
|
13
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [Snackbar](./foundation-errors.snackbar.md) > [confirmingActions](./foundation-errors.snackbar.confirmingactions.md)
|
|
4
|
+
|
|
5
|
+
## Snackbar.confirmingActions property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly confirmingActions?: Array<ConfirmingAction>;
|
|
11
|
+
```
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [Snackbar](./foundation-errors.snackbar.md)
|
|
4
|
+
|
|
5
|
+
## Snackbar interface
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
export interface Snackbar
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
| Property | Modifiers | Type | Description |
|
|
16
|
+
| --- | --- | --- | --- |
|
|
17
|
+
| [confirmingActions?](./foundation-errors.snackbar.confirmingactions.md) | <code>readonly</code> | Array<[ConfirmingAction](./foundation-errors.confirmingaction.md)<!-- -->> | _(Optional)_ |
|
|
18
|
+
| [type?](./foundation-errors.snackbar.type.md) | <code>readonly</code> | 'error' \| '' | _(Optional)_ |
|
|
19
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [Snackbar](./foundation-errors.snackbar.md) > [type](./foundation-errors.snackbar.type.md)
|
|
4
|
+
|
|
5
|
+
## Snackbar.type property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly type?: 'error' | '';
|
|
11
|
+
```
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [SnackbarBuilder](./foundation-errors.snackbarbuilder.md) > [build](./foundation-errors.snackbarbuilder.build.md)
|
|
4
|
+
|
|
5
|
+
## SnackbarBuilder.build() method
|
|
6
|
+
|
|
7
|
+
Build snackbar
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
build(): Snackbar;
|
|
13
|
+
```
|
|
14
|
+
**Returns:**
|
|
15
|
+
|
|
16
|
+
[Snackbar](./foundation-errors.snackbar.md)
|
|
17
|
+
|
|
18
|
+
Snackbar
|
|
19
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [SnackbarBuilder](./foundation-errors.snackbarbuilder.md)
|
|
4
|
+
|
|
5
|
+
## SnackbarBuilder class
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
export declare class SnackbarBuilder
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Methods
|
|
14
|
+
|
|
15
|
+
| Method | Modifiers | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| [build()](./foundation-errors.snackbarbuilder.build.md) | | Build snackbar |
|
|
18
|
+
| [withConfirmingAction(confirmingAction)](./foundation-errors.snackbarbuilder.withconfirmingaction.md) | | Add confirming action to snackbar |
|
|
19
|
+
| [withType(type)](./foundation-errors.snackbarbuilder.withtype.md) | | Add type to snackbar |
|
|
20
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [SnackbarBuilder](./foundation-errors.snackbarbuilder.md) > [withConfirmingAction](./foundation-errors.snackbarbuilder.withconfirmingaction.md)
|
|
4
|
+
|
|
5
|
+
## SnackbarBuilder.withConfirmingAction() method
|
|
6
|
+
|
|
7
|
+
Add confirming action to snackbar
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
withConfirmingAction(confirmingAction: ConfirmingAction): SnackbarBuilder;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| confirmingAction | [ConfirmingAction](./foundation-errors.confirmingaction.md) | |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
[SnackbarBuilder](./foundation-errors.snackbarbuilder.md)
|
|
24
|
+
|
|
25
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [SnackbarBuilder](./foundation-errors.snackbarbuilder.md) > [withType](./foundation-errors.snackbarbuilder.withtype.md)
|
|
4
|
+
|
|
5
|
+
## SnackbarBuilder.withType() method
|
|
6
|
+
|
|
7
|
+
Add type to snackbar
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
withType(type: 'error' | ''): SnackbarBuilder;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| type | 'error' \| '' | |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
[SnackbarBuilder](./foundation-errors.snackbarbuilder.md)
|
|
24
|
+
|
|
25
|
+
|