@fluidframework/datastore-definitions Package

This package defines the interfaces required to implement and/or communicate with a data store.

Interfaces

Interface	Description
IChannel
IChannelAttributes	Represents the attributes of a channel/DDS.
IChannelFactory	Definitions of a channel factory. Factories follow a common model but enable custom behavior.
IChannelServices	Storage services to read the objects at a given path using the given delta connection.
IChannelStorageService	Storage services to read the objects at a given path.
IDeltaConnection	Interface to represent a connection to a delta notification stream.
IDeltaHandler	Handler provided by shared data structure to process requests from the runtime.
IFluidDataStoreRuntime	Represents the runtime for the data store. Contains helper functions/state of the data store.
IFluidDataStoreRuntimeEvents

Types

TypeAlias	Description
Jsonable	Used to constrain a type T to types that are serializable as JSON. Produces a compile-time error if T contains non-Jsonable members.
Serializable	Used to constrain a type 'T' to types that Fluid can intrinsically serialize. Produces a compile-time error if T contains non-serializable members.