ContainerRuntimeFactoryWithDefaultDataStore Class

A ContainerRuntimeFactory that initializes Containers with a single default data store, which can be requested from the container with an empty URL.

This factory should be exposed as fluidExport off the entry point to your module.

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

To use, import via @fluidframework/aqueduct/legacy.

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

Signature

export declare class ContainerRuntimeFactoryWithDefaultDataStore extends BaseContainerRuntimeFactory

Extends: BaseContainerRuntimeFactory

Constructors

Constructor	Alerts	Description
(constructor)(props)	Beta	Constructs a new instance of the ContainerRuntimeFactoryWithDefaultDataStore class

Static Properties

Property	Alerts	Modifiers	Type	Description
defaultDataStoreId	Beta	readonly

Properties

Property	Alerts	Modifiers	Type	Description
defaultFactory	Beta	readonly	IFluidDataStoreFactory

Methods

Method	Alerts	Return Type	Description
containerInitializingFirstTime(runtime)	Beta	Promise<void>	Subclasses may override containerInitializingFirstTime to perform any setup steps at the time the container is created. This likely includes creating any initial data stores that are expected to be there at the outset.

Constructor Details

(constructor)

Constructs a new instance of the ContainerRuntimeFactoryWithDefaultDataStore class

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(props: ContainerRuntimeFactoryWithDefaultDataStoreProps);

Parameters

Parameter	Type	Description
props	ContainerRuntimeFactoryWithDefaultDataStoreProps

Property Details

defaultDataStoreId

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

static readonly defaultDataStoreId = "default";

defaultFactory

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

protected readonly defaultFactory: IFluidDataStoreFactory;

Type: IFluidDataStoreFactory

Method Details

containerInitializingFirstTime

Subclasses may override containerInitializingFirstTime to perform any setup steps at the time the container is created. This likely includes creating any initial data stores that are expected to be there at the outset.

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

protected containerInitializingFirstTime(runtime: IContainerRuntime): Promise<void>;

Parameters

Parameter	Type	Description
runtime	IContainerRuntime	The container runtime for the container being initialized

Returns

Return type: Promise<void>