ContainerRuntimeFactoryWithDefaultDataStore Class

Packages > @fluidframework/aqueduct > ContainerRuntimeFactoryWithDefaultDataStore

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.

Signature:

export declare class ContainerRuntimeFactoryWithDefaultDataStore extends BaseContainerRuntimeFactory

Extends: BaseContainerRuntimeFactory

Constructors

List of constructors for this class
Constructor	Modifiers	Description
(constructor)(defaultDataStoreName, registryEntries, providerEntries, requestHandlers)		Constructs a new instance of the `ContainerRuntimeFactoryWithDefaultDataStore` class

Properties

List of properties for this class
Property	Modifiers	Type	Description
defaultDataStoreId	`static`	(not declared)

Methods

List of methods on this class
Method	Modifiers	Description
containerInitializingFirstTime(runtime)		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.

Constructors

ContainerRuntimeFactoryWithDefaultDataStore.(constructor)

Constructs a new instance of the ContainerRuntimeFactoryWithDefaultDataStore class

Signature:

constructor(defaultDataStoreName: string, registryEntries: NamedFluidDataStoreRegistryEntries, providerEntries?: DependencyContainerRegistry, requestHandlers?: RuntimeRequestHandler[]);

Parameters

List of parameters
Parameter	Type	Description
defaultDataStoreName	string
registryEntries	NamedFluidDataStoreRegistryEntries
providerEntries	DependencyContainerRegistry
requestHandlers	RuntimeRequestHandler[]

Properties

defaultDataStoreId

Signature:

static readonly defaultDataStoreId = "default";

Methods

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.

Signature:

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

Parameters

List of parameters
Parameter	Type	Description
runtime	IContainerRuntime	The container runtime for the container being initialized

Returns:

Promise<void>