Skip to main content

OldestSupportedServiceClientVersion TypeAlias

Oldest Fluid Framework client version that must be able to open and process documents written by a service client.

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

To use, import via fluid-framework/alpha.

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

Input

This type is "input," meaning that code outside of the library defining it should not read from it. Future versions of this type may add optional members or make typing of members more general.

Signature

export type OldestSupportedServiceClientVersion = `2.${bigint}.0`;

Remarks

A string in SemVer format indicating a specific version of the Fluid Framework client package, or the special case of @fluidframework/runtime-utils#defaultMinVersionForCollab.

Service clients use this value to select write formats and features. Clients using this version or newer must be able to open and process documents written by the service client. Choosing an older version may limit the features and write formats the application can use to those supported by that version.

Cannot exceed the version of any Fluid Framework client package in use by the local client.