Skip to main content

ForestOptions Interface

Configuration options for SharedTree's internal tree storage.

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

export interface ForestOptions

Properties

Property Alerts Modifiers Type Description
forest Alpha optional, readonly ForestType The ForestType indicating which forest type should be created for the SharedTree.

Property Details

forest

The ForestType indicating which forest type should be created for the SharedTree.

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

readonly forest?: ForestType;

Type: ForestType