SharedTreeOptions Interface
Configuration options for SharedTree with alpha features.
To use, import via @fluidframework/tree/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 | Default Value | 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. | |
| retainHistory | Alpha | optional, readonly | false | boolean | When true, prevents trunk commits from being trimmed/evicted, even after they fall outside the collaboration window. |
| shouldEncodeIncrementally | Alpha | optional | IncrementalEncodingPolicy | Returns whether a node / field should be incrementally encoded. | |
| validateCommitsOnFirstSubmission | Alpha | optional, readonly | false | boolean | When This can be enabled (at the cost of performance) to improve safety against document corruption in the event of a bug in the SharedTree code: when the additional validation is enabled, a client will error instead of potentially corrupting the document. |
| validateRebasedCommitsBeforeResubmission | Alpha | optional, readonly | false | boolean | When This can be enabled (at the cost of performance) to improve safety against document corruption in the event of a bug in the SharedTree code: when the additional validation is enabled, a client will error instead of potentially corrupting the document. |
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
retainHistory
When true, prevents trunk commits from being trimmed/evicted, even after they fall outside the collaboration window.
For more information about our API support guarantees, see here.
Signature
readonly retainHistory?: boolean;
Type: boolean
Remarks
By default, SharedTree evicts trunk commits once all peers have acknowledged them (i.e. once they are outside the collaboration window), and they are not otherwise retained (e.g. by revertibles or local branches), to bound memory usage and document size. As long as this flag is enabled, trunk commits are retained - this increases memory usage and document size over time and should be used with care.
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
Remarks
See IncrementalEncodingPolicy.
validateCommitsOnFirstSubmission
When true, validates that commits being submitted for the first time can be applied without errors to a view. In the event that a commit cannot be applied, SharedTree will throw an error and will enter a "broken" state, preventing the offending commit (and any further commits) from being submitted.
This can be enabled (at the cost of performance) to improve safety against document corruption in the event of a bug in the SharedTree code: when the additional validation is enabled, a client will error instead of potentially corrupting the document.
For more information about our API support guarantees, see here.
Signature
readonly validateCommitsOnFirstSubmission?: boolean;
Type: boolean
Remarks
This validation is more expensive than validateRebasedCommitsBeforeResubmission because it is likely to be performed more often. We recommend configuring SharedTree with the optimized forest implementation to reduce its performance impact.
validateRebasedCommitsBeforeResubmission
When true, validates that the commits being resubmitted can be applied without errors to a view. In the event that a commit cannot be applied, SharedTree will throw an error and will enter a "broken" state, preventing the offending commit (and any further commits) from being submitted.
This can be enabled (at the cost of performance) to improve safety against document corruption in the event of a bug in the SharedTree code: when the additional validation is enabled, a client will error instead of potentially corrupting the document.
For more information about our API support guarantees, see here.
Signature
readonly validateRebasedCommitsBeforeResubmission?: boolean;
Type: boolean
Remarks
We recommend configuring SharedTree with the optimized forest implementation to reduce the performance impact of this validation.