IDriverErrorBase Interface
Base interface for all errors and warnings
Signature
export interface IDriverErrorBase
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| canRetry | boolean | True indicates the caller may retry the failed action. False indicates it's a fatal error | |
| errorType | DriverErrorType | Classification of what type of error this is, used programmatically by consumers to interpret the error | |
| message | string | Free-form error message | |
| online | optional | string | Best guess as to network conditions (online/offline) when the error arose. See OnlineStatus enum in driver-utils package for expected values. |
Property Details
canRetry
True indicates the caller may retry the failed action. False indicates it's a fatal error
Signature
canRetry: boolean;
Type: boolean
errorType
Classification of what type of error this is, used programmatically by consumers to interpret the error
Signature
readonly errorType: DriverErrorType;
Type: DriverErrorType
message
Free-form error message
Signature
readonly message: string;
Type: string
online
Best guess as to network conditions (online/offline) when the error arose. See OnlineStatus enum in driver-utils package for expected values.
Signature
online?: string;
Type: string