Skip to main content

IDataStore Interface

Exposes some functionality/features of a data store: - Handle to the data store's entryPoint - Fluid router for the data store - Can be assigned an alias

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 IDataStore

Properties​

Property Alerts Modifiers Type Description
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.

Methods​

Method Alerts Return Type Description
trySetAlias(alias) Alpha Promise<AliasResult> Attempt to assign an alias to the datastore. If the operation succeeds, the datastore can be referenced by the supplied alias and will not be garbage collected.

Property Details​

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 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​

readonly entryPoint: IFluidHandleInternal<FluidObject>;

Type: IFluidHandleInternal<FluidObject>

Method Details​

trySetAlias​

Attempt to assign an alias to the datastore. If the operation succeeds, the datastore can be referenced by the supplied alias and will not be garbage collected.

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​

trySetAlias(alias: string): Promise<AliasResult>;

Parameters​

Parameter Type Description
alias string Given alias for this datastore.

Returns​

A promise with the AliasResult

Return type: Promise<AliasResult>