UiError Class
iTwin.js UI UiError class is a subclass of BentleyError. Errors are logged.
Extends
Methods
| Name |
Description |
|
| constructor(category: string, message: string, errorNumber: number = BentleyStatus.ERROR, getMetaData?: GetMetaDataFunction): UiError |
Constructs UiError using BentleyError. |
|
Inherited methods
| Name |
Inherited from |
Description |
| _initName(): string Protected |
BentleyError |
This function returns the name of each error status. |
| getMetaData(): undefined | object |
BentleyError |
get the meta data associated with this BentleyError, if any. |
| getErrorMessage(error: unknown): string Static |
BentleyError |
Use run-time type checking to safely get a useful string summary of an unknown error value, or "" if none exists. |
| getErrorMetadata(error: unknown): undefined | object Static |
BentleyError |
Use run-time type checking to safely get the metadata with an unknown error value, if possible. |
| getErrorProps(error: unknown): ErrorProps Static |
BentleyError |
Returns a new ErrorProps object representing an unknown error value. |
| getErrorStack(error: unknown): undefined | string Static |
BentleyError |
Use run-time type checking to safely get the call stack of an unknown error value, if possible. |
| getMetaData(metaData: LoggingMetaData): undefined | object Static |
BentleyError |
get the metadata object associated with an ExceptionMetaData, if any. |
Properties
| Name |
Type |
Description |
|
| category |
string |
|
|
Inherited properties
| Name |
Type |
Inherited from |
Description |
| errorNumber |
number |
BentleyError |
|
| hasMetaData Accessor ReadOnly |
boolean |
BentleyError |
Returns true if this BentleyError includes (optional) metadata. |
Defined in
Last Updated:
30 November, 2023
