ObjectNodeSchema Interface
A schema for TreeObjectNodes. \
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 ObjectNodeSchema<out TName extends string = string, in out T extends RestrictiveStringRecord<ImplicitAnnotatedFieldSchema> = RestrictiveStringRecord<ImplicitAnnotatedFieldSchema>, ImplicitlyConstructable extends boolean = boolean, out TCustomMetadata = unknown> extends TreeNodeSchemaClass<TName, NodeKind.Object, TreeObjectNode<UnannotateSchemaRecord<T>, TName>, InsertableObjectFromAnnotatedSchemaRecord<T>, ImplicitlyConstructable, T, never, TCustomMetadata>, SimpleObjectNodeSchema<TCustomMetadata>
Extends: TreeNodeSchemaClass<TName, NodeKind.Object, TreeObjectNode<UnannotateSchemaRecord<T>, TName>, InsertableObjectFromAnnotatedSchemaRecord<T>, ImplicitlyConstructable, T, never, TCustomMetadata>, SimpleObjectNodeSchema<TCustomMetadata>
Type Parameters
| Parameter | Constraint | Default | Description |
|---|---|---|---|
| TName | string | string | |
| T | RestrictiveStringRecord<ImplicitAnnotatedFieldSchema> | RestrictiveStringRecord<ImplicitAnnotatedFieldSchema> | |
| 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.
For more information about our API support guarantees, see here.
Signature
readonly fields: ReadonlyMap<string, FieldSchemaAlpha & SimpleObjectFieldSchema>;
Type: ReadonlyMap<string, FieldSchemaAlpha & SimpleObjectFieldSchema>