ICompressionRuntimeOptions Interface

Options for op compression.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/container-runtime/legacy.

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

Signature

export interface ICompressionRuntimeOptions

Properties

Property	Alerts	Modifiers	Type	Description
compressionAlgorithm	Alpha	readonly	CompressionAlgorithms	The compression algorithm that will be used to compress the op. By default the value is lz4 which is the only compression algorithm currently supported.
minimumBatchSizeInBytes	Alpha	readonly	number	The value the batch's content size must exceed for the batch to be compressed. By default the value is 600 * 1024 = 614400 bytes. If the value is set to Infinity, compression will be disabled.

Property Details

compressionAlgorithm

The compression algorithm that will be used to compress the op. By default the value is lz4 which is the only compression algorithm currently supported.

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

To use, import via @fluidframework/container-runtime/alpha.

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

Signature

readonly compressionAlgorithm: CompressionAlgorithms;

Type: CompressionAlgorithms

minimumBatchSizeInBytes

The value the batch's content size must exceed for the batch to be compressed. By default the value is 600 * 1024 = 614400 bytes. If the value is set to Infinity, compression will be disabled.

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

To use, import via @fluidframework/container-runtime/alpha.

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

Signature

readonly minimumBatchSizeInBytes: number;

Type: number