ContainerRuntimeFactoryWithDefaultDataStoreProps Interface

ContainerRuntimeFactoryWithDefaultDataStore construction properties.

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 interface ContainerRuntimeFactoryWithDefaultDataStoreProps

Properties

Property	Alerts	Modifiers	Type	Description
defaultFactory	Alpha		IFluidDataStoreFactory
dependencyContainer	Deprecated, Alpha	optional	IFluidDependencySynthesizer
provideEntryPoint	Alpha	optional	(runtime: IContainerRuntime) => Promise<FluidObject>	Function that will initialize the entryPoint of the IContainerRuntime 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 IContainerRuntime when instantiating it

Property Details

defaultFactory

This API is provided as an alpha preview and may change without notice.

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

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

Signature

defaultFactory: IFluidDataStoreFactory;

Type: IFluidDataStoreFactory

dependencyContainer

This API is deprecated and will be removed in a future release.

Will be removed in a future release.

This API is provided as an alpha preview and may change without notice.

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

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

Signature

dependencyContainer?: IFluidDependencySynthesizer;

Type: IFluidDependencySynthesizer

provideEntryPoint

Function that will initialize the entryPoint of the IContainerRuntime instances created with this factory

This API is provided as an alpha preview and may change without notice.

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

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.

This API is provided as an alpha preview and may change without notice.

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

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

Signature

registryEntries: NamedFluidDataStoreRegistryEntries;

Type: NamedFluidDataStoreRegistryEntries

requestHandlers

Request handlers for containers produced.

This API is deprecated and will be removed in a future release.

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

This API is provided as an alpha preview and may change without notice.

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

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

Signature

requestHandlers?: RuntimeRequestHandler[];

Type: RuntimeRequestHandler[]

runtimeOptions

The runtime options passed to the IContainerRuntime when instantiating it

This API is provided as an alpha preview and may change without notice.

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

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

Signature

runtimeOptions?: IContainerRuntimeOptions;

Type: IContainerRuntimeOptions