AnnotatedAllowedType Interface
Stores annotations for 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.
Sealed
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 AnnotatedAllowedType<T = LazyItem<TreeNodeSchema>>
Type Parameters
| Parameter | Default | Description |
|---|---|---|
| T | LazyItem<TreeNodeSchema> |
Remarks
Create using APIs on SchemaStaticsBeta, like staged.
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| metadata | Beta | readonly | AllowedTypeMetadata | Annotations for the allowed type. |
| type | Beta | readonly | T | The allowed type the annotations apply to in a particular schema. |
Property Details
metadata
Annotations for the allowed type.
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 metadata: AllowedTypeMetadata;
Type: AllowedTypeMetadata
type
The allowed type the annotations apply to in a particular schema.
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 type: T;
Type: T