RevertibleAlpha Interface
A Revertible with features that are not yet stable.
To use, import via @fluidframework/tree/alpha.
For more information about our API support guarantees, see here.
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 RevertibleAlpha extends Revertible
Extends: Revertible
Properties
| Property | Alerts | Type | Description |
|---|---|---|---|
| clone | Alpha | (view: UntypedTreeView) => RevertibleAlpha | Clones the Revertible to a target view. |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| revert() | Alpha | void | Reverts the associated change and disposes it. |
| revert(dispose) | Alpha | void | Reverts the associated change and optionally disposes it. |
| revert(options) | Alpha | void | Reverts the associated change according to the given options. |
Property Details
clone
Clones the Revertible to a target view.
For more information about our API support guarantees, see here.
Signature
clone: (view: UntypedTreeView) => RevertibleAlpha;
Type: (view: UntypedTreeView) => RevertibleAlpha
Method Details
revert
Reverts the associated change and disposes it.
For more information about our API support guarantees, see here.
Signature
revert(): void;
Remarks
Concurrent changes that are sequenced before the revert will not be overwritten by the revert if they affect different parts of the document.
revert
Reverts the associated change and optionally disposes it.
For more information about our API support guarantees, see here.
Signature
revert(dispose: boolean): void;
Remarks
Concurrent changes that are sequenced before the revert will not be overwritten by the revert if they affect different parts of the document.
Parameters
| Parameter | Type | Description |
|---|---|---|
| dispose | boolean | If true, the revertible will be disposed after being reverted. If false, the revertible will remain valid. This can be useful for scenarios where the revert may be dropped due to merge conflicts, and one wants to attempt reverting again. |
revert
Reverts the associated change according to the given options.
For more information about our API support guarantees, see here.
Signature
revert(options: RevertOptionsAlpha): void;
Remarks
Concurrent changes that are sequenced before the revert will not be overwritten by the revert if they affect different parts of the document.
Parameters
| Parameter | Type | Description |
|---|---|---|
| options | RevertOptionsAlpha |