IAnyDriverError Interface

Interface describing errors and warnings raised by any driver code.

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 IAnyDriverError extends Omit<IDriverErrorBase, "errorType">

Extends: Omit<IDriverErrorBase, "errorType">

Remarks

Not expected to be implemented by a class or an object literal, but rather used in place of any or unknown in various function signatures that pass errors around.

"Any" in the interface name is a nod to the fact that errorType has lost its type constraint. It will be either DriverErrorTypes or the specific driver's specialized error type enum, but we can't reference a specific driver's error type enum in this code.

Properties

Property	Alerts	Modifiers	Type	Description
errorType	Beta	readonly	string
scenarioName	Beta	optional	string	This property is used predominantly for socket io errors. It captures the underlying socket event name which resulted in the error. i.e. connect_error, connect_document_error etc.

Property Details

errorType

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: string;

Type: string

scenarioName

This property is used predominantly for socket io errors. It captures the underlying socket event name which resulted in the error. i.e. connect_error, connect_document_error etc.

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

scenarioName?: string;

Type: string