IDocumentSchemaFeatures Interface

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!

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 IDocumentSchemaFeatures

Properties

Property	Alerts	Type	Description
compressionLz4	Alpha	boolean
disallowedVersions	Alpha	string[]	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.
explicitSchemaControl	Alpha	boolean
idCompressorMode	Alpha	IdCompressorMode
opGroupingEnabled	Alpha	boolean

Property Details

compressionLz4

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

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.

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

disallowedVersions: string[];

Type: string[]

explicitSchemaControl

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

explicitSchemaControl: boolean;

Type: boolean

idCompressorMode

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

idCompressorMode: IdCompressorMode;

Type: IdCompressorMode

opGroupingEnabled

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

opGroupingEnabled: boolean;

Type: boolean