AnnotatedAllowedTypes Interface

Stores annotations for a set of allowed types. \

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

To use, import via fluid-framework/alpha.

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 AnnotatedAllowedTypes<T = LazyItem<TreeNodeSchema>>

Type Parameters

Parameter	Default	Description
T	LazyItem<TreeNodeSchema>

Properties

Property	Alerts	Modifiers	Type	Description
metadata	Alpha	readonly	AllowedTypesMetadata	Annotations that apply to a set of allowed types.
types	Alpha	readonly	readonly AnnotatedAllowedType<T>[]	All the allowed types that the annotations apply to. The types themselves may also have individual annotations.

Property Details

metadata

Annotations that apply to a set of allowed types.

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: AllowedTypesMetadata;

Type: AllowedTypesMetadata

types

All the allowed types that the annotations apply to. The types themselves may also have individual annotations.

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 types: readonly AnnotatedAllowedType<T>[];

Type: readonly AnnotatedAllowedType<T>[]