Packages > @fluidframework/driver-definitions > IDriverErrorBase

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
endpointReached optional boolean Whether service was reachable and we got some response from service.
errorType readonly DriverErrorTypes Classification of what type of error this is, used programmatically by consumers to interpret the error.
message readonly 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;

endpointReached

Whether service was reachable and we got some response from service.

Signature

endpointReached?: boolean;

errorType

Classification of what type of error this is, used programmatically by consumers to interpret the error.

Signature

readonly errorType: DriverErrorTypes;

message

Free-form error message

Signature

readonly message: 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;