ForestType Interface

Used to distinguish between different forest types.

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.

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 ForestType extends ErasedType<"ForestType">

Extends: ErasedType<"ForestType">

Remarks

The "Forest" is the internal data structure used to store all the trees (the main tree and any removed ones) for a given view or branch. ForestTypes should all have the same behavior, but may differ in performance and debuggability.

Current options are ForestTypeReference, ForestTypeOptimized and ForestTypeExpensiveDebug. \