Interface CommitWithChanges

Representation of a Git commit, plus the changes that were performed in that particular commit.

interface CommitWithChanges {
    author: CommitIdentity;
    authorDateRelative: string;
    body?: string;
    fileChanges: GitFileChange[];
    parentSHAs?: string[];
    sha: string;
    summary: string;
}

Hierarchy (view full)

Properties

author authorDateRelative body? fileChanges parentSHAs? sha summary

Properties

Readonly author

author: CommitIdentity

Information about the author of this commit. It includes name, email and date.

Readonly authorDateRelative

authorDateRelative: string

The date when the commit was authored (ISO format).

Optional Readonly body

body?: string

The commit message without the first line and CR.

Readonly fileChanges

fileChanges: GitFileChange[]

The file changes in the commit.

Optional Readonly parentSHAs

parentSHAs?: string[]

The SHAs for the parents of the commit.

Readonly sha

sha: string

The commit SHA.

Readonly summary

summary: string

The first line of the commit message.

Settings

Member Visibility

Theme

On This Page

authorauthorDateRelativebodyfileChangesparentSHAsshasummary