SimpleObjectNodeSchema Interface
A SimpleNodeSchema for an object node.
To use, import via @fluidframework/tree/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 SimpleObjectNodeSchema<Type extends SchemaType = SchemaType, out TCustomMetadata = unknown> extends SimpleNodeSchemaBaseAlpha<Type, NodeKind.Object, TCustomMetadata>
Extends: SimpleNodeSchemaBaseAlpha<Type, NodeKind.Object, TCustomMetadata>
Type Parameters
| Parameter | Constraint | Default | Description |
|---|---|---|---|
| Type | SchemaType | SchemaType | |
| TCustomMetadata | unknown |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| allowUnknownOptionalFields | Alpha | readonly | Type extends SchemaType.View ? boolean : undefined | Whether the object node allows unknown optional fields. |
| fields | Alpha | readonly | ReadonlyMap<string, SimpleObjectFieldSchema<Type>> | Schemas for each of the object's fields, keyed off of schema's keys. |
Property Details
allowUnknownOptionalFields
Whether the object node allows unknown optional fields.
For more information about our API support guarantees, see here.
Signature
readonly allowUnknownOptionalFields: Type extends SchemaType.View ? boolean : undefined;
Type: Type extends SchemaType.View ? boolean : undefined
Remarks
Only populated for view schemas, undefined otherwise. Relevant for compatibility checking scenarios.
See Also
allowUnknownOptionalFields for the API where this field is set as part of authoring a schema.
fields
Schemas for each of the object's fields, keyed off of schema's keys.
For more information about our API support guarantees, see here.
Signature
readonly fields: ReadonlyMap<string, SimpleObjectFieldSchema<Type>>;
Type: ReadonlyMap<string, SimpleObjectFieldSchema<Type>>
Remarks
The keys are the property keys if known, otherwise they are the stored keys. Use storedKey to get the stored key.