IRuntimeFactory Interface

Packages > @fluidframework/container-definitions > IRuntimeFactory

Exported module definition

Provides the entry point for the ContainerContext to load the proper IRuntime to start up the running instance of the Container.

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

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

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

Signature

export interface IRuntimeFactory extends IProvideRuntimeFactory

Extends: IProvideRuntimeFactory

Methods

Method Alerts Return Type Description
instantiateRuntime(context, existing) Alpha Promise<IRuntime> Instantiates a new IRuntime for the given IContainerContext to proxy to This is the main entry point to the Container's business logic

Method Details

instantiateRuntime

Instantiates a new IRuntime for the given IContainerContext to proxy to This is the main entry point to the Container’s business logic

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

To use, import via @fluidframework/container-definitions/alpha.

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

Signature

instantiateRuntime(context: IContainerContext, existing: boolean): Promise<IRuntime>;

Parameters

Parameter Type Description
context IContainerContext container context to be supplied to the runtime
existing boolean whether to instantiate for the first time or from an existing context

Returns

Return type: Promise<IRuntime >