BentleyError Class
Base exception class for iTwin.js exceptions.
Extends
- Error
Methods
| Name | Description | |
|---|---|---|
| constructor(errorNumber: number, message?: string, metaData?: LoggingMetaData): BentleyError | ||
| _initName(): string Protected | This function returns the name of each error status. | |
| getMetaData(): undefined | object | get the meta data associated with this BentleyError, if any. | |
| getErrorMessage(error: unknown): string Static | 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 | Use run-time type checking to safely get the metadata with an unknown error value, if possible. | |
| getErrorProps(error: unknown): ErrorProps Static | Returns a new ErrorProps object representing an unknown error value. |
|
| getErrorStack(error: unknown): undefined | string Static | Use run-time type checking to safely get the call stack of an unknown error value, if possible. | |
| getMetaData(metaData: LoggingMetaData): undefined | object Static | get the metadata object associated with an ExceptionMetaData, if any. |
Properties
| Name | Type | Description | |
|---|---|---|---|
| errorNumber | number | The a number that identifies of the problem. | |
| hasMetaData Accessor ReadOnly | boolean | Returns true if this BentleyError includes (optional) metadata. |
Defined in
- core/bentley/src/BentleyError.ts Line 328
Last Updated: 17 December, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.