AllowedTypeMetadata Interface
Annotations that apply to an individual allowed type.
This API is provided as a beta preview and may change without notice.
To use, import via @fluidframework/tree/beta.
For more information about our API support guarantees, see here.
Input
This type is "input," meaning that code outside of the library defining it should not read from it. Future versions of this type may add optional members or make typing of members more general.
Signature
export interface AllowedTypeMetadata
Remarks
Additional optionals may be added to this as non-breaking changes, so implementations of it should be simple object literals with no unlisted members.
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| custom | Beta | optional, readonly | unknown | User defined metadata |
| stagedSchemaUpgrade | Beta | optional, readonly | SchemaUpgrade | If defined, indicates that an allowed type is staged. |
Property Details
custom
User defined metadata
This API is provided as a beta preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
readonly custom?: unknown;
Type: unknown
stagedSchemaUpgrade
If defined, indicates that an allowed type is staged.
This API is provided as a beta preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
readonly stagedSchemaUpgrade?: SchemaUpgrade;
Type: SchemaUpgrade