SimpleFieldSchema Interface
A simple, shallow representation of a schema for a field.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here.
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 |
|---|---|---|---|---|
| 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.
For more information about our API support guarantees, see here.
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
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.
For more information about our API support guarantees, see here.
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
readonly kind: FieldKind;
Type: FieldKind
metadata
Metadata associated with a FieldSchema.
For more information about our API support guarantees, see here.
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
readonly metadata: FieldSchemaMetadata;
Type: FieldSchemaMetadata
Remarks
Specified via metadata.