Skip to main content

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.

Signature​

export interface AnnotatedAllowedTypes

Properties​

Property Alerts Modifiers Type Description
metadata Alpha readonly AllowedTypesMetadata Annotations that apply to a set of allowed types.
types Alpha readonly readonly (AnnotatedAllowedType | LazyItem<TreeNodeSchema>)[] 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 | LazyItem<TreeNodeSchema>)[];

Type: readonly (AnnotatedAllowedType | LazyItem<TreeNodeSchema>)[]