TreeCompressionStrategy Enum
Selects which heuristics to use when encoding tree content. All encoding options here are compatible with the same decoder: the selection here does not impact compatibility.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here.
Signature
export declare enum TreeCompressionStrategy
Flags
| Flag | Alerts | Description |
|---|---|---|
| Compressed | Alpha | Optimized for encoded size. Use this in production to reduce bandwidth and storage use. |
| CompressedIncremental | Alpha | Optimized for encoded size, same as TreeCompressionStrategy.Compressed but it enables incremental encoding of the data. |
| Uncompressed | Alpha | Optimized for human readability. Use this when debugging or testing and needing to inspect encoded tree content. |
Compressed
Optimized for encoded size. Use this in production to reduce bandwidth and storage use.
For more information about our API support guarantees, see here.
Signature
Compressed = 0
CompressedIncremental
Optimized for encoded size, same as TreeCompressionStrategy.Compressed but it enables incremental encoding of the data.
For more information about our API support guarantees, see here.
Signature
CompressedIncremental = 2
Uncompressed
Optimized for human readability. Use this when debugging or testing and needing to inspect encoded tree content.
For more information about our API support guarantees, see here.
Signature
Uncompressed = 1