IDocumentSchemaFeatures Interface

Packages > @fluidframework/container-runtime > IDocumentSchemaFeatures

Settings that this session would like to have, based on options and feature gates.

WARNING: This type is used to infer IDocumentSchemaCurrent type! Any changes here (including renaming of properties) are potentially changing document format and should be considered carefully!

Signature

export interface IDocumentSchemaFeatures

Properties

Property Details

compressionLz4

Signature

compressionLz4: boolean;

Type: boolean

disallowedVersions

List of disallowed versions of the runtime. This option is sticky. Once a version of runtime is added to this list (when supplied to DocumentsSchemaController’s constructor) it will be added to the list of disallowed versions and stored in document metadata. Each runtime checks if its version is in this list on container open. If it is, it immediately exits with error message indicating to the user that this version is no longer supported. Currently there is no mechanism to remove version from this list. I.e. If it was once added to the list, it gets added to any document metadata (documents that gets open by this runtime) and there is no way to clear it from document’s metadata.

Signature

disallowedVersions: string[];

Type: string[]

explicitSchemaControl

Signature

explicitSchemaControl: boolean;

Type: boolean

idCompressorMode

Signature

idCompressorMode: IdCompressorMode;

Type: IdCompressorMode

opGroupingEnabled

Signature

opGroupingEnabled: boolean;

Type: boolean