MinimumVersionForCollab TypeAlias
Oldest version of Fluid Framework client packages to support collaborating with.
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 MinimumVersionForCollab = `${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.
Collaboration with other clients is only supported when all Fluid Framework client packages used by the client have a version that is greater than or equal to the specified MinimumVersionForCollab.
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.
The higher the version specified, the more features and optimizations will be enabled.
@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 MinimumVersionForCollab.