Skip to main content

IFluidDataStoreContextDetached Interface

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.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

/** @sealed */
export interface IFluidDataStoreContextDetached extends IFluidDataStoreContext

Extends: IFluidDataStoreContext

Methods

MethodAlertsReturn TypeDescription
attachRuntime(factory, dataStoreRuntime)BetaPromise<IDataStore>Binds a runtime to the context.

Method Details

attachRuntime

Binds a runtime to the context.

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

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

Signature

attachRuntime(factory: IProvideFluidDataStoreFactory, dataStoreRuntime: IFluidDataStoreChannel): Promise<IDataStore>;

Parameters

ParameterTypeDescription
factoryIProvideFluidDataStoreFactory
dataStoreRuntimeIFluidDataStoreChannel

Returns

Return type: Promise<IDataStore>