Skip to main content

@fluidframework/datastore-definitions Package

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

Interfaces

Interface Alerts Modifiers Description
IChannel Legacy
IChannelAttributes Legacy Represents the attributes of a channel/DDS.
IChannelFactory Legacy Definitions of a channel factory.
IChannelServices Legacy Storage services to read the objects at a given path using the given delta connection.
IChannelStorageService Legacy Storage services to read the objects at a given path.
IDeltaConnection Legacy Interface to represent a connection to a delta notification stream.
IDeltaHandler Legacy Handler provided by shared data structure to process requests from the runtime.
IFluidDataStoreRuntime Legacy sealed Represents the runtime for the data store. Contains helper functions/state of the data store.
IFluidDataStoreRuntimeEvents Legacy Events emitted by IFluidDataStoreRuntime.
Internal_InterfaceOfJsonableTypesWith Legacy

Types

TypeAlias Alerts Description
IDeltaManagerErased Legacy Manages the transmission of ops between the runtime and storage.
Jsonable Legacy Used to constrain a type T to types that are serializable as JSON. Produces a compile-time error if T contains non-Jsonable members.
JsonableTypeWith Legacy Type constraint for types that are likely serializable as JSON or have a custom alternate type.
Serializable Legacy Used to constrain a type 'T' to types that Fluid can intrinsically serialize. Produces a compile-time error if T contains non-serializable members.