BaseContainerRuntimeFactoryProps Interface

BaseContainerRuntimeFactory 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.

Input

This type is "input," meaning that code outside of the library defining it should not read from it. Future versions of this type may add optional members or make typing of members more general.

Signature

export interface BaseContainerRuntimeFactoryProps

Properties

Property	Alerts	Modifiers	Type	Description
dependencyContainer	Deprecated, Beta	optional	IFluidDependencySynthesizer
minVersionForCollab	Deprecated, Beta	optional	OldestSupportedClientVersion | undefined	Oldest version of Fluid Framework client that must be able to open and process documents written by this container runtime.
oldestSupportedClient	Beta	optional	OldestSupportedClientVersion | undefined	Oldest version of Fluid Framework client that must be able to open and process documents written by this container runtime.
provideEntryPoint	Beta		(runtime: IContainerRuntime) => Promise<FluidObject>	Function that will initialize the entryPoint of the ContainerRuntime instances created with this factory
registryEntries	Beta		NamedFluidDataStoreRegistryEntries	The data store registry for containers produced.
requestHandlers	Deprecated, Beta	optional	RuntimeRequestHandler[]	Request handlers for containers produced.
runtimeOptions	Beta	optional	IContainerRuntimeOptions	The runtime options passed to the ContainerRuntime when instantiating it

Property Details

dependencyContainer

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

Will be removed in a future release.

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

dependencyContainer?: IFluidDependencySynthesizer;

Type: IFluidDependencySynthesizer

minVersionForCollab

Oldest version of Fluid Framework client that must be able to open and process documents written by this container runtime.

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

2.116.0. To be removed in 3.10.0. Use oldestSupportedClient instead. See https://github.com/microsoft/FluidFramework/issues/27851 for context.

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

minVersionForCollab?: OldestSupportedClientVersion | undefined;

Type: OldestSupportedClientVersion | undefined

Remarks

See oldestSupportedClient for compatibility implications.

Specifying both oldestSupportedClient and minVersionForCollab is an error.

oldestSupportedClient

Oldest version of Fluid Framework client that must be able to open and process documents written by this container runtime.

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

oldestSupportedClient?: OldestSupportedClientVersion | undefined;

Type: OldestSupportedClientVersion | undefined

Remarks

Choosing an older version may limit the features and write formats the application can use to those supported by that version.

See oldestSupportedClient for more details on this property.

provideEntryPoint

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

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

provideEntryPoint: (runtime: IContainerRuntime) => Promise<FluidObject>;

Type: (runtime: IContainerRuntime) => Promise<FluidObject>

registryEntries

The data store registry for containers produced.

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

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 for existing users, but is not recommended for new users.

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

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

runtimeOptions?: IContainerRuntimeOptions;

Type: IContainerRuntimeOptions