IFluidDataStoreRegistry Interface

An association of identifiers to data store registry entries, where the entries can be used to create data stores.

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 IFluidDataStoreRegistry extends IProvideFluidDataStoreRegistry

Extends: IProvideFluidDataStoreRegistry

Methods

Method	Alerts	Modifiers	Return Type	Description
get(name)	Alpha		Promise<FluidDataStoreRegistryEntry | undefined>	Retrieves a data store registry entry by its identifier.
getSync(name)	Alpha	optional	FluidDataStoreRegistryEntry | undefined	Synchronously retrieves a data store registry entry by its identifier.

Method Details

get

Retrieves a data store registry entry by its identifier.

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(name: string): Promise<FluidDataStoreRegistryEntry | undefined>;

Remarks

The get function plays a crucial role in the lifecycle of a data store by providing access to the registry entry associated with a given identifier. This registry entry can then be used to create or load a data store.

Parameters

Parameter	Type	Description
name	string	The unique identifier of the data store registry entry to retrieve.

Returns

A promise that resolves to the data store registry entry, or the entry itself, or undefined if not found.

Return type: Promise<FluidDataStoreRegistryEntry | undefined>

getSync

Synchronously retrieves a data store registry entry by its identifier.

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

getSync?(name: string): FluidDataStoreRegistryEntry | undefined;

Remarks

The get function plays a crucial role in the lifecycle of a data store by providing access to the registry entry associated with a given identifier. This registry entry can then be used to create or load a data store.

Parameters

Parameter	Type	Description
name	string	The unique identifier of the data store registry entry to retrieve.

Returns

The data store registry entry, or the entry itself, or undefined if not found.

Return type: FluidDataStoreRegistryEntry | undefined