@genesislcap/foundation-errors 10.3.1 → 11.3.1

package/docs/api/foundation-errors.errorbuilder.withtitle.md

@@ -4,6 +4,8 @@
 
 ## ErrorBuilder.withTitle() method
 
+Add title to error
+
 **Signature:**
 
 ```typescript
@@ -14,9 +16,10 @@ withTitle(title: string): ErrorBuilder;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  title | string |  |
+|  title | string | string |
 
 **Returns:**
 
 [ErrorBuilder](./foundation-errors.errorbuilder.md)
 
+

package/docs/api/foundation-errors.errordialog.md

@@ -4,6 +4,8 @@
 
 ## ErrorDialog interface
 
+Interface for Error Dialog configuration
+
 **Signature:**
 
 ```typescript

package/docs/api/foundation-errors.errordialogbuilder.build.md

@@ -4,6 +4,8 @@
 
 ## ErrorDialogBuilder.build() method
 
+Build ErrorDialog
+
 **Signature:**
 
 ```typescript
@@ -13,3 +15,5 @@ build(): ErrorDialog;
 
 [ErrorDialog](./foundation-errors.errordialog.md)
 
+ErrorDialog
+

package/docs/api/foundation-errors.errordialogbuilder.md

@@ -4,6 +4,8 @@
 
 ## ErrorDialogBuilder class
 
+ErrorDialogBuilder class
+
 **Signature:**
 
 ```typescript
@@ -14,7 +16,7 @@ export declare class ErrorDialogBuilder
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [build()](./foundation-errors.errordialogbuilder.build.md) |  |  |
-|  [withConfirmingAction(confirmingAction)](./foundation-errors.errordialogbuilder.withconfirmingaction.md) |  |  |
-|  [withDismissingAction(dismissingAction)](./foundation-errors.errordialogbuilder.withdismissingaction.md) |  |  |
+|  [build()](./foundation-errors.errordialogbuilder.build.md) |  | Build ErrorDialog |
+|  [withConfirmingAction(confirmingAction)](./foundation-errors.errordialogbuilder.withconfirmingaction.md) |  | Add confirming action to ErrorDialog |
+|  [withDismissingAction(dismissingAction)](./foundation-errors.errordialogbuilder.withdismissingaction.md) |  | Add dismissing action to ErrorDialog |
 

package/docs/api/foundation-errors.errordialogbuilder.withconfirmingaction.md

@@ -4,6 +4,8 @@
 
 ## ErrorDialogBuilder.withConfirmingAction() method
 
+Add confirming action to ErrorDialog
+
 **Signature:**
 
 ```typescript
@@ -14,9 +16,10 @@ withConfirmingAction(confirmingAction: ConfirmingAction): ErrorDialogBuilder;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  confirmingAction | [ConfirmingAction](./foundation-errors.confirmingaction.md) |  |
+|  confirmingAction | [ConfirmingAction](./foundation-errors.confirmingaction.md) | [ConfirmingAction](./foundation-errors.confirmingaction.md) |
 
 **Returns:**
 
 [ErrorDialogBuilder](./foundation-errors.errordialogbuilder.md)
 
+

package/docs/api/foundation-errors.errordialogbuilder.withdismissingaction.md

@@ -4,6 +4,8 @@
 
 ## ErrorDialogBuilder.withDismissingAction() method
 
+Add dismissing action to ErrorDialog
+
 **Signature:**
 
 ```typescript
@@ -14,9 +16,10 @@ withDismissingAction(dismissingAction: DismissingAction): ErrorDialogBuilder;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  dismissingAction | [DismissingAction](./foundation-errors.dismissingaction.md) |  |
+|  dismissingAction | [DismissingAction](./foundation-errors.dismissingaction.md) | [DismissingAction](./foundation-errors.dismissingaction.md) |
 
 **Returns:**
 
 [ErrorDialogBuilder](./foundation-errors.errordialogbuilder.md)
 
+

package/docs/api/foundation-errors.errornotification.md

@@ -4,6 +4,8 @@
 
 ## ErrorNotification interface
 
+Interface for Error Notification configuration
+
 **Signature:**
 
 ```typescript
@@ -16,5 +18,5 @@ export interface ErrorNotification
 |  --- | --- | --- | --- |
 |  [autoClose?](./foundation-errors.errornotification.autoclose.md) | <code>readonly</code> | boolean | _(Optional)_ |
 |  [closeTimeout?](./foundation-errors.errornotification.closetimeout.md) | <code>readonly</code> | number | _(Optional)_ |
-|  [type?](./foundation-errors.errornotification.type.md) | <code>readonly</code> | 'warning' \| 'success' \| '' | _(Optional)_ |
+|  [type?](./foundation-errors.errornotification.type.md) | <code>readonly</code> | [ErrorNotificationType](./foundation-errors.errornotificationtype.md) | _(Optional)_ |
 

package/docs/api/foundation-errors.errornotification.type.md

@@ -7,5 +7,5 @@
 **Signature:**
 
 ```typescript
-readonly type?: 'warning' | 'success' | '';
+readonly type?: ErrorNotificationType;
 ```

package/docs/api/foundation-errors.errornotificationtype.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [ErrorNotificationType](./foundation-errors.errornotificationtype.md)
+
+## ErrorNotificationType type
+
+type for error notification type
+
+**Signature:**
+
+```typescript
+export type ErrorNotificationType = 'warning' | 'success';
+```

package/docs/api/foundation-errors.errorstructure.md

@@ -4,6 +4,8 @@
 
 ## ErrorStructure interface
 
+Interface for Error Structure
+
 **Signature:**
 
 ```typescript

package/docs/api/foundation-errors.geterrorbannerbuilder.md

@@ -4,6 +4,8 @@
 
 ## getErrorBannerBuilder variable
 
+Get error banner builder instance
+
 **Signature:**
 
 ```typescript

package/docs/api/foundation-errors.geterrorbuilder.md

@@ -4,6 +4,8 @@
 
 ## getErrorBuilder variable
 
+Returns a new ErrorBuilder instance
+
 **Signature:**
 
 ```typescript

package/docs/api/foundation-errors.geterrordialogbuilder.md

@@ -4,6 +4,8 @@
 
 ## getErrorDialogBuilder variable
 
+Returns an instance of ErrorDialogBuilder
+
 **Signature:**
 
 ```typescript

package/docs/api/foundation-errors.getnotificationbuilder.md

@@ -4,6 +4,8 @@
 
 ## getNotificationBuilder variable
 
+Get notification builder instance
+
 **Signature:**
 
 ```typescript

package/docs/api/foundation-errors.getsnackbarbuilder.md

@@ -4,6 +4,8 @@
 
 ## getSnackbarBuilder variable
 
+Get snackbar builder instance
+
 **Signature:**
 
 ```typescript

package/docs/api/foundation-errors.md

@@ -8,51 +8,48 @@
 
 |  Class | Description |
 |  --- | --- |
-|  [ErrorBannerBuilder](./foundation-errors.errorbannerbuilder.md) |  |
-|  [ErrorBuilder](./foundation-errors.errorbuilder.md) |  |
-|  [ErrorDialogBuilder](./foundation-errors.errordialogbuilder.md) |  |
-|  [NotificationBuilder](./foundation-errors.notificationbuilder.md) |  |
-|  [SnackbarBuilder](./foundation-errors.snackbarbuilder.md) |  |
+|  [ErrorBannerBuilder](./foundation-errors.errorbannerbuilder.md) | ErrorBannerBuilder to build ErrorBanner |
+|  [ErrorBuilder](./foundation-errors.errorbuilder.md) | ErrorBuilder to build ErrorStructure |
+|  [ErrorDialogBuilder](./foundation-errors.errordialogbuilder.md) | ErrorDialogBuilder class |
+|  [NotificationBuilder](./foundation-errors.notificationbuilder.md) | NotificationBuilder to build ErrorNotification |
+|  [SnackbarBuilder](./foundation-errors.snackbarbuilder.md) | SnackbarBuilder to build Snackbar |
 
 ## Enumerations
 
 |  Enumeration | Description |
 |  --- | --- |
-|  [ErrorBoundaryEvent](./foundation-errors.errorboundaryevent.md) |  |
+|  [ErrorBoundaryEvent](./foundation-errors.errorboundaryevent.md) | enum for different types of error boundary events |
 
 ## Interfaces
 
 |  Interface | Description |
 |  --- | --- |
-|  [ConfirmingAction](./foundation-errors.confirmingaction.md) |  |
-|  [DismissingAction](./foundation-errors.dismissingaction.md) |  |
-|  [ErrorBanner](./foundation-errors.errorbanner.md) |  |
-|  [ErrorDialog](./foundation-errors.errordialog.md) |  |
-|  [ErrorNotification](./foundation-errors.errornotification.md) |  |
-|  [ErrorStructure](./foundation-errors.errorstructure.md) |  |
-|  [Snackbar](./foundation-errors.snackbar.md) |  |
+|  [ConfirmingAction](./foundation-errors.confirmingaction.md) | Interface for Confirming Action configuration |
+|  [DismissingAction](./foundation-errors.dismissingaction.md) | Interface for Dismissing Action configuration |
+|  [ErrorBanner](./foundation-errors.errorbanner.md) | Interface for Error Banner configuration |
+|  [ErrorDialog](./foundation-errors.errordialog.md) | Interface for Error Dialog configuration |
+|  [ErrorNotification](./foundation-errors.errornotification.md) | Interface for Error Notification configuration |
+|  [ErrorStructure](./foundation-errors.errorstructure.md) | Interface for Error Structure |
+|  [Snackbar](./foundation-errors.snackbar.md) | Interface for Error Snackbar configuration |
 
 ## Variables
 
 |  Variable | Description |
 |  --- | --- |
-|  [getErrorBannerBuilder](./foundation-errors.geterrorbannerbuilder.md) |  |
-|  [getErrorBuilder](./foundation-errors.geterrorbuilder.md) |  |
+|  [getErrorBannerBuilder](./foundation-errors.geterrorbannerbuilder.md) | Get error banner builder instance |
+|  [getErrorBuilder](./foundation-errors.geterrorbuilder.md) | Returns a new ErrorBuilder instance |
 |  [getErrorContainer](./foundation-errors.geterrorcontainer.md) | Get/Create the error container in the DOM |
 |  [getErrorDetails](./foundation-errors.geterrordetails.md) | Retrieves the error details from an ErrorStructure object |
-|  [getErrorDialogBuilder](./foundation-errors.geterrordialogbuilder.md) |  |
+|  [getErrorDialogBuilder](./foundation-errors.geterrordialogbuilder.md) | Returns an instance of ErrorDialogBuilder |
 |  [getLoglevel](./foundation-errors.getloglevel.md) | Retrieves the log level from an ErrorStructure object |
-|  [getNotificationBuilder](./foundation-errors.getnotificationbuilder.md) |  |
-|  [getSnackbarBuilder](./foundation-errors.getsnackbarbuilder.md) |  |
-|  [showDialog](./foundation-errors.showdialog.md) | Shows the error dialog |
+|  [getNotificationBuilder](./foundation-errors.getnotificationbuilder.md) | Get notification builder instance |
+|  [getSnackbarBuilder](./foundation-errors.getsnackbarbuilder.md) | Get snackbar builder instance |
 |  [showError](./foundation-errors.showerror.md) | Shows the error in the appropriate component |
-|  [showNotification](./foundation-errors.shownotification.md) | Shows the error notification |
-|  [showSnackbar](./foundation-errors.showsnackbar.md) | Shows the snackbar |
 
 ## Type Aliases
 
 |  Type Alias | Description |
 |  --- | --- |
-|  [ErrorDialogElement](./foundation-errors.errordialogelement.md) |  |
-|  [ErrorElement](./foundation-errors.errorelement.md) |  |
+|  [ErrorNotificationType](./foundation-errors.errornotificationtype.md) | type for error notification type |
+|  [SnackbarType](./foundation-errors.snackbartype.md) | type for snackbar type |
 

package/docs/api/foundation-errors.notificationbuilder.build.md

@@ -4,6 +4,8 @@
 
 ## NotificationBuilder.build() method
 
+Build notification
+
 **Signature:**
 
 ```typescript
@@ -13,3 +15,5 @@ build(): ErrorNotification;
 
 [ErrorNotification](./foundation-errors.errornotification.md)
 
+ErrorNotification
+

package/docs/api/foundation-errors.notificationbuilder.md

@@ -4,6 +4,8 @@
 
 ## NotificationBuilder class
 
+NotificationBuilder to build ErrorNotification
+
 **Signature:**
 
 ```typescript
@@ -14,8 +16,8 @@ export declare class NotificationBuilder
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [build()](./foundation-errors.notificationbuilder.build.md) |  |  |
-|  [withAutoClose(autoClose)](./foundation-errors.notificationbuilder.withautoclose.md) |  |  |
-|  [withCloseTimeout(closeTimeout)](./foundation-errors.notificationbuilder.withclosetimeout.md) |  |  |
-|  [withType(type)](./foundation-errors.notificationbuilder.withtype.md) |  |  |
+|  [build()](./foundation-errors.notificationbuilder.build.md) |  | Build notification |
+|  [withAutoClose(autoClose)](./foundation-errors.notificationbuilder.withautoclose.md) |  | Add auto close to notification |
+|  [withCloseTimeout(closeTimeout)](./foundation-errors.notificationbuilder.withclosetimeout.md) |  | Add close timeout to notification |
+|  [withType(type)](./foundation-errors.notificationbuilder.withtype.md) |  | Add type to notification, if the type is anything other than 'warning' or 'success' do not add it |
 

package/docs/api/foundation-errors.notificationbuilder.withautoclose.md

@@ -4,6 +4,8 @@
 
 ## NotificationBuilder.withAutoClose() method
 
+Add auto close to notification
+
 **Signature:**
 
 ```typescript
@@ -14,9 +16,10 @@ withAutoClose(autoClose: boolean): NotificationBuilder;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  autoClose | boolean |  |
+|  autoClose | boolean | boolean |
 
 **Returns:**
 
 [NotificationBuilder](./foundation-errors.notificationbuilder.md)
 
+

package/docs/api/foundation-errors.notificationbuilder.withclosetimeout.md

@@ -4,6 +4,8 @@
 
 ## NotificationBuilder.withCloseTimeout() method
 
+Add close timeout to notification
+
 **Signature:**
 
 ```typescript
@@ -14,9 +16,10 @@ withCloseTimeout(closeTimeout: number): NotificationBuilder;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  closeTimeout | number |  |
+|  closeTimeout | number | number |
 
 **Returns:**
 
 [NotificationBuilder](./foundation-errors.notificationbuilder.md)
 
+

package/docs/api/foundation-errors.notificationbuilder.withtype.md

@@ -4,19 +4,22 @@
 
 ## NotificationBuilder.withType() method
 
+Add type to notification, if the type is anything other than 'warning' or 'success' do not add it
+
 **Signature:**
 
 ```typescript
-withType(type: 'warning' | 'success' | ''): NotificationBuilder;
+withType(type: ErrorNotificationType): NotificationBuilder;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  type | 'warning' \| 'success' \| '' |  |
+|  type | [ErrorNotificationType](./foundation-errors.errornotificationtype.md) | [ErrorNotificationType](./foundation-errors.errornotificationtype.md) |
 
 **Returns:**
 
 [NotificationBuilder](./foundation-errors.notificationbuilder.md)
 
+

package/docs/api/foundation-errors.snackbar.md

@@ -4,6 +4,8 @@
 
 ## Snackbar interface
 
+Interface for Error Snackbar configuration
+
 **Signature:**
 
 ```typescript
@@ -15,5 +17,5 @@ export interface Snackbar
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [confirmingActions?](./foundation-errors.snackbar.confirmingactions.md) | <code>readonly</code> | Array&lt;[ConfirmingAction](./foundation-errors.confirmingaction.md)<!-- -->&gt; | _(Optional)_ |
-|  [type?](./foundation-errors.snackbar.type.md) | <code>readonly</code> | 'error' \| '' | _(Optional)_ |
+|  [type?](./foundation-errors.snackbar.type.md) | <code>readonly</code> | [SnackbarType](./foundation-errors.snackbartype.md) | _(Optional)_ |
 

package/docs/api/foundation-errors.snackbar.type.md

@@ -7,5 +7,5 @@
 **Signature:**
 
 ```typescript
-readonly type?: 'error' | '';
+readonly type?: SnackbarType;
 ```

package/docs/api/foundation-errors.snackbarbuilder.md

@@ -4,6 +4,8 @@
 
 ## SnackbarBuilder class
 
+SnackbarBuilder to build Snackbar
+
 **Signature:**
 
 ```typescript
@@ -16,5 +18,5 @@ export declare class SnackbarBuilder
 |  --- | --- | --- |
 |  [build()](./foundation-errors.snackbarbuilder.build.md) |  | Build snackbar |
 |  [withConfirmingAction(confirmingAction)](./foundation-errors.snackbarbuilder.withconfirmingaction.md) |  | Add confirming action to snackbar |
-|  [withType(type)](./foundation-errors.snackbarbuilder.withtype.md) |  | Add type to snackbar |
+|  [withType(type)](./foundation-errors.snackbarbuilder.withtype.md) |  | Add type to snackbar, if the type is anything other than 'error' do not add it |
 

package/docs/api/foundation-errors.snackbarbuilder.withconfirmingaction.md

@@ -16,7 +16,7 @@ withConfirmingAction(confirmingAction: ConfirmingAction): SnackbarBuilder;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  confirmingAction | [ConfirmingAction](./foundation-errors.confirmingaction.md) |  |
+|  confirmingAction | [ConfirmingAction](./foundation-errors.confirmingaction.md) | [ConfirmingAction](./foundation-errors.confirmingaction.md) |
 
 **Returns:**
 

package/docs/api/foundation-errors.snackbarbuilder.withtype.md

@@ -4,19 +4,19 @@
 
 ## SnackbarBuilder.withType() method
 
-Add type to snackbar
+Add type to snackbar, if the type is anything other than 'error' do not add it
 
 **Signature:**
 
 ```typescript
-withType(type: 'error' | ''): SnackbarBuilder;
+withType(type: SnackbarType): SnackbarBuilder;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  type | 'error' \| '' |  |
+|  type | [SnackbarType](./foundation-errors.snackbartype.md) | [SnackbarType](./foundation-errors.snackbartype.md) |
 
 **Returns:**
 

package/docs/api/foundation-errors.snackbartype.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [SnackbarType](./foundation-errors.snackbartype.md)
+
+## SnackbarType type
+
+type for snackbar type
+
+**Signature:**
+
+```typescript
+export type SnackbarType = 'error';
+```