OldestSupportedClientVersion TypeAlias
Oldest Fluid Framework client version that must be able to open and process documents written by newer clients.
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 OldestSupportedClientVersion = `${1 | 2}.${bigint}.${bigint}` | `${1 | 2}.${bigint}.${bigint}-${string}`;
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.
The framework uses this value to select write formats and features. Clients using this version or newer must be able to open and process documents written by newer clients. Choosing an older version may limit the features and write formats the application can use to those supported by that version. Clients using older versions may still be able to access a document if no incompatible data has been written.
Collaboration with other clients is supported when all Fluid Framework client packages used by the client have a version that is greater than or equal to the specified OldestSupportedClientVersion.
Must be at least @fluidframework/runtime-utils#lowestMinVersionForCollab and cannot exceed the version of any Fluid Framework client package in use by the local client.
@fluidframework/runtime-utils#validateMinimumVersionForCollab can be used to check these invariants at runtime. Since TypeScript cannot enforce all of them for literals in code, it is useful for checking values sourced from constants typed as OldestSupportedClientVersion.