IMockContainerRuntimeOptions Interface

Options for the container runtime mock.

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

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

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

Signature

export interface IMockContainerRuntimeOptions

Properties

Property	Alerts	Modifiers	Type	Description
enableGroupedBatching	Alpha	optional, readonly	boolean	If configured, it will simulate group batching by forcing all ops within a batch to have the same sequence number. By default, the value is false
flushMode	Alpha	optional, readonly	FlushMode	Configures the flush mode for the runtime. In Immediate flush mode the runtime will immediately send all operations to the driver layer, while in TurnBased the operations will be buffered and then sent them as a single batch when flush() is called on the runtime. By default, flush mode is Immediate.

Property Details

enableGroupedBatching

If configured, it will simulate group batching by forcing all ops within a batch to have the same sequence number.

By default, the value is false

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

readonly enableGroupedBatching?: boolean;

Type: boolean

flushMode

Configures the flush mode for the runtime. In Immediate flush mode the runtime will immediately send all operations to the driver layer, while in TurnBased the operations will be buffered and then sent them as a single batch when flush() is called on the runtime.

By default, flush mode is Immediate.

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

readonly flushMode?: FlushMode;

Type: FlushMode