MinimumVersionForCollab TypeAlias

Oldest version of Fluid Framework client packages to support collaborating with.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/runtime-definitions/legacy.

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 MinimumVersionForCollab = `${1 | 2}.${bigint}.${bigint}` | `${1 | 2}.${bigint}.${bigint}-${string}`;

Remarks

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

When specifying a given MinimumVersionForCollab, any client with a version that is greater than or equal to the specified version will be considered compatible.

Must be at least @fluidframework/runtime-utils#lowestMinVersionForCollab and cannot exceed the current version.

@fluidframework/runtime-utils#validateMinimumVersionForCollab can be used to check these invariants at runtime. Since TypeScript cannot enforce them all for literals in code, it may be useful to use validateMinimumVersionForCollab values which may come from constants in the codebase typed as a MinimumVersionForCollab.