LoadContainerRuntimeParams Interface
Packages > @fluidframework/container-runtime > LoadContainerRuntimeParams
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 | Alpha |
optional |
FluidObject | runtime services provided with context |
| context | Alpha |
IContainerContext | Context of the container. | |
| existing | Alpha |
boolean | Pass 'true' if loading from an existing snapshot. | |
| provideEntryPoint | Alpha |
(containerRuntime: IContainerRuntime) => Promise<FluidObject> | Promise that resolves to an object which will act as entryPoint for the Container. | |
| registryEntries | Alpha |
NamedFluidDataStoreRegistryEntries | Mapping from data store types to their corresponding factories | |
| requestHandler | Deprecated, Alpha |
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 | Alpha |
optional |
IContainerRuntimeOptions | Additional options to be passed to the runtime |
Property Details
containerScope
runtime services provided with context
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-runtime/alpha.
For more information about our API support guarantees, see here .
Signature
containerScope?: FluidObject;
Type: FluidObject
context
Context of the container.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-runtime/alpha.
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 as an alpha preview and may change without notice.
To use, import via @fluidframework/container-runtime/alpha.
For more information about our API support guarantees, see here .
Signature
existing: boolean;
Type: boolean
provideEntryPoint
Promise that resolves to an object which will act as entryPoint for the Container.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-runtime/alpha.
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 as an alpha preview and may change without notice.
To use, import via @fluidframework/container-runtime/alpha.
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 as an alpha preview and may change without notice.
To use, import via @fluidframework/container-runtime/alpha.
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 as an alpha preview and may change without notice.
To use, import via @fluidframework/container-runtime/alpha.
For more information about our API support guarantees, see here .
Signature
runtimeOptions?: IContainerRuntimeOptions;
Type: IContainerRuntimeOptions