IContainerRuntimeBaseExperimental Interface

Experimental extension of IContainerRuntimeBase to support staging mode.

This API is deprecated and will be removed in a future release.

These APIs are unstable, and can be changed at will. They should only be used with direct agreement with the Fluid Framework.

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.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

/** @sealed */
export interface IContainerRuntimeBaseExperimental extends IContainerRuntimeBase

Extends: IContainerRuntimeBase

Properties

Property	Alerts	Modifiers	Type	Description
inStagingMode	Beta	optional, readonly	boolean	Indicates whether the container is currently in staging mode.

Methods

Method	Alerts	Modifiers	Return Type	Description
enterStagingMode()	Beta	optional	StageControlsExperimental	Enters staging mode, allowing changes to be staged before being committed or discarded.

Property Details

inStagingMode

Indicates whether the container is currently in staging mode.

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 inStagingMode?: boolean;

Type: boolean

Method Details

enterStagingMode

Enters staging mode, allowing changes to be staged before being committed or discarded.

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

enterStagingMode?(): StageControlsExperimental;

Returns

Controls for committing or discarding staged changes.

Return type: StageControlsExperimental