@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
mixinRequestHandler(requestHandler, Base) 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, Base) 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

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:

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

Parameters

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

Returns:

typeof FluidDataStoreRuntime

mixinSummaryHandler

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

Signature:

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

Parameters

List of parameters
Parameter Type Description
handler (runtime: FluidDataStoreRuntime) => Promise<{ path: string[]; content: string; }>
Base typeof FluidDataStoreRuntime base class, inherits from FluidDataStoreRuntime

Returns:

typeof FluidDataStoreRuntime