Skip to main content

SharedTreeOptions Interface

Configuration options for SharedTree. \

This API is provided as an alpha preview and may change without notice.

To use, import via fluid-framework/alpha.

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 SharedTreeOptions extends Partial<CodecWriteOptions>, Partial<SharedTreeFormatOptions>, SharedTreeOptionsBeta

Extends: Partial<CodecWriteOptions>, Partial<SharedTreeFormatOptions>, SharedTreeOptionsBeta

Properties

Property Alerts Modifiers Type Description
enableSharedBranches Alpha optional, readonly boolean Experimental feature flag to enable shared branches. This feature is not yet complete and should not be used in production. Defaults to false.

Property Details

enableSharedBranches

Experimental feature flag to enable shared branches. This feature is not yet complete and should not be used in production. Defaults to false.

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 enableSharedBranches?: boolean;

Type: boolean