FluidClientVersion Enum
Versions of Fluid Framework client packages.
To use, import via @fluidframework/tree/alpha.
For more information about our API support guarantees, see here.
Signature
export declare enum FluidClientVersion
Remarks
Used to express compatibility requirements by indicating the oldest version with which compatibility must be maintained.
When no compatibility-impacting change is made in a given version, the value associated with its enum entry may point to the older version which it's fully compatible with. Note that this can change if a future version of the framework introduces an option to use something which is only supported at a particular version. In which case, the values of the enum may shift, but the semantics of keys in this enum will not change.
Do not depend on the value of this enums's entries: only depend on the keys (enum members) themselves.
Some release may also be omitted if there is currently no need to express that specific version. If the need arises, they might be added in the future.
Flags
| Flag | Alerts | Description |
|---|---|---|
| EnableUnstableFeatures | Alpha |
Enable unreleased and unfinished features. |
| v2_0 | Alpha |
Fluid Framework Client 2.0 and newer. |
EnableUnstableFeatures
Enable unreleased and unfinished features.
For more information about our API support guarantees, see here.
Signature
EnableUnstableFeatures
Remarks
Using this value can result in documents which can not be opened in future versions of the framework. It can also result in data corruption by enabling unfinished features which may not handle all cases correctly.
This can be used with specific APIs when the caller has knowledge of what specific features those APIs will be opted into with it. This is useful for testing features before they are released, but should not be used in production code.
v2_0
Fluid Framework Client 2.0 and newer.
For more information about our API support guarantees, see here.
Signature
v2_0 = 2