Skip to main content
Version: v1

@fluidframework/datastore-definitions Package

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

Interfaces

InterfaceDescription
IChannel
IChannelAttributesRepresents the attributes of a channel/DDS.
IChannelFactoryDefinitions of a channel factory. Factories follow a common model but enable custom behavior.
IChannelServicesStorage services to read the objects at a given path using the given delta connection.
IChannelStorageServiceStorage services to read the objects at a given path.
IDeltaConnectionInterface to represent a connection to a delta notification stream.
IDeltaHandlerHandler provided by shared data structure to process requests from the runtime.
IFluidDataStoreRuntimeRepresents the runtime for the data store. Contains helper functions/state of the data store.
IFluidDataStoreRuntimeEvents

Types

TypeAliasDescription
JsonableUsed to constrain a type T to types that are serializable as JSON. Produces a compile-time error if T contains non-Jsonable members.
SerializableUsed to constrain a type 'T' to types that Fluid can intrinsically serialize. Produces a compile-time error if T contains non-serializable members.