ILayerIncompatibilityError Interface

Layer incompatibility error indicating that two Fluid layers are incompatible. For instance, if the Loader layer is not compatible with the Runtime layer, the container will be disposed with this error.

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

To use, import via @fluidframework/core-interfaces/legacy.

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

Signature

export interface ILayerIncompatibilityError extends IErrorBase

Extends: IErrorBase

Properties

Property	Alerts	Modifiers	Type	Description
actualDifferenceInMonths	Beta	readonly	number	The minimum actual difference in months between the release of the two layers. Note that for layers with package versions older than 2.63.0, the actual difference may be higher than this value because the difference reported is capped as per 2.63.0 where the compatibility enforcement was introduced.
compatibilityRequirementsInMonths	Beta	readonly	number	The number of months of compatibility requirements between the two layers as per the layer compatibility policy.
details	Beta	readonly	string	Additional details about the incompatibility to be used for debugging purposes.
errorType	Beta	readonly	typeof FluidErrorTypes.layerIncompatibilityError	A type tag differentiating kinds of errors emitted by the container.
incompatibleLayer	Beta	readonly	string	The layer that is incompatible with the reporting layer.
incompatibleLayerVersion	Beta	readonly	string	The package version of the incompatible layer.
layer	Beta	readonly	string	The layer that is reporting the incompatibility.
layerVersion	Beta	readonly	string	The package version of the reporting layer.

Property Details

actualDifferenceInMonths

The minimum actual difference in months between the release of the two layers. Note that for layers with package versions older than 2.63.0, the actual difference may be higher than this value because the difference reported is capped as per 2.63.0 where the compatibility enforcement was introduced.

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 actualDifferenceInMonths: number;

Type: number

compatibilityRequirementsInMonths

The number of months of compatibility requirements between the two layers as per the layer compatibility policy.

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 compatibilityRequirementsInMonths: number;

Type: number

details

Additional details about the incompatibility to be used for debugging purposes.

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

Type: string

errorType

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

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: typeof FluidErrorTypes.layerIncompatibilityError;

Type: typeof FluidErrorTypes.layerIncompatibilityError

incompatibleLayer

The layer that is incompatible with the reporting layer.

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

Type: string

incompatibleLayerVersion

The package version of the incompatible layer.

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

Type: string

layer

The layer that is reporting the incompatibility.

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

Type: string

layerVersion

The package version of the reporting layer.

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

Type: string