Skip to main content

IFluidDataStoreFactory Interface

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.

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

To use, import via @fluidframework/runtime-definitions/legacy.

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

Signature​

export interface IFluidDataStoreFactory extends IProvideFluidDataStoreFactory

Extends: IProvideFluidDataStoreFactory

Properties​

Property Alerts Type Description
type Alpha string String that uniquely identifies the type of data store created by this factory.

Methods​

Method Alerts Return Type Description
instantiateDataStore(context, existing) Alpha Promise<IFluidDataStoreChannel> Generates runtime for the data store from the data store context. Once created should be bound to the context.

Property Details​

type​

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

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/runtime-definitions/alpha.

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

Signature​

type: string;

Type: string

Method Details​

instantiateDataStore​

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

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/runtime-definitions/alpha.

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

Signature​

instantiateDataStore(context: IFluidDataStoreContext, existing: boolean): Promise<IFluidDataStoreChannel>;

Parameters​

Parameter Type Description
context IFluidDataStoreContext Context for the data store.
existing boolean If instantiating from an existing file.

Returns​

Return type: Promise<IFluidDataStoreChannel>