Skip to main content

AnnotatedAllowedType Interface

Stores annotations for an individual allowed type.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/tree/alpha.

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

Signature

export interface AnnotatedAllowedType<T extends TreeNodeSchema = TreeNodeSchema>

Type Parameters

Parameter Constraint Default Description
T TreeNodeSchema TreeNodeSchema

Properties

Property Alerts Modifiers Type Description
metadata Alpha readonly AllowedTypeMetadata Annotations for the allowed type.
type Alpha readonly LazyItem<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 an alpha 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 an alpha preview and may change without notice.

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

Signature
readonly type: LazyItem<T>;

Type: LazyItem<T>