API Overview

Definitions packages

List of definitions related packages
Package Name Description
@fluidframework/common-definitions Package
@fluidframework/container-definitions Package Warning emitted when requests to storage are being throttled
@fluidframework/core-interfaces Package JSON serialized form of an IFluidHandle
@fluidframework/driver-definitions Package
@fluidframework/protocol-base Package Basic implementation of a tree ITreeEntry
@fluidframework/protocol-definitions Package Represents a version of the snapshot of a data store

Distributed Data Structures packages

List of distributed-data-structures related packages
Package Name Description
@fluidframework/cell Package The SharedCell distributed data structure can be used to store a single serializable value.
@fluidframework/counter Package This package contains the SharedCounter distributed data structure.
@fluidframework/ink Package Base interface for stylus operations.
@fluidframework/map Package The map package provides interfaces and implementing classes for map-like distributed data structures.
@fluidframework/matrix Package
@fluidframework/ordered-collection Package

Interface for object that can be snapshoted

TODO: move this to be use in other place TODO: currently input and output is not symmetrical, can they become symmetrical?

@fluidframework/register-collection Package

Consensus Register Collection channel factory interface

Extends the base IChannelFactory to return a more definite type of IConsensusRegisterCollection Use for the …

@fluidframework/sequence Package
@fluid-experimental/task-manager Package

The TaskManager distributed data structure tracks queues of clients that want to exclusively run a task.

It is still experimental and under development. Please do try it …

Libraries packages

List of libraries related packages
Package Name Description
@fluid-experimental/fluid-framework Package Basic implementation of a tree ITreeEntry
@fluidframework/aqueduct Package The aqueduct package is a library for building Fluid objects and Fluid containers within the Fluid Framework. Its goal is to provide a thin base layer over the existing …