Version compatibility with Fluid Framework releases

Note

This preview version is provided without a service-level agreement, and it's not recommended for production workloads. Certain features might not be supported or might have constrained capabilities.

To connect your application to Azure Fluid Relay service, you'll use the @fluidframework/azure-client library. You'll also use the fluid-framework library to use the core data structures and provided by the Fluid Framework.

Since you are using Azure Fluid Relay, you should first install the latest available version of @fluidframework/azure-client and use that version to determine what version of the fluid-framework library to use. The library expresses a peer dependency on the version of the fluid-framework package on which it depends.

You can use the install-peerdeps tool to install both @fluidframework/azure-client and the compatible version of fluid-framework using the following command:

npx install-peerdeps @fluidframework/azure-client

Tip

During Public Preview, the versions of @fluidframework/azure-client and fluid-framework will match. That is, if the current release of @fluidframework/azure-client is 0.48, then it will be compatible with fluid-framework 0.48. The inverse is also true.

Compatibility table

npm package Minimum version API
@fluidframework/azure-client 0.48.4 API
fluid-framework 0.48.4 API
@fluidframework/azure-service-utils 0.48.4 API
@fluidframework/test-client-utils 0.48.4 API

Next steps