@genesislcap/foundation-errors 14.408.0 → 14.409.0

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

@@ -1,55 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [getErrorBannerAnchor](./foundation-errors.geterrorbanneranchor.md)
-
-## getErrorBannerAnchor() function
-
-Get the error banner anchor to attach the banner to
-
-**Signature:**
-
-```typescript
-getErrorBannerAnchor: (element: any) => HTMLElement | null
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-element
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-The element to start searching from
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-HTMLElement \| null
-
-

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

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [getErrorBannerBuilder](./foundation-errors.geterrorbannerbuilder.md)
-
-## getErrorBannerBuilder() function
-
-Get error banner builder instance
-
-**Signature:**
-
-```typescript
-getErrorBannerBuilder: () => ErrorBannerBuilder
-```
-**Returns:**
-
-[ErrorBannerBuilder](./foundation-errors.errorbannerbuilder.md)
-

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

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [getErrorBuilder](./foundation-errors.geterrorbuilder.md)
-
-## getErrorBuilder() function
-
-Returns a new ErrorBuilder instance
-
-**Signature:**
-
-```typescript
-getErrorBuilder: () => ErrorBuilder
-```
-**Returns:**
-
-[ErrorBuilder](./foundation-errors.errorbuilder.md)
-

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

@@ -1,71 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [getErrorContainer](./foundation-errors.geterrorcontainer.md)
-
-## getErrorContainer() function
-
-Get/Create the error container in the DOM
-
-**Signature:**
-
-```typescript
-getErrorContainer: (id: string, tagName: String) => HTMLElement
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-id
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The id of the container
-
-
-</td></tr>
-<tr><td>
-
-tagName
-
-
-</td><td>
-
-String
-
-
-</td><td>
-
-The tag name to create prefix for the design system provider
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-HTMLElement
-
-

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

@@ -1,56 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [getErrorDetails](./foundation-errors.geterrordetails.md)
-
-## getErrorDetails() function
-
-Retrieves the error details from an ErrorStructure object
-
-**Signature:**
-
-```typescript
-getErrorDetails: (details: ErrorStructure) => string
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-details
-
-
-</td><td>
-
-[ErrorStructure](./foundation-errors.errorstructure.md)
-
-
-</td><td>
-
-The ErrorStructure object
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-string
-
-The title and error details concatenated as a string, or default values ('Error: Something went wrong') if not present
-

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

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [getErrorDialogBuilder](./foundation-errors.geterrordialogbuilder.md)
-
-## getErrorDialogBuilder() function
-
-Returns an instance of ErrorDialogBuilder
-
-**Signature:**
-
-```typescript
-getErrorDialogBuilder: () => ErrorDialogBuilder
-```
-**Returns:**
-
-[ErrorDialogBuilder](./foundation-errors.errordialogbuilder.md)
-

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

@@ -1,56 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [getLoglevel](./foundation-errors.getloglevel.md)
-
-## getLoglevel() function
-
-Retrieves the log level from an ErrorStructure object
-
-**Signature:**
-
-```typescript
-getLoglevel: (details: ErrorStructure) => LogLevel
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-details
-
-
-</td><td>
-
-[ErrorStructure](./foundation-errors.errorstructure.md)
-
-
-</td><td>
-
-The ErrorStructure object
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-LogLevel
-
-The log level or the default value (LogLevel.Error) if not present
-

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

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [getNotificationBuilder](./foundation-errors.getnotificationbuilder.md)
-
-## getNotificationBuilder() function
-
-Get notification builder instance
-
-**Signature:**
-
-```typescript
-getNotificationBuilder: () => NotificationBuilder
-```
-**Returns:**
-
-[NotificationBuilder](./foundation-errors.notificationbuilder.md)
-

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

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [getSnackbarBuilder](./foundation-errors.getsnackbarbuilder.md)
-
-## getSnackbarBuilder() function
-
-Get snackbar builder instance
-
-**Signature:**
-
-```typescript
-getSnackbarBuilder: () => SnackbarBuilder
-```
-**Returns:**
-
-[SnackbarBuilder](./foundation-errors.snackbarbuilder.md)
-

package/docs/api/foundation-errors.md

@@ -1,378 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md)
-
-## foundation-errors package
-
-## Classes
-
-<table><thead><tr><th>
-
-Class
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[ErrorBannerBuilder](./foundation-errors.errorbannerbuilder.md)
-
-
-</td><td>
-
-ErrorBannerBuilder to build ErrorBanner
-
-
-</td></tr>
-<tr><td>
-
-[ErrorBuilder](./foundation-errors.errorbuilder.md)
-
-
-</td><td>
-
-ErrorBuilder to build ErrorStructure
-
-
-</td></tr>
-<tr><td>
-
-[ErrorDialogBuilder](./foundation-errors.errordialogbuilder.md)
-
-
-</td><td>
-
-ErrorDialogBuilder class
-
-
-</td></tr>
-<tr><td>
-
-[NotificationBuilder](./foundation-errors.notificationbuilder.md)
-
-
-</td><td>
-
-NotificationBuilder to build ErrorNotification
-
-
-</td></tr>
-<tr><td>
-
-[SnackbarBuilder](./foundation-errors.snackbarbuilder.md)
-
-
-</td><td>
-
-SnackbarBuilder to build Snackbar
-
-
-</td></tr>
-</tbody></table>
-
-## Enumerations
-
-<table><thead><tr><th>
-
-Enumeration
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[ErrorBoundaryEvent](./foundation-errors.errorboundaryevent.md)
-
-
-</td><td>
-
-enum for different types of error boundary events
-
-
-</td></tr>
-</tbody></table>
-
-## Functions
-
-<table><thead><tr><th>
-
-Function
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[getErrorBannerAnchor(element)](./foundation-errors.geterrorbanneranchor.md)
-
-
-</td><td>
-
-Get the error banner anchor to attach the banner to
-
-
-</td></tr>
-<tr><td>
-
-[getErrorBannerBuilder()](./foundation-errors.geterrorbannerbuilder.md)
-
-
-</td><td>
-
-Get error banner builder instance
-
-
-</td></tr>
-<tr><td>
-
-[getErrorBuilder()](./foundation-errors.geterrorbuilder.md)
-
-
-</td><td>
-
-Returns a new ErrorBuilder instance
-
-
-</td></tr>
-<tr><td>
-
-[getErrorContainer(id, tagName)](./foundation-errors.geterrorcontainer.md)
-
-
-</td><td>
-
-Get/Create the error container in the DOM
-
-
-</td></tr>
-<tr><td>
-
-[getErrorDetails(details)](./foundation-errors.geterrordetails.md)
-
-
-</td><td>
-
-Retrieves the error details from an ErrorStructure object
-
-
-</td></tr>
-<tr><td>
-
-[getErrorDialogBuilder()](./foundation-errors.geterrordialogbuilder.md)
-
-
-</td><td>
-
-Returns an instance of ErrorDialogBuilder
-
-
-</td></tr>
-<tr><td>
-
-[getLoglevel(details)](./foundation-errors.getloglevel.md)
-
-
-</td><td>
-
-Retrieves the log level from an ErrorStructure object
-
-
-</td></tr>
-<tr><td>
-
-[getNotificationBuilder()](./foundation-errors.getnotificationbuilder.md)
-
-
-</td><td>
-
-Get notification builder instance
-
-
-</td></tr>
-<tr><td>
-
-[getSnackbarBuilder()](./foundation-errors.getsnackbarbuilder.md)
-
-
-</td><td>
-
-Get snackbar builder instance
-
-
-</td></tr>
-<tr><td>
-
-[showBanner(error, tagName, errorBoundary)](./foundation-errors.showbanner.md)
-
-
-</td><td>
-
-Shows the error dialog
-
-
-</td></tr>
-<tr><td>
-
-[showError(error, tagName, errorBoundary)](./foundation-errors.showerror.md)
-
-
-</td><td>
-
-Shows the error in the appropriate component
-
-
-</td></tr>
-</tbody></table>
-
-## Interfaces
-
-<table><thead><tr><th>
-
-Interface
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[ConfirmingAction](./foundation-errors.confirmingaction.md)
-
-
-</td><td>
-
-Interface for Confirming Action configuration
-
-
-</td></tr>
-<tr><td>
-
-[DismissingAction](./foundation-errors.dismissingaction.md)
-
-
-</td><td>
-
-Interface for Dismissing Action configuration
-
-
-</td></tr>
-<tr><td>
-
-[ErrorBanner](./foundation-errors.errorbanner.md)
-
-
-</td><td>
-
-Interface for Error Banner configuration
-
-
-</td></tr>
-<tr><td>
-
-[ErrorDialog](./foundation-errors.errordialog.md)
-
-
-</td><td>
-
-Interface for Error Dialog configuration
-
-
-</td></tr>
-<tr><td>
-
-[ErrorNotification](./foundation-errors.errornotification.md)
-
-
-</td><td>
-
-Interface for Error Notification configuration
-
-
-</td></tr>
-<tr><td>
-
-[ErrorStructure](./foundation-errors.errorstructure.md)
-
-
-</td><td>
-
-Interface for Error Structure
-
-
-</td></tr>
-<tr><td>
-
-[Snackbar](./foundation-errors.snackbar.md)
-
-
-</td><td>
-
-Interface for Error Snackbar configuration
-
-
-</td></tr>
-</tbody></table>
-
-## Type Aliases
-
-<table><thead><tr><th>
-
-Type Alias
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[ErrorNotificationPosition](./foundation-errors.errornotificationposition.md)
-
-
-</td><td>
-
-type for error notification position
-
-
-</td></tr>
-<tr><td>
-
-[ErrorNotificationType](./foundation-errors.errornotificationtype.md)
-
-
-</td><td>
-
-type for error notification type
-
-
-</td></tr>
-<tr><td>
-
-[SnackbarType](./foundation-errors.snackbartype.md)
-
-
-</td><td>
-
-type for snackbar type
-
-
-</td></tr>
-</tbody></table>
-