Skip to main content

@fluidframework/datastore-definitions Package

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

Interfaces​

InterfaceAlertsModifiersDescription
IChannelLegacyAn object which can be connected to a Fluid service via an IChannelServices instance.
IChannelAttributesLegacyRepresents the attributes of a channel/DDS.
IChannelFactoryLegacyDefinitions of a channel factory.
IChannelServicesLegacyStorage services to read the objects at a given path using the given delta connection.
IChannelStorageServiceLegacyStorage services to read the objects at a given path.
IDeltaConnectionLegacyInterface to represent a connection to a delta notification stream.
IDeltaHandlerLegacyHandler provided by shared data structure to process requests from the runtime.
IFluidDataStoreRuntimeLegacysealedRepresents the runtime for the data store. Contains helper functions/state of the data store.
IFluidDataStoreRuntimeAlphaLegacysealed
IFluidDataStoreRuntimeEventsLegacyEvents emitted by IFluidDataStoreRuntime.
Internal_InterfaceOfJsonableTypesWithLegacy

Types​

TypeAliasAlertsDescription
IDeltaManagerErasedLegacyManages the transmission of ops between the runtime and storage.
JsonableLegacyUsed to constrain a type T to types that are serializable as JSON. Produces a compile-time error if T contains non-Jsonable members.
JsonableTypeWithLegacyType constraint for types that are likely serializable as JSON or have a custom alternate type.
SerializableLegacyUsed to constrain a type 'T' to types that Fluid can intrinsically serialize. Produces a compile-time error if T contains non-serializable members.