IErrorBase Interface

Base interface for all errors and warnings emitted the container.

Signature

export interface IErrorBase extends Partial<Error>

Extends: Partial<Error>

Remarks

We are in the process of unifying error types across layers of the Framework. For now we have only migrated those from container-definitions. Once fully migrated, this will be a base interface for all errors and warnings emitted by the Fluid Framework. Currently only the container layer is using IErrorBase. Runtime and others will follow soon.

Properties

Property	Modifiers	Type	Description
errorType	readonly	string	A type tag differentiating kinds of errors emitted by the container.
message	readonly	string	See Error.message
name	optional, readonly	string	See Error.name
stack	optional, readonly	string	See Error.stack

Methods

Method	Modifiers	Return Type	Description
getTelemetryProperties()	optional	ITelemetryBaseProperties	Returns all properties of this error object that are fit for logging. Some may be tagged to indicate they contain some kind of sensitive data.

Property Details

errorType

A type tag differentiating kinds of errors emitted by the container.

Signature

readonly errorType: string;

Type: string

See Also

See FluidErrorTypes#genericError for some common examples. - container - runtime - drivers

message

See Error.message

Signature

readonly message: string;

Type: string

Remarks

Privacy Note - This is a freeform string that we may not control in all cases (e.g. a dependency throws an error) If there are known cases where this contains privacy-sensitive data it will be tagged and included in the result of getTelemetryProperties. When logging, consider fetching it that way rather than straight from this field.

name

See Error.name

Signature

readonly name?: string;

Type: string

stack

See Error.stack

Signature

readonly stack?: string;

Type: string

Method Details

getTelemetryProperties

Returns all properties of this error object that are fit for logging. Some may be tagged to indicate they contain some kind of sensitive data.

Signature

getTelemetryProperties?(): ITelemetryBaseProperties;

Returns

Return type: ITelemetryBaseProperties