ObjectNodeSchema Interface
A schema for TreeObjectNodes.
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 ObjectNodeSchema<out TName extends string = string, in out T extends RestrictiveStringRecord<ImplicitFieldSchema> = RestrictiveStringRecord<ImplicitFieldSchema>, ImplicitlyConstructable extends boolean = boolean, out TCustomMetadata = unknown> extends TreeNodeSchemaClass<TName, NodeKind.Object, TreeObjectNode<T, TName>, InsertableObjectFromSchemaRecord<T>, ImplicitlyConstructable, T, never, TCustomMetadata>, SimpleObjectNodeSchema<TCustomMetadata>
Extends: TreeNodeSchemaClass<TName, NodeKind.Object, TreeObjectNode<T, TName>, InsertableObjectFromSchemaRecord<T>, ImplicitlyConstructable, T, never, TCustomMetadata>, SimpleObjectNodeSchema<TCustomMetadata>
Type Parameters
| Parameter | Constraint | Default | Description |
|---|---|---|---|
| TName | string | string | |
| T | RestrictiveStringRecord<ImplicitFieldSchema> | RestrictiveStringRecord<ImplicitFieldSchema> | |
| ImplicitlyConstructable | boolean | boolean | |
| TCustomMetadata | unknown |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| fields | Alpha |
readonly |
ReadonlyMap<string, FieldSchemaAlpha & SimpleObjectFieldSchema> | From property keys to the associated schema. |
Property Details
fields
From property keys to the associated 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 fields: ReadonlyMap<string, FieldSchemaAlpha & SimpleObjectFieldSchema>;
Type: ReadonlyMap<string, FieldSchemaAlpha & SimpleObjectFieldSchema>