DOCSEARCHbyAlgolia
Submit Docs

Fluid Framework

repository·main·Indexed 26 days ago

https://github.com/microsoft/fluidframework

A library for building distributed, real-time collaborative web applications using JavaScript or TypeScript. The framework includes packages for consuming collaborative data via Azure Fluid Relay (@fluidframework/azure-client), backend API utilities (@fluidframework/azure-service-utils), and a local service for development and testing (@fluidframework/azure-local-service). It also provides build and release tools via the @fluid-tools/build-cli (flub) and @fluid-tools/build-infrastructure.

Tokens
216.7K
Snippets
446
Records
1.3K
Agent score
88%

What's inside Fluid Framework

  1. Overview of Chunked Forest implementation

    main

    Chunked Forest is an implementation of Forest that uses chunks—contiguous parts of the tree stored together in specific data formats. It is designed for a small memory footprint and fast loading of chunked node data.

    Key characteristics include:

    • Copy-on-write chunks: Optimized to be mutated in place when a chunk has only a single user (detected via reference counting).
    • Efficient cloning: Allows for efficient cloning of forests without significant performance overhead in non-cloning scenarios.
    • Multiple chunk formats: Uses different formats to optimize for various use cases.

  3. Overview of SharedTree

    main
    SharedTree is a distributed data structure provided by the Fluid Framework designed for collaborative environments. It allows multiple clients to work on a shared tree structure simultaneously. Detailed design specifications, including its data model, schema options, and undo capabilities, are documented in the technical design files within the repository.

  9. Overview of @fluidframework/server-services-shared

    main

    The @fluidframework/server-services-shared package provides shared service implementations used by Fluid server packages. It implements service interfaces that are common to both Routerlicious and Tinylicious. Key components include DocumentStorage and HttpServer implementations.

    Important Constraint: These implementations are designed exclusively for server-side environments and are not compatible with browserification (e.g., they cannot be bundled for use in a web browser).

  10. Overview of Nexus

    main

    Nexus is a component responsible for verifying and maintaining WebSocket sessions with clients. It performs two primary roles:

    1. Provides an orderer for writer clients.
    2. Maintains a list of read-only clients connected to the session.

    Clients should connect to Nexus after retrieving discovery results from Alfred. The deltaStreamUrl provided in the Alfred discovery result points directly to the Nexus endpoint.

  11. Overview of @fluid-tools/markdown-magic

    main

    The @fluid-tools/markdown-magic library provides tools for generating and embedding content within Markdown documentation.

    Warning: This package is intended for internal use within the microsoft/FluidFramework repository. It is not intended for public use, and there are no stability guarantees regarding its APIs.

  12. Overview of Fluid Framework Devtools

    main
    The Fluid Framework Devtools is a suite of libraries and tools designed to provide developer tooling experiences for Fluid applications. It includes low-level APIs, high-level consumer APIs, a visual React-based interface, and a Chromium-based browser extension. The architecture relies on message-passing via the Window object to communicate between runtime libraries and consuming views.