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 fluid-framework/alpha.

For more information about our API support guarantees, see here.

Sealed

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<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.

Sealed

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 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.