SharedTreeOptions Interface
Configuration options for SharedTree with alpha features.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here.
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 SharedTreeOptionsBeta, Partial<CodecWriteOptions>, Partial<SharedTreeFormatOptions>
Extends: SharedTreeOptionsBeta, Partial<CodecWriteOptions>, Partial<SharedTreeFormatOptions>
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. |
| shouldEncodeIncrementally | Alpha | optional | IncrementalEncodingPolicy | Returns whether a node / field should be incrementally encoded. |
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.
For more information about our API support guarantees, see here.
Signature
readonly enableSharedBranches?: boolean;
Type: boolean
shouldEncodeIncrementally
Returns whether a node / field should be incrementally encoded.
For more information about our API support guarantees, see here.
Signature
shouldEncodeIncrementally?: IncrementalEncodingPolicy;
Type: IncrementalEncodingPolicy