Skip to main content

SimpleFieldSchema Interface

A simple, shallow representation of a schema for a field.

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​

/** @sealed */
export interface SimpleFieldSchema

Remarks​

This definition is incomplete, and references child types by identifiers. To be useful, this generally needs to be used as a part of a complete SimpleTreeSchema, which contains backing definitions for each referenced identifier.

Properties​

Property Alerts Modifiers Type Description
allowedTypesIdentifiers Alpha readonly ReadonlySet<string> The types allowed under the field.
kind Alpha readonly FieldKind The kind of tree field.
metadata Alpha readonly FieldSchemaMetadata Metadata associated with a FieldSchema.

Property Details​

allowedTypesIdentifiers​

The types allowed under the field.

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 allowedTypesIdentifiers: ReadonlySet<string>;

Type: ReadonlySet<string>

Remarks​

Refers to the types by identifier. A SimpleTreeSchema is needed to resolve these identifiers to their schema definitions.

kind​

The kind of tree field.

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 kind: FieldKind;

Type: FieldKind

metadata​

Metadata associated with a FieldSchema.

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

Type: FieldSchemaMetadata

Remarks​

Specified via metadata.