FlushMode
Packages > @fluidframework/runtime-definitions > FlushMode
Runtime flush mode handling
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/runtime-definitions/legacy.
For more information about our API support guarantees, see here .
Signature
export declare enum FlushMode
Flags
| Flag | Alerts | Description |
|---|---|---|
| Immediate | Deprecated, Alpha |
In Immediate flush mode the runtime will immediately send all operations to the driver layer. |
| TurnBased | Alpha |
When in TurnBased flush mode the runtime will buffer operations in the current turn and send them as a single batch at the end of the turn. The flush call on the runtime can be used to force send the current batch. |
Immediate
In Immediate flush mode the runtime will immediately send all operations to the driver layer.
This API is deprecated and will be removed in a future release.
This option will be removed in the next major version and should not be used. Use TurnBased instead, which is the default. See https://github.com/microsoft/FluidFramework/tree/main/packages/runtime/container-runtime/src/opLifecycle #how-batching-works
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/runtime-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
Immediate = 0
TurnBased
When in TurnBased flush mode the runtime will buffer operations in the current turn and send them as a single batch at the end of the turn. The flush call on the runtime can be used to force send the current batch.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/runtime-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
TurnBased = 1