SimpleMapNodeSchema Interface

A SimpleNodeSchema for a map 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 SimpleMapNodeSchema<out TCustomMetadata = unknown> extends SimpleNodeSchemaBase<NodeKind.Map, TCustomMetadata>

Extends: SimpleNodeSchemaBase<NodeKind.Map, TCustomMetadata>

Type Parameters

Parameter	Default	Description
TCustomMetadata	unknown

Properties

Property	Alerts	Modifiers	Type	Description
allowedTypesIdentifiers	Alpha	readonly	ReadonlySet<string>	The types allowed as values in the map.

Property Details

allowedTypesIdentifiers

The types allowed as values in the map.

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 allowedTypesIdentifiers: ReadonlySet<string>;

Type: ReadonlySet<string>

Remarks

Refers to the types by identifier. A SimpleTreeSchema is needed to resolve these identifiers to their schema definitions.