RevertOptionsAlpha Interface
Options for RevertibleAlpha.revert.
To use, import via fluid-framework/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 RevertOptionsAlpha
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| customMetadata | Alpha | optional, readonly | JsonCompatibleReadOnlyObject | Arbitrary, application-defined metadata to attach to the commit that the revert produces. |
| dispose | Alpha | optional, readonly | boolean | If true (the default), 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. |
Property Details
customMetadata
Arbitrary, application-defined metadata to attach to the commit that the revert produces.
For more information about our API support guarantees, see here.
Signature
readonly customMetadata?: JsonCompatibleReadOnlyObject;
Type: JsonCompatibleReadOnlyObject
Remarks
See customMetadata for how this metadata is persisted and read back.
dispose
If true (the default), 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.
For more information about our API support guarantees, see here.
Signature
readonly dispose?: boolean;
Type: boolean