SharedTreeOptions_0_0_2 Interface
Configuration options for a SharedTree with write format 0.0.2
Signature
export interface SharedTreeOptions_0_0_2
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| summarizeHistory | optional |
boolean |
Determines if the history is included in summaries. 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. 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
summarizeHistory
Determines if the history is included in summaries.
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?: boolean;
Type: boolean