IContainerRuntimeOptions Interface

Packages > @fluidframework/container-runtime > IContainerRuntimeOptions

Options for container runtime.

Signature:

export interface IContainerRuntimeOptions 

Properties

List of properties of this interface
Property Type Description
addGlobalAgentSchedulerAndLeaderElection boolean Control whether the ContainerRuntime includes AgentScheduler in its registry, whether an instance is created at _scheduler, and whether it subscribes to leadership. This option will be removed in a future release, so it is recommended to opt-out in preparation for that change. If you still require AgentScheduler and/or leader election, you should explicitly include AgentSchedulerFactory in the container registry, explicitly instantiate an instance of it using createRootDataStore, and explicitly register for leadership election using TaskSubscription.
gcOptions IGCRuntimeOptions
summaryOptions ISummaryRuntimeOptions

Events

addGlobalAgentSchedulerAndLeaderElection

Control whether the ContainerRuntime includes AgentScheduler in its registry, whether an instance is created at _scheduler, and whether it subscribes to leadership. This option will be removed in a future release, so it is recommended to opt-out in preparation for that change. If you still require AgentScheduler and/or leader election, you should explicitly include AgentSchedulerFactory in the container registry, explicitly instantiate an instance of it using createRootDataStore, and explicitly register for leadership election using TaskSubscription.

Signature:

addGlobalAgentSchedulerAndLeaderElection?: boolean;

gcOptions

Signature:

gcOptions?: IGCRuntimeOptions;

summaryOptions

Signature:

summaryOptions?: ISummaryRuntimeOptions;