FluidDataStoreRuntime Class

Base data store class

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

export declare class FluidDataStoreRuntime extends TypedEventEmitter<IFluidDataStoreRuntimeEvents> implements IFluidDataStoreChannel, IFluidDataStoreRuntime, IFluidHandleContext

Extends: TypedEventEmitter<IFluidDataStoreRuntimeEvents>

Implements: IFluidDataStoreChannel, IFluidDataStoreRuntime, IFluidHandleContext

Constructors

Constructor	Alerts	Description
(constructor)(dataStoreContext, sharedObjectRegistry, existing, provideEntryPoint)	Alpha	Create an instance of a DataStore runtime.

Properties

Property	Alerts	Modifiers	Type	Description
absolutePath	Alpha	readonly	string
attachState	Alpha	readonly	AttachState
channelsRoutingContext	Alpha	readonly	this
clientDetails	Alpha	readonly	IClientDetails
clientId	Alpha	readonly	string | undefined
connected	Alpha	readonly	boolean
deltaManager	Alpha	readonly	IDeltaManagerErased
deltaManagerInternal	Alpha	readonly	IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>
disposed	Alpha	readonly	boolean
entryPoint	Alpha	readonly	IFluidHandleInternal<FluidObject>	Exposes a handle to the root object / entryPoint of the data store. Use this as the primary way of interacting with it.
id	Alpha	readonly	string
idCompressor	Alpha	readonly	IIdCompressor | undefined
IFluidHandleContext	Alpha	readonly	this
ILayerCompatDetails	Alpha	optional, readonly	unknown	The compatibility details of the DataStore layer that is exposed to the Runtime layer for validating Runtime-DataStore compatibility.
isAttached	Alpha	readonly	boolean
isReadOnly	Alpha	readonly	() => boolean	Get the current readonly state.
logger	Alpha	readonly	ITelemetryLoggerExt
objectsRoutingContext	Alpha	readonly	this
options	Alpha	readonly	Record<string | number, any>
rootRoutingContext	Alpha	readonly	this
routeContext	Alpha	readonly	IFluidHandleContext
visibilityState	Alpha		VisibilityState

Constructor Details

(constructor)

Create an instance of a DataStore runtime.

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

constructor(dataStoreContext: IFluidDataStoreContext, sharedObjectRegistry: ISharedObjectRegistry, existing: boolean, provideEntryPoint: (runtime: IFluidDataStoreRuntime) => Promise<FluidObject>);

Parameters

Parameter	Type	Description
dataStoreContext	IFluidDataStoreContext	Context object for the runtime.
sharedObjectRegistry	ISharedObjectRegistry	The registry of shared objects that this data store will be able to instantiate.
existing	boolean	Pass 'true' if loading this datastore from an existing file; pass 'false' otherwise.
provideEntryPoint	(runtime: IFluidDataStoreRuntime) => Promise<FluidObject>	Function to initialize the entryPoint object for the data store runtime. The handle to this data store runtime will point to the object returned by this function. If this function is not provided, the handle will be left undefined. This is here so we can start making handles a first-class citizen and the primary way of interacting with some Fluid objects, and should be used if possible.

Property Details

absolutePath

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

get absolutePath(): string;

Type: string

attachState

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

get attachState(): AttachState;

Type: AttachState

channelsRoutingContext

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

get channelsRoutingContext(): this;

Type: this

clientDetails

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

get clientDetails(): IClientDetails;

Type: IClientDetails

clientId

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

get clientId(): string | undefined;

Type: string | undefined

connected

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

get connected(): boolean;

Type: boolean

deltaManager

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

get deltaManager(): IDeltaManagerErased;

Type: IDeltaManagerErased

deltaManagerInternal

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

readonly deltaManagerInternal: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;

Type: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>

disposed

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

get disposed(): boolean;

Type: boolean

entryPoint

Exposes a handle to the root object / entryPoint of the data store. Use this as the primary way of interacting with it.

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

readonly entryPoint: IFluidHandleInternal<FluidObject>;

Type: IFluidHandleInternal<FluidObject>

id

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

readonly id: string;

Type: string

idCompressor

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

get idCompressor(): IIdCompressor | undefined;

Type: IIdCompressor | undefined

IFluidHandleContext

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

get IFluidHandleContext(): this;

Type: this

ILayerCompatDetails

The compatibility details of the DataStore layer that is exposed to the Runtime layer for validating Runtime-DataStore compatibility.

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

readonly ILayerCompatDetails?: unknown;

Type: unknown

Remarks

This is for internal use only. The type of this should be ILayerCompatDetails. However, ILayerCompatDetails is internal and this class is currently marked as legacy alpha. So, using unknown here.

isAttached

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

get isAttached(): boolean;

Type: boolean

isReadOnly

Get the current readonly state.

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

readonly isReadOnly: () => boolean;

Type: () => boolean

logger

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

get logger(): ITelemetryLoggerExt;

Type: ITelemetryLoggerExt

objectsRoutingContext

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

get objectsRoutingContext(): this;

Type: this

options

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

readonly options: Record<string | number, any>;

Type: Record<string | number, any>

rootRoutingContext

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

get rootRoutingContext(): this;

Type: this

routeContext

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

get routeContext(): IFluidHandleContext;

Type: IFluidHandleContext

visibilityState

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

visibilityState: VisibilityState;

Type: VisibilityState