SimpleAllowedTypeAttributes Interface
Information about allowed types under a field.
To use, import via @fluidframework/tree/alpha.
For more information about our API support guarantees, see here.
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
Signature
/** @sealed */
export interface SimpleAllowedTypeAttributes<out Type extends SchemaType = SchemaType>
Type Parameters
| Parameter | Constraint | Default | Description |
|---|---|---|---|
| Type | SchemaType | SchemaType |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| isStaged | Alpha | readonly | Type extends SchemaType.Stored ? undefined : false | SchemaUpgrade | SchemaUpgrade if this schema is included as a staged schema upgrade, allowing the view schema be compatible with stored schema with (post upgrade) or without it (pre-upgrade). New documents and schema upgrades will omit any staged schema. Undefined if derived from a stored schema. |
Property Details
isStaged
SchemaUpgrade if this schema is included as a staged schema upgrade, allowing the view schema be compatible with stored schema with (post upgrade) or without it (pre-upgrade). New documents and schema upgrades will omit any staged schema.
Undefined if derived from a stored schema.
For more information about our API support guarantees, see here.
Signature
readonly isStaged: Type extends SchemaType.Stored ? undefined : false | SchemaUpgrade;
Type: Type extends SchemaType.Stored ? undefined : false | SchemaUpgrade