BaseContainerRuntimeFactoryProps Interface
BaseContainerRuntimeFactory construction properties.
To use, import via @fluidframework/aqueduct/legacy
.
For more information about our API support guarantees, see here.
Signature
export interface BaseContainerRuntimeFactoryProps
Properties
Property | Alerts | Modifiers | Type | Description |
---|---|---|---|---|
dependencyContainer | Deprecated , Alpha |
optional |
IFluidDependencySynthesizer | |
minVersionForCollab | Alpha |
optional |
MinimumVersionForCollab | undefined | The minVersionForCollab passed to the ContainerRuntime when instantiating it. See LoadContainerRuntimeParams for more details on this property. |
provideEntryPoint | Alpha |
(runtime: IContainerRuntime) => Promise<FluidObject> | Function that will initialize the entryPoint of the ContainerRuntime instances created with this factory | |
registryEntries | Alpha |
NamedFluidDataStoreRegistryEntries | The data store registry for containers produced. | |
requestHandlers | Deprecated , Alpha |
optional |
RuntimeRequestHandler[] | Request handlers for containers produced. |
runtimeOptions | Alpha |
optional |
IContainerRuntimeOptions | The runtime options passed to the ContainerRuntime when instantiating it |
Property Details
dependencyContainer
Will be removed in a future release.
For more information about our API support guarantees, see here.
Signature
dependencyContainer?: IFluidDependencySynthesizer;
Type: IFluidDependencySynthesizer
minVersionForCollab
The minVersionForCollab passed to the ContainerRuntime when instantiating it. See LoadContainerRuntimeParams for more details on this property.
For more information about our API support guarantees, see here.
Signature
minVersionForCollab?: MinimumVersionForCollab | undefined;
Type: MinimumVersionForCollab | undefined
provideEntryPoint
Function that will initialize the entryPoint of the ContainerRuntime instances created with this factory
For more information about our API support guarantees, see here.
Signature
provideEntryPoint: (runtime: IContainerRuntime) => Promise<FluidObject>;
Type: (runtime: IContainerRuntime) => Promise<FluidObject>
registryEntries
The data store registry for containers produced.
For more information about our API support guarantees, see here.
Signature
registryEntries: NamedFluidDataStoreRegistryEntries;
Type: NamedFluidDataStoreRegistryEntries
requestHandlers
Request handlers for containers produced.
Will be removed once Loader LTS version is "2.0.0-internal.7.0.0". Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
For more information about our API support guarantees, see here.
Signature
requestHandlers?: RuntimeRequestHandler[];
Type: RuntimeRequestHandler[]
runtimeOptions
The runtime options passed to the ContainerRuntime when instantiating it
For more information about our API support guarantees, see here.
Signature
runtimeOptions?: IContainerRuntimeOptions;
Type: IContainerRuntimeOptions