Skip to main content

ForestOptions Interface

Configuration options for SharedTree's internal tree storage. \

This API is provided as a beta preview and may change without notice.

To use, import via fluid-framework/beta.

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

Input

This type is "input," meaning that code outside of the library defining it should not read from it. Future versions of this type may add optional members or make typing of members more general.

Signature

export interface ForestOptions

Properties

Property Alerts Modifiers Type Description
forest Beta 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 a beta preview and may change without notice.

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

Signature
readonly forest?: ForestType;

Type: ForestType