SharedTreeFormatOptions Interface
Options for configuring the persisted format SharedTree uses.
To use, import via @fluidframework/tree/alpha.
For more information about our API support guarantees, see here.
Signature
export interface SharedTreeFormatOptions
Properties
| Property | Alerts | Type | Description |
|---|---|---|---|
| formatVersion | Alpha |
SharedTreeFormatVersion[keyof SharedTreeFormatVersion] |
The format version SharedTree should use to persist documents. This option has compatibility implications for applications using SharedTree. Each version documents a required minimum version of \@fluidframework/tree. If this minimum version fails to be met, the SharedTree may fail to load. To be safe, application authors should verify that they have saturated this version of \@fluidframework/tree in their ecosystem before changing the format version. This option defaults to SharedTreeFormatVersion.v2. |
| treeEncodeType | Alpha |
TreeCompressionStrategy | See TreeCompressionStrategy. default: TreeCompressionStrategy.Compressed |
Property Details
formatVersion
The format version SharedTree should use to persist documents.
This option has compatibility implications for applications using SharedTree. Each version documents a required minimum version of @fluidframework/tree. If this minimum version fails to be met, the SharedTree may fail to load. To be safe, application authors should verify that they have saturated this version of @fluidframework/tree in their ecosystem before changing the format version.
This option defaults to SharedTreeFormatVersion.v2.
To use, import via @fluidframework/tree/alpha.
For more information about our API support guarantees, see here.
Signature
formatVersion: SharedTreeFormatVersion[keyof SharedTreeFormatVersion];
Type: SharedTreeFormatVersion[keyof SharedTreeFormatVersion]
treeEncodeType
See TreeCompressionStrategy. default: TreeCompressionStrategy.Compressed
To use, import via @fluidframework/tree/alpha.
For more information about our API support guarantees, see here.
Signature
treeEncodeType: TreeCompressionStrategy;
Type: TreeCompressionStrategy