Skip to main content

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.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/tree/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.
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.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/tree/alpha.

For more information about our API support guarantees, see here.

Signature

Compressed = 0

Uncompressed

Optimized for human readability. Use this when debugging or testing and needing to inspect encoded tree content.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/tree/alpha.

For more information about our API support guarantees, see here.

Signature

Uncompressed = 1