Skip to main content

ForestType Enum

Used to distinguish between different forest types.

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 declare enum ForestType

Flags

Flag Alerts Description
Expensive Alpha The "ObjectForest" forest type with expensive asserts for debugging.
Optimized Alpha The "ChunkedForest" forest type.
Reference Alpha The "ObjectForest" forest type.

Expensive

The "ObjectForest" forest type with expensive asserts for debugging.

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

Expensive = 2

Optimized

The "ChunkedForest" forest type.

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

Optimized = 1

Reference

The "ObjectForest" forest type.

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

Reference = 0