Skip to main content

CommitMetadata Interface

Information about a commit that has been applied.

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 CommitMetadata

Properties

Property Modifiers Type Description
isLocal readonly boolean Indicates whether the commit is a local edit
kind readonly CommitKind A CommitKind enum value describing whether the commit represents an Edit, an Undo, or a Redo.

Property Details

isLocal

Indicates whether the commit is a local edit

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
readonly isLocal: boolean;

Type: boolean

kind

A CommitKind enum value describing whether the commit represents an Edit, an Undo, or a Redo.

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
readonly kind: CommitKind;

Type: CommitKind