Skip to main content

SimpleArrayNodeSchema Interface

A SimpleNodeSchema for an array node.

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 SimpleArrayNodeSchema<out TCustomMetadata = unknown> extends SimpleNodeSchemaBase<NodeKind.Array, TCustomMetadata>

Extends: SimpleNodeSchemaBase<NodeKind.Array, TCustomMetadata>

Type Parameters

Parameter Default Description
TCustomMetadata unknown

Properties

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

Property Details

allowedTypesIdentifiers

The types allowed in the array.

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