@fluidframework/datastore Package

Packages > @fluidframework/datastore

Classes

List of classes contained in this package or namespace
Class Description
FluidDataStoreRuntime Base data store class
FluidObjectHandle

Enumerations

List of enums contained in this package or namespace
Enumeration Description
DataStoreMessageType

Functions

List of functions contained in this package or namespace
Function Description
requestFluidDataStoreMixin(Base, requestHandler) Mixin class that adds request handler to FluidDataStoreRuntime
summaryWaitFluidDataStoreMixin(Base, init) Mixin class that adds await for DataObject to finish initialization before we proceed to summary.

Interfaces

List of interfaces contained in this package or namespace
Interface Description
ISharedObjectRegistry

Enumerations

DataStoreMessageType enum

Signature:

export declare enum DataStoreMessageType 

Enumeration Members

List of members in use in this enum
Member Value Description
Attach "attach"
ChannelOp "op"

Functions

requestFluidDataStoreMixin

Mixin class that adds request handler to FluidDataStoreRuntime

Signature:

export declare function requestFluidDataStoreMixin(Base: typeof FluidDataStoreRuntime, requestHandler: (request: IRequest, runtime: FluidDataStoreRuntime) => Promise<IResponse>): typeof FluidDataStoreRuntime;

Parameters

List of parameters
Parameter Type Description
Base typeof FluidDataStoreRuntime base class, inherits from FluidDataStoreRuntime
requestHandler (request: IRequest, runtime: FluidDataStoreRuntime) => Promise<IResponse> request handler to mix in

Returns:

typeof FluidDataStoreRuntime

summaryWaitFluidDataStoreMixin

Mixin class that adds await for DataObject to finish initialization before we proceed to summary.

Signature:

export declare function summaryWaitFluidDataStoreMixin(Base: typeof FluidDataStoreRuntime, init: () => Promise<void>): typeof FluidDataStoreRuntime;

Parameters

List of parameters
Parameter Type Description
Base typeof FluidDataStoreRuntime base class, inherits from FluidDataStoreRuntime
init () => Promise async callback to wait before proceeding with summary

Returns:

typeof FluidDataStoreRuntime