IFluidDataStoreFactory Interface

Packages > @fluidframework/runtime-definitions > IFluidDataStoreFactory

IFluidDataStoreFactory create data stores. It is associated with an identifier (its type member) and usually provided to consumers using this mapping through a data store registry.

Signature:

export interface IFluidDataStoreFactory extends IProvideFluidDataStoreFactory

Extends: IProvideFluidDataStoreFactory

Properties

List of properties of this interface
Property Type Description
type string String that uniquely identifies the type of data store created by this factory.

Methods

List of methods of this class
Method Description
instantiateDataStore(context) Generates runtime for the data store from the data store context. Once created should be bound to the context.

Events

type

String that uniquely identifies the type of data store created by this factory.

Signature:

type: string;

Methods

instantiateDataStore

Generates runtime for the data store from the data store context. Once created should be bound to the context.

Signature:

instantiateDataStore(context: IFluidDataStoreContext): Promise<IFluidDataStoreChannel>;

Parameters

List of parameters
Parameter Type Description
context IFluidDataStoreContext Context for the data store.

Returns:

Promise<IFluidDataStoreChannel>