IdCompressorMode TypeAlias

ID Compressor mode. "on" - compressor is On. It's loaded as part of container load. This mode is sticky - once on, compressor is On for all sessions for a given document. This results in IContainerRuntime.idCompressor to be always available. "delayed" - ID compressor bundle is loaded only on establishing of first delta connection, i.e. it does not impact boot of cotnainer. In such mode IContainerRuntime.idCompressor is not made available (unless previous sessions of same document had it "On"). The only thing that is available is IContainerRuntime.generateDocumentUniqueId() that provides opportunistically short IDs. undefined - ID compressor is not loaded. While IContainerRuntime.generateDocumentUniqueId() is available, it will produce long IDs that are do not compress well.

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 type IdCompressorMode = "on" | "delayed" | undefined;