@fluidframework/datastore Package

Interfaces

Interface	Alerts	Description
ISharedObjectRegistry	Legacy, Alpha

Classes

Class	Alerts	Description
FluidDataStoreRuntime	Legacy, Alpha	Base data store class
FluidObjectHandle	Legacy, Alpha	Handle for a shared FluidObject.

Enumerations

Enum	Alerts	Description
DataStoreMessageType	Legacy, Alpha

Functions

Function	Alerts	Return Type	Description
mixinRequestHandler(requestHandler, Base)	Legacy, Alpha	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, Base)	Legacy, Alpha	typeof FluidDataStoreRuntime	Mixin class that adds await for DataObject to finish initialization before we proceed to summary.

Function 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.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/datastore/legacy.

For more information about our API support guarantees, see here.

Signature

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

Parameters

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

Returns

Return type: typeof FluidDataStoreRuntime

mixinSummaryHandler

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

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/datastore/legacy.

For more information about our API support guarantees, see here.

Signature

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

Parameters

Parameter	Modifiers	Type	Description
handler		(runtime: FluidDataStoreRuntime) => Promise<{ path: string[]; content: string; } | undefined>	handler that returns info about blob to be added to summary. Or undefined not to add anything to summary.
Base	optional	typeof FluidDataStoreRuntime	base class, inherits from FluidDataStoreRuntime

Returns

Return type: typeof FluidDataStoreRuntime