SimpleObjectNodeSchema Interface
A SimpleNodeSchema for an object node.
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 SimpleObjectNodeSchema<out TCustomMetadata = unknown> extends SimpleNodeSchemaBase<NodeKind.Object, TCustomMetadata>
Extends: SimpleNodeSchemaBase<NodeKind.Object, TCustomMetadata>
Type Parameters
| Parameter | Default | Description |
|---|---|---|
| TCustomMetadata | unknown |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| fields | Alpha |
readonly |
ReadonlyMap<string, SimpleObjectFieldSchema> | Schemas for each of the object's fields, keyed off of schema's keys. |
Property Details
fields
Schemas for each of the object's fields, keyed off of schema's keys.
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 fields: ReadonlyMap<string, SimpleObjectFieldSchema>;
Type: ReadonlyMap<string, SimpleObjectFieldSchema>
Remarks
The keys are the property keys if known, otherwise they are the stored keys. Use storedKey to get the stored key.