IDriverErrorBase Interface

Base interface for all errors and warnings

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/driver-definitions/legacy.

For more information about our API support guarantees, see here.

Signature

export interface IDriverErrorBase

Properties

Property	Alerts	Modifiers	Type	Description
canRetry	Beta		boolean	True indicates the caller may retry the failed action. False indicates it's a fatal error
endpointReached	Beta	optional	boolean	Whether service was reachable and we got some response from service.
errorType	Beta	readonly	DriverErrorTypes	Classification of what type of error this is, used programmatically by consumers to interpret the error.
message	Beta	readonly	string	Free-form error message
online	Beta	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

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

canRetry: boolean;

Type: boolean

endpointReached

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

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

endpointReached?: boolean;

Type: boolean

errorType

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

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly errorType: DriverErrorTypes;

Type: DriverErrorTypes

message

Free-form error message

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

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.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

online?: string;

Type: string