Skip to main content
Version: v1

SharedTreeOptions_0_1_1 Interface

Configuration options for a SharedTree with write format 0.1.1

Signature​

export interface SharedTreeOptions_0_1_1

Properties​

Property Modifiers Type Description
attributionId optional AttributionId a UUID that identifies the user of this tree; all node IDs generated by this tree will be associated with this UUID
summarizeHistory optional false | { uploadEditChunks: boolean; }

Determines if the history is included in summaries and if edit chunks are uploaded when they are full.

Warning: enabling history summarization incurs a permanent cost in the document. It is not possible to disable history summarization later once it has been enabled, and thus the history cannot be safely deleted.

On 0.1.1 documents, due to current code limitations, this parameter is only impactful for newly created documents. SharedTrees which load existing documents will summarize history if and only if the loaded summary included history.

The technical limitations here relate to clients with mixed versions collaborating. In the future we may allow modification of whether or not a particular document saves history, but only via a consensus mechanism. See the skipped test in SharedTreeFuzzTests.ts for more details on this issue. See docs/Breaking-Change-Migration for more details on the consensus scheme.

Property Details​

attributionId​

a UUID that identifies the user of this tree; all node IDs generated by this tree will be associated with this UUID

Signature​

attributionId?: AttributionId;

Type: AttributionId

summarizeHistory​

Determines if the history is included in summaries and if edit chunks are uploaded when they are full.

Warning: enabling history summarization incurs a permanent cost in the document. It is not possible to disable history summarization later once it has been enabled, and thus the history cannot be safely deleted.

On 0.1.1 documents, due to current code limitations, this parameter is only impactful for newly created documents. SharedTrees which load existing documents will summarize history if and only if the loaded summary included history.

The technical limitations here relate to clients with mixed versions collaborating. In the future we may allow modification of whether or not a particular document saves history, but only via a consensus mechanism. See the skipped test in SharedTreeFuzzTests.ts for more details on this issue. See docs/Breaking-Change-Migration for more details on the consensus scheme.

Signature​

summarizeHistory?: false | {
        uploadEditChunks: boolean;
    };

Type: false | { uploadEditChunks: boolean; }