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.
Signature
export declare class ContainerRuntimeFactoryWithDefaultDataStore extends BaseContainerRuntimeFactory
Extends: BaseContainerRuntimeFactory
Constructors
| Constructor | Description |
|---|---|
| (constructor)(defaultFactory, registryEntries, dependencyContainer, requestHandlers, runtimeOptions) | Constructs a new instance of the ContainerRuntimeFactoryWithDefaultDataStore class |
Static Properties
| Property | Type | Description |
|---|---|---|
| defaultDataStoreId |
Properties
| Property | Type | Description |
|---|---|---|
| defaultFactory | IFluidDataStoreFactory |
Methods
| Method | Return Type | Description |
|---|---|---|
| containerInitializingFirstTime(runtime) | 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
Signature
constructor(defaultFactory: IFluidDataStoreFactory, registryEntries: NamedFluidDataStoreRegistryEntries, dependencyContainer?: IFluidDependencySynthesizer, requestHandlers?: RuntimeRequestHandler[], runtimeOptions?: IContainerRuntimeOptions);
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| defaultFactory | IFluidDataStoreFactory | ||
| registryEntries | NamedFluidDataStoreRegistryEntries | ||
| dependencyContainer | optional | IFluidDependencySynthesizer | |
| requestHandlers | optional | RuntimeRequestHandler[] | |
| runtimeOptions | optional | IContainerRuntimeOptions |
Property Details
defaultDataStoreId
Signature
static readonly defaultDataStoreId = "default";
defaultFactory
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.
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>