Skip to main content
Version: v1

@fluidframework/datastore Package

Interfaces​

Interface Description
ISharedObjectRegistry

Classes​

Class Description
FluidDataStoreRuntime Base data store class
FluidObjectHandle

Enumerations​

Enum Description
DataStoreMessageType

Variables​

Variable Type Description
mixinRequestHandler (requestHandler: (request: IRequest, runtime: FluidDataStoreRuntime) => Promise<IResponse>, Base?: typeof FluidDataStoreRuntime) => typeof FluidDataStoreRuntime Mixin class that adds request handler to FluidDataStoreRuntime Request handler is only called when data store can't resolve request, i.e. for custom requests.
mixinSummaryHandler (handler: (runtime: FluidDataStoreRuntime) => Promise<{ path: string[]; content: string; } | undefined>, Base?: typeof FluidDataStoreRuntime) => typeof FluidDataStoreRuntime Mixin class that adds await for DataObject to finish initialization before we proceed to summary.

Variable Details​

mixinRequestHandler​

Mixin class that adds request handler to FluidDataStoreRuntime Request handler is only called when data store can't resolve request, i.e. for custom requests.

Signature​

mixinRequestHandler: (requestHandler: (request: IRequest, runtime: FluidDataStoreRuntime) => Promise<IResponse>, Base?: typeof FluidDataStoreRuntime) => typeof FluidDataStoreRuntime

Type: (requestHandler: (request: IRequest, runtime: FluidDataStoreRuntime) => Promise<IResponse>, Base?: typeof FluidDataStoreRuntime) => typeof FluidDataStoreRuntime

mixinSummaryHandler​

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

Signature​

mixinSummaryHandler: (handler: (runtime: FluidDataStoreRuntime) => Promise<{
    path: string[];
    content: string;
} | undefined>, Base?: typeof FluidDataStoreRuntime) => typeof FluidDataStoreRuntime

Type: (handler: (runtime: FluidDataStoreRuntime) => Promise<{ path: string[]; content: string; } | undefined>, Base?: typeof FluidDataStoreRuntime) => typeof FluidDataStoreRuntime