Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate IContainerRuntimeOptions.flushMode #23288

Merged
merged 5 commits into from
Dec 11, 2024
Merged

Deprecate IContainerRuntimeOptions.flushMode #23288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9bb3e14
deprecate IContainerRuntimeOptions.flushMode
markfields Dec 10, 2024
bfc911a
changeset
markfields Dec 10, 2024
24035ac
editorial
markfields Dec 10, 2024
0cbf038
docs review feedback
markfields Dec 11, 2024
df7e856
Merge branch 'main' into deprecate-flushmode
markfields Dec 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .changeset/fancy-insects-sing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
"@fluidframework/container-runtime": minor
---
---
"section": deprecation
---

IContainerRuntimeOptions.flushMode is now deprecated

The `IContainerRuntimeOptions.flushMode` property is deprecated and will be removed in version 2.20.0.

Only the default value `FlushMode.TurnBased` is supported when calling `ContainerRuntime.loadRuntime` directly, so there's no need for consumers to pass this option in.
1 change: 1 addition & 0 deletions ...ages/runtime/container-runtime/api-report/container-runtime.legacy.alpha.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,7 @@ export interface IContainerRuntimeOptions {
readonly enableGroupedBatching?: boolean;
readonly enableRuntimeIdCompressor?: IdCompressorMode;
readonly explicitSchemaControl?: boolean;
// @deprecated
markfields marked this conversation as resolved.
Show resolved Hide resolved
readonly flushMode?: FlushMode;
// (undocumented)
readonly gcOptions?: IGCRuntimeOptions;
Expand Down
2 changes: 2 additions & 0 deletions packages/runtime/container-runtime/src/containerRuntime.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -474,6 +474,8 @@ export interface IContainerRuntimeOptions {
* send all operations to the driver layer, while in TurnBased the operations will be buffered
* and then sent them as a single batch at the end of the turn.
* By default, flush mode is TurnBased.
*
* @deprecated Only the default value TurnBased is supported. This option will be removed in the future.
*/
readonly flushMode?: FlushMode;
/**
Expand Down
Loading