Skip to main content

ChangeMetadata TypeAlias

Information about a commit that has been applied.

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 type ChangeMetadata = CommitMetadata & ({
readonly isLocal: true;
getChange(): JsonCompatibleReadOnly;
} | {
readonly isLocal: false;
readonly getChange?: undefined;
});