LoadContainerRuntimeParams Interface

This object holds the parameters necessary for the loadContainerRuntime(params) function.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/container-runtime/legacy.

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

Signature

export interface LoadContainerRuntimeParams

Properties

Property	Alerts	Modifiers	Type	Description
containerScope	Beta	optional	FluidObject	runtime services provided with context
context	Beta		IContainerContext	Context of the container.
existing	Beta		boolean	Pass 'true' if loading from an existing snapshot.
minVersionForCollab	Deprecated, Beta	optional	OldestSupportedClientVersion	Oldest version of Fluid Framework client that must be able to open and process documents written by this container runtime.
oldestSupportedClient	Beta	optional	OldestSupportedClientVersion	Oldest version of Fluid Framework client that must be able to open and process documents written by this container runtime.
provideEntryPoint	Beta		(containerRuntime: IContainerRuntime) => Promise<FluidObject>	Promise that resolves to an object which will act as entryPoint for the Container.
registryEntries	Beta		NamedFluidDataStoreRegistryEntries	Mapping from data store types to their corresponding factories
requestHandler	Deprecated, Beta	optional	(request: IRequest, runtime: IContainerRuntime) => Promise<IResponse>	Request handler for the request() method of the container runtime. Only relevant for back-compat while we remove the request() method and move fully to entryPoint as the main pattern.
runtimeOptions	Beta	optional	IContainerRuntimeOptions	Additional options to be passed to the runtime.

Property Details

containerScope

runtime services provided with 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

containerScope?: FluidObject;

Type: FluidObject

context

Context of the container.

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

context: IContainerContext;

Type: IContainerContext

existing

Pass 'true' if loading from an existing snapshot.

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

existing: boolean;

Type: boolean

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;

Type: OldestSupportedClientVersion

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;

Type: OldestSupportedClientVersion

Remarks

Choosing an older version may limit the features and write formats the application can use to those supported by that version. The value must be valid SemVer.

The inputted version will be used to determine the default configuration for IContainerRuntimeOptionsInternal to ensure compatibility with the specified version.

Example

oldestSupportedClient: "2.0.0"

provideEntryPoint

Promise that resolves to an object which will act as entryPoint for the Container.

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: (containerRuntime: IContainerRuntime) => Promise<FluidObject>;

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

registryEntries

Mapping from data store types to their corresponding factories

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

requestHandler

Request handler for the request() method of the container runtime. Only relevant for back-compat while we remove the request() method and move fully to entryPoint as the main pattern.

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

requestHandler?: (request: IRequest, runtime: IContainerRuntime) => Promise<IResponse>;

Type: (request: IRequest, runtime: IContainerRuntime) => Promise<IResponse>

runtimeOptions

Additional options to be passed to the 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

runtimeOptions?: IContainerRuntimeOptions;

Type: IContainerRuntimeOptions

Remarks

Defaults to {}.