Packages > fluid-framework > SchemaIncompatible
SchemaIncompatible Interface
Information about how a view schema was incompatible.
Signature
export interface SchemaIncompatible
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
canUpgrade |
readonly
|
boolean | True iff the view schema supports all possible documents permitted by the stored schema. |
Property Details
canUpgrade
True iff the view schema supports all possible documents permitted by the stored schema.
Signature
readonly canUpgrade: boolean;
Remarks
When true, this is still an error because the view schema supports more documents than the stored schema. This means that writes to the document using the view schema could make the document violate its stored schema. In this case, the stored schema could be updated to match the provided view schema, allowing read write access to the tree.
Future version of SharedTree may provide readonly access to the document in this case because that would be safe: but this is not currently supported.