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.

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 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
kind	Alpha	readonly	FieldKind	The kind of tree field.
metadata	Alpha	readonly	FieldSchemaMetadata	Metadata associated with a FieldSchema.
persistedMetadata	Alpha	optional, readonly	JsonCompatibleReadOnlyObject | undefined	Persisted metadata for this field schema.
simpleAllowedTypes	Alpha	readonly	ReadonlyMap<string, SimpleAllowedTypeAttributes>	Information about the allowed types under this field.

Property Details

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.

persistedMetadata

Persisted metadata for this field 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 persistedMetadata?: JsonCompatibleReadOnlyObject | undefined;

Type: JsonCompatibleReadOnlyObject | undefined

Remarks

Like persistedMetadata but for fields. Set via persistedMetadata.

simpleAllowedTypes

Information about the allowed types under this 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 simpleAllowedTypes: ReadonlyMap<string, SimpleAllowedTypeAttributes>;

Type: ReadonlyMap<string, SimpleAllowedTypeAttributes>

Remarks

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