Skip to main content

RevertToOptionsAlpha Interface

Options for revertTo(revision, options).

This API is provided as an alpha preview and may change without notice.

To use, import via fluid-framework/alpha.

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 RevertToOptionsAlpha

Properties

PropertyAlertsModifiersTypeDescription
customMetadataAlphaoptional, readonlyJsonCompatibleReadOnlyObjectArbitrary, application-defined metadata to attach to the commit that the revert produces.

Property Details

customMetadata

Arbitrary, application-defined metadata to attach to the commit that the revert produces.

This API is provided as an alpha preview and may change without notice.

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.